!474 add argument type for mindinsight commands description

Merge pull request !474 from liangyongxiong/master

tutorials/source_en/advanced_use/mindinsight_commands.md

@@ -25,15 +25,15 @@
 
     Optional parameters as follows:
 
-    |Name|Argument|Description|Default|Scope|Specifications|
-    |---|---|---|---|---|---|
-    |`-h, --help`|Optional|Displays the help information about the startup command.|-|-|-|
-    |`--config <CONFIG>`|Optional|Specifies the configuration file or module.|Empty string|-|Physical file path (file:/path/to/config.py) or a module path (python:path.to.config.module) that can be identified by Python.|
-    |`--workspace <WORKSPACE>`|Optional|Specifies the working directory.|$HOME/mindinsight|-|-|
-    |`--port <PORT>`|Optional|Specifies the port number of the web visualization service.|8080|1~65535|-|
-    |`--url-path-prefix <URL_PATH_PREFIX>`|Optional|Specifies the URL path prefix of the web visualization service.|Empty string|-|URL path prefix consists of segments separated by slashes. Each segment supports alphabets / digits / underscores / dashes / dots, but cannot just be emtpy string / single dot / double dots. The default value of URL_PATH_PREFIX is empty string.|
-    |`--reload-interval <RELOAD_INTERVAL>`|Optional|Specifies the interval (unit: second) for loading data.|3|-|The value 0 indicates that data is loaded only once.|
-    |`--summary-base-dir <SUMMARY_BASE_DIR>`|Optional|Specifies the root directory for loading training log data.|./|-|MindInsight traverses the direct subdirectories in this directory and searches for log files. If a direct subdirectory contains log files, it is identified as the log file directory. If a root directory contains log files, it is identified as the log file directory.|
+    |Name|Argument|Description|Type|Default|Scope|Specifications|
+    |---|---|---|---|---|---|---|
+    |`-h, --help`|Optional|Displays the help information about the startup command.|-|-|-|-|
+    |`--config <CONFIG>`|Optional|Specifies the configuration file or module.|str|Empty string|-|Physical file path (file:/path/to/config.py) or a module path (python:path.to.config.module) that can be identified by Python.|
+    |`--workspace <WORKSPACE>`|Optional|Specifies the working directory.|str|$HOME/mindinsight|-|-|
+    |`--port <PORT>`|Optional|Specifies the port number of the web visualization service.|int|8080|1~65535|-|
+    |`--url-path-prefix <URL_PATH_PREFIX>`|Optional|Specifies the URL path prefix of the web visualization service.|str|Empty string|-|URL path prefix consists of segments separated by slashes. Each segment supports alphabets / digits / underscores / dashes / dots, but cannot just be emtpy string / single dot / double dots. The default value of URL_PATH_PREFIX is empty string.|
+    |`--reload-interval <RELOAD_INTERVAL>`|Optional|Specifies the interval (unit: second) for loading data.|int|3|-|The value 0 indicates that data is loaded only once.|
+    |`--summary-base-dir <SUMMARY_BASE_DIR>`|Optional|Specifies the root directory for loading training log data.|str|./|-|MindInsight traverses the direct subdirectories in this directory and searches for log files. If a direct subdirectory contains log files, it is identified as the log file directory. If a root directory contains log files, it is identified as the log file directory.|
 
     > When the service is started, the parameter values of the command line are saved as the environment variables of the process and start with `MINDINSIGHT_`, for example, `MINDINSIGHT_CONFIG`, `MINDINSIGHT_WORKSPACE`, and `MINDINSIGHT_PORT`.
 
@@ -65,7 +65,7 @@
 
     Optional parameters as follows:
 
-    |Name|Argument|Description|Default|Scope|Specifications|
-    |---|---|---|---|---|---|
-    |`-h, --help`|Optional|Displays the help information about the startup command.|-|-|-|
-    |`--port <PORT>`|Optional|Specifies the port number of the web visualization service.|8080|1~65535|-|
+    |Name|Argument|Description|Type|Default|Scope|Specifications|
+    |---|---|---|---|---|---|---|
+    |`-h, --help`|Optional|Displays the help information about the startup command.|-|-|-|-|
+    |`--port <PORT>`|Optional|Specifies the port number of the web visualization service.|int|8080|1~65535|-|

