diff --git a/README.md b/README.md index bd29ddb68621bd3ec83a5cf6b49419e6b4f3799c..0d1caeba1da7f478c5475677c800f1b036f924b8 100644 --- a/README.md +++ b/README.md @@ -117,11 +117,14 @@ x2paddle --framework=caffe --prototxt=deploy.prototxt --weight=deploy.caffemodel | --model | 当framework为tensorflow/onnx时,该参数指定tensorflow的pb模型文件或onnx模型路径 | | --caffe_proto | **[可选]** 由caffe.proto编译成caffe_pb2.py文件的存放路径,当存在自定义Layer时使用,默认为None | | --define_input_shape | **[可选]** For TensorFlow, 当指定该参数时,强制用户输入每个Placeholder的shape,见[文档Q2](./docs/inference_model_convertor/FAQ.md) | -| --enable_code_optim | **[可选]** 是否对生成代码进行优化,默认为True | +| --enable_code_optim | **[可选]** For PyTorch, 是否对生成代码进行优化,默认为True | | --to_lite | **[可选]** 是否使用opt工具转成Paddle-Lite支持格式,默认为False | | --lite_valid_places | **[可选]** 指定转换类型,可以同时指定多个backend(以逗号分隔),opt将会自动选择最佳方式,默认为arm | | --lite_model_type | **[可选]** 指定模型转化类型,目前支持两种类型:protobuf和naive_buffer,默认为naive_buffer | +#### X2Paddle API +目前X2Paddle提供API方式转换模型,可参考[X2PaddleAPI](docs/inference_model_convertor/x2paddle_api.md) + #### 一键转换Paddle-Lite支持格式 可参考[使用X2paddle导出Padde-Lite支持格式](docs/inference_model_convertor/convert2lite_api.md) diff --git a/docs/inference_model_convertor/x2paddle_api.md b/docs/inference_model_convertor/x2paddle_api.md new file mode 100644 index 0000000000000000000000000000000000000000..c6ee37d7724dfaa3cad22fc1eb81d8a9050c97e4 --- /dev/null +++ b/docs/inference_model_convertor/x2paddle_api.md @@ -0,0 +1,80 @@ +# X2paddle API + +## 目录 + +* [x2paddle.convert.tf2paddle](#1) +* [x2paddle.convert.caffe2paddle](#2) +* [x2paddle.convert.onnx2paddle](#3) +* [x2paddle.convert.pytorch2paddle](#4) + +TensorFlow、Caffe、ONNX以及PyTorch模型转换API如下: + +##

x2paddle.convert.tf2paddle

+ +```python +x2paddle.convert.tf2paddle(model_path, save_dir, define_input_shape=False, convert_to_lite=False, lite_valid_places="arm", lite_model_type="naive_buffer") +``` + +> 转换TensorFlow模型。 + +> **参数** +> +> > - **model_path** (str): TensorFlow pb模型路径 +> > - **save_dir** (str): 转换后模型保存路径 +> > - **define_input_shape** (bool): 是否指定输入大小,默认为False +> > - **convert_to_lite** (bool): 是否使用opt工具转成Paddle-Lite支持格式,默认为False +> > - **lite_valid_places** (str): 指定转换类型,可以同时指定多个backend(以逗号分隔),opt将会自动选择最佳方式,默认为arm +> > - **lite_model_type** (str): 指定模型转化类型,目前支持两种类型:protobuf和naive_buffer,默认为naive_buffer + +##

x2paddle.convert.caffe2paddle

+ +```python +x2paddle.convert.caffe2paddle(proto_file, weight_file, save_dir, caffe_proto, convert_to_lite=False, lite_valid_places="arm", lite_model_type="naive_buffer") +``` + +> 转换Caffe模型。 + +> **参数** +> +> > - **proto_file** (str): caffe模型的prototxt文件 +> > - **weight_file** (str): caffe模型的权重文件 +> > - **save_dir** (str): 转换后模型保存路径 +> > - **caffe_proto** (str): 可选:由caffe.proto编译成caffe_pb2.py文件的存放路径,当存在自定义Layer时使用,默认为None +> > - **convert_to_lite** (bool): 是否使用opt工具转成Paddle-Lite支持格式,默认为False +> > - **lite_valid_places** (str): 指定转换类型,可以同时指定多个backend(以逗号分隔),opt将会自动选择最佳方式,默认为arm +> > - **lite_model_type** (str): 指定模型转化类型,目前支持两种类型:protobuf和naive_buffer,默认为naive_buffer + +##

x2paddle.convert.onnx2paddle

+ +```python +x2paddle.convert.onnx2paddle(model_path, save_dir, convert_to_lite=False, lite_valid_places="arm", lite_model_type="naive_buffer") +``` + +> 转换ONNX模型。 + +> **参数** +> +> > - **model_path** (str): TensorFlow pb模型路径 +> > - **save_dir** (str): 转换后模型保存路径 +> > - **convert_to_lite** (bool): 是否使用opt工具转成Paddle-Lite支持格式,默认为False +> > - **lite_valid_places** (str): 指定转换类型,可以同时指定多个backend(以逗号分隔),opt将会自动选择最佳方式,默认为arm +> > - **lite_model_type** (str): 指定模型转化类型,目前支持两种类型:protobuf和naive_buffer,默认为naive_buffer + +##

x2paddle.convert.pytorch2paddle

+ +```python +x2paddle.convert.pytorch2paddle(module, save_dir, jit_type="trace", input_examples=None, enable_code_optim=True, convert_to_lite=False, lite_valid_places="arm", lite_model_type="naive_buffer") +``` + +> 转换Pytorch模型。 + +> **参数** +> +> > - **module** (torch.nn. Module): PyTorch的Module +> > - **save_dir** (str): 转换后模型保存路径 +> > - **jit_type** (str): 转换方式。目前有两种:trace和script, 默认为trace +> > - **input_examples** (list[torch.tensor]): torch.nn. Module的输入示例,list的长度必须与输入的长度一致。默认为None +> > - **enable_code_optim** (bool): 转换后的代码是否进行优化, 默认为True +> > - **convert_to_lite** (bool): 是否使用opt工具转成Paddle-Lite支持格式,默认为False +> > - **lite_valid_places** (str): 指定转换类型,可以同时指定多个backend(以逗号分隔),opt将会自动选择最佳方式,默认为arm +> > - **lite_model_type** (str): 指定模型转化类型,目前支持两种类型:protobuf和naive_buffer,默认为naive_buffer