瀏覽代碼

Merge pull request #72 from PaddlePaddle/devleop_deploy

add deploy python code
Jason 5 年之前
父節點
當前提交
5612887525
共有 3 個文件被更改,包括 32 次插入38 次删除
  1. 25 38
      docs/apis/deploy.md
  2. 1 0
      docs/apis/index.rst
  3. 6 0
      docs/tutorials/deploy/index.rst

+ 25 - 38
docs/apis/deploy.md

@@ -1,50 +1,37 @@
-# paddlex.deploy
+# Predictor部署-paddlex.deploy
 
 使用AnalysisPredictor进行预测部署。
 
-## create_predictor
+## Predictor类
 
 ```
-paddlex.deploy.create_predictor(model_dir, use_gpu=False)
+paddlex.deploy.Predictor(model_dir, use_gpu=False, gpu_id=0, use_mkl=False, use_trt=False, use_glog=False, memory_optimize=True)
 ```
 
-#### Args
+> **参数**
 
-* **model_dir**: 训练过程中保存的模型路径
-* **use_gpu**: 是否使用GPU进行预测
+> > * **model_dir**: 训练过程中保存的模型路径, 注意需要使用导出的inference模型
+> > * **use_gpu**: 是否使用GPU进行预测
+> > * **gpu_id**: 使用的GPU序列号
+> > * **use_mkl**: 是否使用mkldnn加速库
+> > * **use_trt**: 是否使用TensorRT预测引擎
+> > * **use_glog**: 是否打印中间日志
+> > * **memory_optimize**: 是否优化内存使用
 
-#### Returns
+> > ### 示例
+> >
+> > ```
+> > import paddlex
+> > model = paddlex.deploy.Predictor(model_dir, use_gpu=True)
+> > result = model.predict(image_file)
+> > ```
 
-* **Predictor**: paddlex.deploy.predictor.Predictor
+### predict 接口
+> ```
+> predict(image, topk=1)
+> ```
 
-### 示例
+> **参数
 
-```
-import paddlex
-# 下
-Predictor = paddlex.deploy.create_predictor(model_dir, use_gpu=True)
-```
-
-## ClassifyPredictor
-继承至paddlex.deploy.predictor.Predictor,当model_dir/model.yml里面
-
-```
-paddlex.deploy.create_predictor(model_dir, use_gpu=False)
-```
-
-#### Args
-
-* **model_dir**: 训练过程中保存的模型路径
-* **use_gpu**: 是否使用GPU进行预测
-
-#### Returns
-
-* **Predictor**: paddlex.deploy.predictor.Predictor
-
-### 示例
-
-```
-import paddlex
-# 下
-Predictor = paddlex.deploy.create_predictor(model_dir, use_gpu=True)
-```
+* **image(str|np.ndarray)**: 待预测的图片路径或np.ndarray,若为后者需注意为BGR格式
+* **topk(int)**: 图像分类时使用的参数,表示预测前topk个可能的分类

+ 1 - 0
docs/apis/index.rst

@@ -10,3 +10,4 @@ PaddleX API说明文档
    slim.md
    load_model.md
    visualize.md
+   deploy.md

+ 6 - 0
docs/tutorials/deploy/index.rst

@@ -1,2 +1,8 @@
 多端部署
 ==============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: 文档目录:
+
+