diff --git a/tutorials/source_en/advanced_use/mindinsight_commands.md b/tutorials/source_en/advanced_use/mindinsight_commands.md index 4b307c74f0d17638c8acd1971f89b075a1cd2be9..129fd224d7646f14fbfdbbfdf243df4840a40be0 100644 --- a/tutorials/source_en/advanced_use/mindinsight_commands.md +++ b/tutorials/source_en/advanced_use/mindinsight_commands.md @@ -25,13 +25,15 @@ Optional parameters as follows: - - `-h, --help` : Displays the help information about the startup command. - - `--config ` : Specifies the configuration file or module. CONFIG indicates the physical file path (file:/path/to/config.py), or a module path (python:path.to.config.module) that can be identified by Python. - - `--workspace ` : Specifies the working directory. The default value of WORKSPACE is $HOME/mindinsight. - - `--port ` : Specifies the port number of the web visualization service. The value ranges from 1 to 65535. The default value of PORT is 8080. - - `--url-path-prefix ` : Specifies the URL path prefix of the web visualization service. 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 ` : Specifies the interval (unit: second) for loading data. The value 0 indicates that data is loaded only once. The default value of RELOAD_INTERVAL is 3 seconds. - - `--summary-base-dir ` : 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. SUMMARY_BASE_DIR is the current directory path by default. + |Name|Argument|Description|Default|Scope|Specifications| + |---|---|---|---|---|---| + |`-h, --help`|Optional|Displays the help information about the startup command.|-|-|-| + |`--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 `|Optional|Specifies the working directory.|$HOME/mindinsight|-|-| + |`--port `|Optional|Specifies the port number of the web visualization service.|8080|1~65535|-| + |`--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 `|Optional|Specifies the interval (unit: second) for loading data.|3|-|The value 0 indicates that data is loaded only once.| + |`--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.| > 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`. @@ -63,5 +65,7 @@ Optional parameters as follows: - - `-h, --help` : Displays the help information about the stop command. - - `--port ` : Specifies the port number of the web visualization service. The value ranges from 1 to 65535. The default value of PORT is 8080. + |Name|Argument|Description|Default|Scope|Specifications| + |---|---|---|---|---|---| + |`-h, --help`|Optional|Displays the help information about the startup command.|-|-|-| + |`--port `|Optional|Specifies the port number of the web visualization service.|8080|1~65535|-| diff --git a/tutorials/source_zh_cn/advanced_use/mindinsight_commands.md b/tutorials/source_zh_cn/advanced_use/mindinsight_commands.md index 0090c1fc0ec710b8f2a02a38597de1ecbd829302..6f82ef969a9c90c8c31cf4f36273165ba3e3eff4 100644 --- a/tutorials/source_zh_cn/advanced_use/mindinsight_commands.md +++ b/tutorials/source_zh_cn/advanced_use/mindinsight_commands.md @@ -25,13 +25,15 @@ 参数含义如下: - - `-h, --help` : 显示启动命令的帮助信息。 - - `--config ` : 指定配置文件或配置模块，CONFIG为物理文件路径（file:/path/to/config.py）或Python可识别的模块路径（python:path.to.config.module）。 - - `--workspace ` : 指定工作目录路径，WORKSPACE默认为 $HOME/mindinsight。 - - `--port ` : 指定Web可视化服务端口，取值范围是1~65535，PORT默认为8080。 - - `--url-path-prefix ` : 指定Web服务URL地址前缀，URL地址前缀由斜杠(/)分隔成多个部分，各部分支持由字母/数字/下划线/连字符/点号组成的字符串，但不能是空字符串/单点号(.)/双点号(..)，URL_PATH_PREFIX默认为空。 - - `--reload-interval ` : 指定加载数据的时间间隔（单位：秒），设置为0时表示只加载一次数据，RELOAD_INTERVAL默认为3秒。 - - `--summary-base-dir ` : 指定加载训练日志数据的根目录路径，MindInsight将遍历此路径下的直属子目录。若某个直属子目录包含日志文件，则该子目录被识别为日志文件目录，若根目录包含日志文件，则根目录被识别为日志文件目录。SUMMARY_BASE_DIR默认为当前目录路径。 + |参数名|属性|功能描述|默认值|取值范围|规则限制| + |---|---|---|---|---|---| + |`-h, --help`|可选|显示启动命令的帮助信息。|-|-|-| + |`--config `|可选|指定配置文件或配置模块。|空|-|物理文件路径（file:/path/to/config.py）或Python可识别的模块路径（python:path.to.config.module）。| + |`--workspace `|可选|指定工作目录路径。|$HOME/mindinsight|-|-| + |`--port `|可选|指定Web可视化服务端口。|8080|1~65535|-| + |`--url-path-prefix `|可选|指定Web服务URL地址前缀。|空|-|URL地址前缀由斜杠(/)分隔成多个部分，各部分支持由字母/数字/下划线/连字符/点号组成的字符串，但不能是空字符串/单点号(.)/双点号(..)。| + |`--reload-interval `|可选|指定加载数据的时间间隔（单位：秒）。|3|-|设置为0时表示只加载一次数据。| + |`--summary-base-dir `|可选|指定加载训练日志数据的根目录路径。|./|-|MindInsight将遍历此路径下的直属子目录。若某个直属子目录包含日志文件，则该子目录被识别为日志文件目录，若根目录包含日志文件，则根目录被识别为日志文件目录。| > 服务启动时，命令行参数值将被保存为进程的环境变量，并以 `MINDINSIGHT_` 开头作为标识，如 `MINDINSIGHT_CONFIG`，`MINDINSIGHT_WORKSPACE`，`MINDINSIGHT_PORT` 等。 @@ -63,5 +65,7 @@ 参数含义如下: - - `-h, --help` : 显示停止命令的帮助信息。 - - `--port ` : 指定Web可视化服务端口，取值范围是1~65535，PORT默认为8080。 + |参数名|属性|功能描述|默认值|取值范围|规则限制| + |---|---|---|---|---|---| + |`-h, --help`|可选|显示启动命令的帮助信息。|-|-|-| + |`--port `|可选|指定Web可视化服务端口。|8080|1~65535|-|