tutorials/source_zh_cn/advanced_use/mindinsight_commands.md

@@ -25,15 +25,15 @@
 
     参数含义如下:
 
-    |参数名|属性|功能描述|默认值|取值范围|规则限制|
-    |---|---|---|---|---|---|
-    |`-h, --help`|可选|显示启动命令的帮助信息。|-|-|-|
-    |`--config <CONFIG>`|可选|指定配置文件或配置模块。|空|-|物理文件路径（file:/path/to/config.py）或Python可识别的模块路径（python:path.to.config.module）。|
-    |`--workspace <WORKSPACE>`|可选|指定工作目录路径。|$HOME/mindinsight|-|-|
-    |`--port <PORT>`|可选|指定Web可视化服务端口。|8080|1~65535|-|
-    |`--url-path-prefix <URL_PATH_PREFIX>`|可选|指定Web服务URL地址前缀。|空|-|URL地址前缀由斜杠(/)分隔成多个部分，各部分支持由字母/数字/下划线/连字符/点号组成的字符串，但不能是空字符串/单点号(.)/双点号(..)。|
-    |`--reload-interval <RELOAD_INTERVAL>`|可选|指定加载数据的时间间隔（单位：秒）。|3|-|设置为0时表示只加载一次数据。|
-    |`--summary-base-dir <SUMMARY_BASE_DIR>`|可选|指定加载训练日志数据的根目录路径。|./|-|MindInsight将遍历此路径下的直属子目录。若某个直属子目录包含日志文件，则该子目录被识别为日志文件目录，若根目录包含日志文件，则根目录被识别为日志文件目录。|
+    |参数名|属性|功能描述|参数类型|默认值|取值范围|规则限制|
+    |---|---|---|---|---|---|---|
+    |`-h, --help`|可选|显示启动命令的帮助信息。|-|-|-|-|
+    |`--config <CONFIG>`|可选|指定配置文件或配置模块。|str|空|-|物理文件路径（file:/path/to/config.py）或Python可识别的模块路径（python:path.to.config.module）。|
+    |`--workspace <WORKSPACE>`|可选|指定工作目录路径。|str|$HOME/mindinsight|-|-|
+    |`--port <PORT>`|可选|指定Web可视化服务端口。|int|8080|1~65535|-|
+    |`--url-path-prefix <URL_PATH_PREFIX>`|可选|指定Web服务URL地址前缀。|str|空|-|URL地址前缀由斜杠(/)分隔成多个部分，各部分支持由字母/数字/下划线/连字符/点号组成的字符串，但不能是空字符串/单点号(.)/双点号(..)。|
+    |`--reload-interval <RELOAD_INTERVAL>`|可选|指定加载数据的时间间隔（单位：秒）。|int|3|-|设置为0时表示只加载一次数据。|
+    |`--summary-base-dir <SUMMARY_BASE_DIR>`|可选|指定加载训练日志数据的根目录路径。|str|./|-|MindInsight将遍历此路径下的直属子目录。若某个直属子目录包含日志文件，则该子目录被识别为日志文件目录，若根目录包含日志文件，则根目录被识别为日志文件目录。|
 
     > 服务启动时，命令行参数值将被保存为进程的环境变量，并以 `MINDINSIGHT_` 开头作为标识，如 `MINDINSIGHT_CONFIG`，`MINDINSIGHT_WORKSPACE`，`MINDINSIGHT_PORT` 等。
 
@@ -65,7 +65,7 @@
 
     参数含义如下:
 
-    |参数名|属性|功能描述|默认值|取值范围|规则限制|
-    |---|---|---|---|---|---|
-    |`-h, --help`|可选|显示启动命令的帮助信息。|-|-|-|
-    |`--port <PORT>`|可选|指定Web可视化服务端口。|8080|1~65535|-|
+    |参数名|属性|功能描述|参数类型|默认值|取值范围|规则限制|
+    |---|---|---|---|---|---|---|
+    |`-h, --help`|可选|显示启动命令的帮助信息。|-|-|-|-|
+    |`--port <PORT>`|可选|指定Web可视化服务端口。|int|8080|1~65535|-|