From e4115813b6e02311cdbc948c57e5d4e510804ebc Mon Sep 17 00:00:00 2001 From: Zeyu Chen Date: Sat, 13 Apr 2019 02:51:33 +0800 Subject: [PATCH] Update command_line_introduction.md --- docs/command_line_introduction.md | 39 +++++++++++++++++++------------ 1 file changed, 24 insertions(+), 15 deletions(-) diff --git a/docs/command_line_introduction.md b/docs/command_line_introduction.md index 88619e44..0ca163da 100644 --- a/docs/command_line_introduction.md +++ b/docs/command_line_introduction.md @@ -1,9 +1,9 @@ # 命令行 -Paddle Hub为Module/Model（关于Model和Module的区别，请查看下方的介绍）的管理和使用提供了命令行工具，目前命令行支持以下10个命令： +PaddleHub为Module/Model（关于Model和Module的区别，请查看下方的介绍）的管理和使用提供了命令行工具，目前命令行支持以下10个命令： ## `install` -用于将Module安装到本地，默认安装在${USER_HOME}/.paddlehub/module目录下，当一个Module安装到本地后，用户可以通过其他命令操作该Module（例如，使用该Module进行预测），也可以使用PaddleHub提供的python API，将Module应用到自己的任务中，实现迁移学习 +用于将Module安装到本地，默认安装在`${USER_HOME}/.paddlehub/module`目录下，当一个Module安装到本地后，用户可以通过其他命令操作该Module（例如，使用该Module进行预测），也可以使用PaddleHub提供的python API，将Module应用到自己的任务中，实现迁移学习 ## `uninstall` @@ -53,31 +53,36 @@ PaddleHub在使用过程中会产生一些缓存数据，这部分数据默认 PaddleHub尽量简化了用户在使用命令行预测时的理解成本，一般来讲，我们将预测分为NLP和CV两大类 ## NLP类的任务 -输入数据通过--input_text或者--input_file指定。以LAC（中文词性分析）为例子，可以通过以下两个命令实现单文本和多文本的预测 +输入数据通过--input_text或者--input_file指定。以百度LAC模型（中文词法分析）为例，可以通过以下两个命令实现单行文本和多行文本的分析。 + ```shell -#单文本预测 -hub run lac --input_text "今天是个好日子" +# 单文本预测 +$ hub run lac --input_text "今天是个好日子" ``` ```shell -#多文本分析 -hub run lac --input_file test.txt +# 多文本分析 +$ hub run lac --input_file test.txt ``` -其中test.txt的格式为 + +其中test.txt的样例格式如下，每行是一个需要词法分析句子 + ``` 今天是个好日子 天气预报说今天要下雨 下一班地铁马上就要到了 ……更多行…… ``` + ## CV类的任务 -输入数据通过--input_path或者--input_file指定。以SSD（目标检测）为例子，可以通过以下两个命令实现单张图片和多张图片的预测 +输入数据通过`--input_path`或者`--input_file`指定。以SSD模型（单阶段目标检测）为例子，可以通过以下两个命令实现单张图片和多张图片的预测 + ```shell -#单张照片预测 -hub run ssd_mobilenet_pascal --input_path test.jpg +# 单张照片预测 +$ hub run ssd_mobilenet_pascal --input_path test.jpg ``` ```shell -#多张照片预测 -hub run ssd_mobilenet_pascal --input_file test.txt +# 多张照片预测 +$ hub run ssd_mobilenet_pascal --input_file test.txt ``` 其中test.txt的格式为 ``` @@ -93,8 +98,12 @@ person.jpg ## Model -Model代表着预训练好的参数和模型，当需要使用Model进行预测时，需要下载模型配套的代码，进行模型的加载，数据的预处理等操作后，才能进行预测。PaddleHub为PaddlePaddle的预训练模型提供了统一的管理机制，用户可以使用PaddleHub快速便捷的获取到最新的Model，以便进行实验或者其他操作。 +Model表示预训练好的参数和模型，当需要使用Model进行预测时，需要模型配套的代码，进行模型的加载，数据的预处理等操作后，才能进行预测。 + +PaddleHub为PaddlePaddle生态的预训练模型提供了统一的管理机制，用户可以使用`hub download`命令的获取到最新的Model，以便进行实验或者其他操作。 ## Module -Module是Model的超集，是一个`可执行模块`，一个Module可以支持直接命令行预测，也可以配合PaddleHub的接口，通过少量代码实现迁移学习。需要注意的是，不是所有的Module都支持命令行预测，也不是所有的Module都支持finetune。 +Module是Model的超集，是一个`可执行模块`，一个Module可以支持直接命令行预测，也可以配合PaddleHub Finetune API，通过少量代码实现迁移学习。 +需要注意的是，不是所有的Module都支持命令行预测; (例如BERT/ERNIE Transformer类模型，一般需要搭配任务进行finetune) +也不是所有的Module都可用于finetune（例如LAC词法分析模型，我们不建议用户用于finetune）。 -- GitLab