README.md

    X2Paddle

    PyPI - X2Paddle Version PyPI Status License Version python version

    简介

    X2Paddle是飞桨生态下的模型转换工具,致力于帮助其它深度学习框架用户快速迁移至飞桨框架。目前支持推理模型的框架转换PyTorch训练代码迁移,我们还提供了详细的不同框架间API对比文档,降低开发者上手飞桨核心的学习成本。

    特性

    • 支持主流深度学习框架

      • 目前已经支持Caffe/TensorFlow/ONNX/PyTorch四大框架的预测模型的转换,PyTorch训练项目的转换,涵盖了目前市面主流深度学习框架
    • 支持的模型丰富

      • 在主流的CV和NLP模型上均支持转换,涵盖了19+个Caffe预测模型转换、27+个TensorFlow预测模型转换、32+个ONNX预测模型转换、27+个PyTorch预测模型转换、2+个PyTorch训练项目转换,详见 支持列表
    • 简洁易用

      • 一条命令行或者一个API即可完成模型转换

    能力

    • 预测模型转换

      • 支持Caffe/TensorFlow/ONNX/PyTorch的模型一键转为飞桨的预测模型,并使用PaddleInference/PaddleLite进行CPU/GPU/Arm等设备的部署
    • PyTorch训练项目转换

      • 支持PyTorch项目Python代码(包括训练、预测)一键转为基于飞桨框架的项目代码,帮助开发者快速迁移项目,并可享受AIStudio平台对于飞桨框架提供的海量免费计算资源【新功能,试一下!】
    • API对应文档

      • 详细的API文档对比分析,帮助开发者快速从PyTorch框架的使用迁移至飞桨框架的使用,大大降低学习成本 【新内容,了解一下!】

    安装

    环境依赖

    • python >= 3.5
    • paddlepaddle >= 2.0.0
    • tensorflow == 1.14 (如需转换TensorFlow模型)
    • onnx >= 1.6.0 (如需转换ONNX模型)
    • torch >= 1.5.0 (如需转换PyTorch模型)
    • paddlelite == 2.9.0 (如需一键转换成Paddle-Lite支持格式)

    pip安装(推荐)

    如需使用稳定版本,可通过pip方式安装X2Paddle:

    pip install x2paddle

    源码安装

    如需体验最新功能,可使用源码安装方式:

    git clone https://github.com/PaddlePaddle/X2Paddle.git
    cd X2Paddle
    git checkout develop
    python setup.py install

    快速开始

    功能一:推理模型转换

    TensorFlow模型转换

    x2paddle --framework=tensorflow --model=tf_model.pb --save_dir=pd_model

    ONNX模型转换

    x2paddle --framework=onnx --model=onnx_model.onnx --save_dir=pd_model

    Caffe模型转换

    x2paddle --framework=caffe --prototxt=deploy.prototxt --weight=deploy.caffemodel --save_dir=pd_model

    转换参数说明

    参数 作用
    --framework 源模型类型 (tensorflow、caffe、onnx)
    --prototxt 当framework为caffe时,该参数指定caffe模型的proto文件路径
    --weight 当framework为caffe时,该参数指定caffe模型的参数文件路径
    --save_dir 指定转换后的模型保存目录路径
    --model 当framework为tensorflow/onnx时,该参数指定tensorflow的pb模型文件或onnx模型路径
    --caffe_proto [可选] 由caffe.proto编译成caffe_pb2.py文件的存放路径,当存在自定义Layer时使用,默认为None
    --define_input_shape [可选] For TensorFlow, 当指定该参数时,强制用户输入每个Placeholder的shape,见文档Q2
    --to_lite [可选] 是否使用opt工具转成Paddle-Lite支持格式,默认为False
    --lite_valid_places [可选] 指定转换类型,可以同时指定多个backend(以逗号分隔),opt将会自动选择最佳方式,默认为arm
    --lite_model_type [可选] 指定模型转化类型,目前支持两种类型:protobuf和naive_buffer,默认为naive_buffer

    一键转换Paddle-Lite支持格式

    可参考使用X2paddle导出Padde-Lite支持格式

    功能二:PyTorch模型训练迁移

    项目转换包括3个步骤

    1. 项目代码预处理
    2. 代码/预训练模型一键转换
    3. 转换后代码后处理

    详见PyTorch训练项目转换文档

    使用教程

    1. TensorFlow预测模型转换教程
    2. MMDetection模型转换指南
    3. PyTorch预测模型转换教程
    4. PyTorch训练项目转换教程

    更新历史

    2021.07.09

    1. 新增MMDetection模型库支持,包括YOLO-V3、FCOS、RetinaNet、SSD、Faster R-CNN以及FSAF,有相关AP精度对比,具体参考MMDetection模型转换指南
    2. 新增PyTorch训练代码转换对CRAFT的支持,新增PyTorch预测模型转换对Seg-Swin-Transformer的支持。
    3. 优化模型预测速度,去除forward函数开头to_tensor操作。
    4. 新增Tensorflow op映射(1个):Sign。
    5. 新增ONNX op映射(4个):NMS、ReduceL1、ReduceL2、3D Interpolate。

    2021.05.13

    2021.04.30

    1. 新增支持转换的模型:SwinTransformerBASNetDBFaceEasyOCRCifarNet等。
    2. 支持Windows上使用本工具。
    3. 新增TensorFlow op映射(4个):SplitV、ReverseV2、BatchToSpaceND、SpaceToBatchND。
    4. 新增PyTorch op映射(11个):aten::index、aten::roll、aten::adaptive_avg_pool1d、aten::reflection_pad2d、aten::reflection_pad1d、aten::instance_norm、aten::gru、aten::norm、aten::clamp_min、aten::prelu、aten:split_with_sizes。
    5. 新增ONNX op映射(1个):DepthToSpace。
    6. 新增Caffe op映射(1个):MemoryData。

    更多版本更新记录可查阅X2Paddle发版历史

    :hugs:贡献代码:hugs:

    我们非常欢迎您为X2Paddle贡献代码或者提供使用建议。如果您可以修复某个issue或者增加一个新功能,欢迎给我们提交Pull Requests,如果有PyTorch训练项目转换需求欢迎随时提issue~

    项目简介

    Deep learning model converter for PaddlePaddle. (『飞桨』深度学习模型转换工具)

    发行版本 28

    X2Paddle v1.3.4

    全部发行版

    贡献者 28

    全部贡献者

    开发语言

    • Python 100.0 %
    • Shell 0.0 %