提交 ba1de46f 编写于 作者: W wuzewu

add API doc

上级 b1faba2f
......@@ -48,7 +48,7 @@ $ hub search
## 深入了解PaddleHub
* [命令行功能](https://github.com/PaddlePaddle/PaddleHub/tree/develop/docs/command_line_introduction.md)
* [Finetune API与迁移学习](https://github.com/PaddlePaddle/PaddleHub/tree/develop/docs/turtorial/transfer_learning_turtorial.md)
* API
* [API](https://github.com/PaddlePaddle/PaddleHub/tree/develop/docs/API_list.md)
## 答疑
......
----
# Module
----
在PaddleHub中,Module代表了一个`可执行`的模型。这里的可执行指的是,Module可以直接通过命令行`hub run ${MODULE_NAME}`执行预测,或者通过context接口获取上下文后进行finetune。
## \_\_init\_\_
在生成一个Module时,支持通过名称、url或者路径创建Module
> ### 参数
> * name: 模块名称
> * url: 模块的url
> * module_dir: 模块路径
>
> ### 示例
>
> ```python
> import paddlehub as hub
> # 根据模型名字创建Module
> hub.Module(name = "lac")
> ```
### context
用于获取Module的上下文信息,得到输入、输出以及Paddle Program
> ### 参数
> * for_test: 是否用于测试,如果是用于预测,则设置为True,如果用于finetune,则设置为False。默认情况下,该参数被设置为False
>
> ### 示例
>
> ```python
> import paddlehub as hub
> resnet = hub.Module(name = "resnet_v2_50_imagenet")
> input_dict, output_dict, program = resnet.context()
> with fluid.program_guard(program):
> label = fluid.layers.data(name="label", dtype="int64", shape=[1])
> img = input_dict["image"]
> feature_map = output_dict["feature_map"]
> feed_list = [img.name, label.name]
> fc = fluid.layers.fc(input = feature_map, size = 2)
> feed_list = [img.name, label.name]
> # 添加fc层后,进行训练
> ...
> ```
# 类
* [Module](https://github.com/PaddlePaddle/PaddleHub/tree/develop/docs/API/Module.md)
* [Task]
* [RunConfig]
* [LocalModuleManager]
* [HubServer]
* [ImageClassificationReader]
* [ImageClassificationDataset]
# 接口
* [create_seq_label_task]
* [create_text_cls_task]
* [create_img_cls_task]
* [finetune_and_eval]
* [finetune]
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册