diff --git a/docs/apis/deploy.md b/docs/apis/deploy.md index ccdcd86dca6b91354564ccf40a47d3b6d47c4959..ad97dc23957104cebc7e487d38554cb06ced57f2 100755 --- a/docs/apis/deploy.md +++ b/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个可能的分类 diff --git a/docs/apis/index.rst b/docs/apis/index.rst index 900e165170997ec97ef8ad93cbda7f6c47e24f2e..d58e90d93fd0e5ae78476f9ce0841ca190675f11 100755 --- a/docs/apis/index.rst +++ b/docs/apis/index.rst @@ -10,3 +10,4 @@ PaddleX API说明文档 slim.md load_model.md visualize.md + deploy.md diff --git a/docs/tutorials/deploy/index.rst b/docs/tutorials/deploy/index.rst index 022d15ab9ea0ee2963cd9b2cd2a8e2cc6c00c06b..2aa5e1d61db4fa3901da833b2b3c2bb112fce491 100644 --- a/docs/tutorials/deploy/index.rst +++ b/docs/tutorials/deploy/index.rst @@ -1,2 +1,8 @@ 多端部署 ============== + +.. toctree:: + :maxdepth: 2 + :caption: 文档目录: + +