From a7dd6eae6347f390fc52b41922843aca876b12d1 Mon Sep 17 00:00:00 2001 From: liangyongxiong Date: Wed, 29 Jul 2020 15:44:06 +0800 Subject: [PATCH] fix command description --- tutorials/source_en/advanced_use/mindinsight_commands.md | 6 +++--- tutorials/source_zh_cn/advanced_use/mindinsight_commands.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/tutorials/source_en/advanced_use/mindinsight_commands.md b/tutorials/source_en/advanced_use/mindinsight_commands.md index c6f1c8c302..f8835cfd1b 100644 --- a/tutorials/source_en/advanced_use/mindinsight_commands.md +++ b/tutorials/source_en/advanced_use/mindinsight_commands.md @@ -38,11 +38,11 @@ Optional parameters as follows: |Name|Argument|Description|Type|Default|Scope|Specifications| |---|---|---|---|---|---|---| -|`-h, --help`|Optional|Displays the help information about the startup command.|-|-|-|-| +|`-h, --help`|Optional|Displays the help information about the start command.|-|-|-|-| |`--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 `|Optional|Specifies the working directory.|str|$HOME/mindinsight|-|-| |`--port `|Optional|Specifies the port number of the web visualization service.|int|8080|1~65535|-| -|`--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.| +|`--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 not single dot or double dots.| |`--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 `|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.| @@ -78,5 +78,5 @@ Optional parameters as follows: |Name|Argument|Description|Type|Default|Scope|Specifications| |---|---|---|---|---|---|---| -|`-h, --help`|Optional|Displays the help information about the startup command.|-|-|-|-| +|`-h, --help`|Optional|Displays the help information about the stop command.|-|-|-|-| |`--port `|Optional|Specifies the port number of the web visualization service.|int|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 51e9aa10de..e3c06188c1 100644 --- a/tutorials/source_zh_cn/advanced_use/mindinsight_commands.md +++ b/tutorials/source_zh_cn/advanced_use/mindinsight_commands.md @@ -42,7 +42,7 @@ mindinsight start [-h] [--config ] [--workspace ] |`--config `|可选|指定配置文件或配置模块。|str|空|-|物理文件路径(file:/path/to/config.py)或Python可识别的模块路径(python:path.to.config.module)。| |`--workspace `|可选|指定工作目录路径。|str|$HOME/mindinsight|-|-| |`--port `|可选|指定Web可视化服务端口。|int|8080|1~65535|-| -|`--url-path-prefix `|可选|指定Web服务URL地址前缀。|str|空|-|URL地址前缀由斜杠(/)分隔成多个部分,各部分支持由字母/数字/下划线/连字符/点号组成的字符串,但不能是空字符串/单点号(.)/双点号(..)。| +|`--url-path-prefix `|可选|指定Web服务URL地址前缀。|str|空|-|URL地址前缀由斜杠(/)分隔成多个部分,各部分支持由字母/数字/下划线/连字符/点号组成的字符串,但不能是单点号(.)或双点号(..)。| |`--reload-interval `|可选|指定加载数据的时间间隔(单位:秒)。|int|3|-|设置为0时表示只加载一次数据。| |`--summary-base-dir `|可选|指定加载训练日志数据的根目录路径。|str|./|-|MindInsight将遍历此路径下的直属子目录。若某个直属子目录包含日志文件,则该子目录被识别为日志文件目录,若根目录包含日志文件,则根目录被识别为日志文件目录。| @@ -78,5 +78,5 @@ mindinsight stop [-h] [--port PORT] |参数名|属性|功能描述|参数类型|默认值|取值范围|规则限制| |---|---|---|---|---|---|---| -|`-h, --help`|可选|显示启动命令的帮助信息。|-|-|-|-| +|`-h, --help`|可选|显示停止命令的帮助信息。|-|-|-|-| |`--port `|可选|指定Web可视化服务端口。|int|8080|1~65535|-| -- Gitee