Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
PaddlePaddle
X2Paddle
提交
a7fae8da
X
X2Paddle
项目概览
PaddlePaddle
/
X2Paddle
1 年多 前同步成功
通知
328
Star
698
Fork
167
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
26
列表
看板
标记
里程碑
合并请求
4
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
X
X2Paddle
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
26
Issue
26
列表
看板
标记
里程碑
合并请求
4
合并请求
4
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
a7fae8da
编写于
5月 25, 2021
作者:
J
Jason
提交者:
GitHub
5月 25, 2021
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Update README.md
上级
c0ac1e01
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
60 addition
and
52 deletion
+60
-52
README.md
README.md
+60
-52
未找到文件。
README.md
浏览文件 @
a7fae8da
# X2Paddle
[
![License
](
https://img.shields.io/badge/license-Apache%202-blue.svg
)
](LICENSE)
[
![Version
](
https://img.shields.io/github/release/PaddlePaddle/X2Paddle.svg
)
](https://github.com/PaddlePaddle/X2Paddle/releases)
![
python version
](
https://img.shields.io/badge/python-3.5+-orange.svg
)
## 简介
X2Paddle用于不同框架模型或项目到PaddlePaddle框架模型或项目的转换,旨在为飞桨开发者提升框架间转换的效率。
X2Paddle主要有
***2大功能**
*
:
1.
***预测模型转换**
*
:X2Paddle支持Caffe/TensorFlow/ONNX/PyTorch的预测模型,一步转换至PaddlePaddle预测模型。
2.
***训练项目转换**
*
:PyTorch训练项目,转换至PaddlePaddle项目,助力用户在PaddlePaddlePaddle上进行模型训练。
[
:heart:使用文档:heart:
](
./docs/pytorch_project_convertor/README.md
)
### 特性
X2Paddle致力于帮助其它主流深度学习框架用户快速迁移至飞桨框架,并为此提供了预测模型/训练代码的一键转换工具,以及框架间的API对比文档,提升用户在开发过程中的迁移效率,降低框架间迁移的学习成本。
-
**支持主流深度学习框架**
:目前已经支持Caffe/TensorFlow/ONNX/PyTorch四大框架的预测模型的转换,PyTorch训练项目的转换,涵盖了目前市面主流深度学习框架。
-
**支持的模型丰富**
:在主流的CV和NLP模型上均支持转换,涵盖了19+个Caffe预测模型转换、27+个TensorFlow预测模型转换、32+个ONNX预测模型转换、27+个PyTorch预测模型转换、2+个PyTorch训练项目转换,详见
***[支持列表](./docs/introduction/x2paddle_model_zoo.md)**
*
。
## 特性
-
**支持主流深度学习框架**
:目前已经支持Caffe/TensorFlow/ONNX/PyTorch四大框架的预测模型的转换,PyTorch训练项目的转换,涵盖了目前市面主流深度学习框架。
-
**支持的模型丰富**
:在主流的CV和NLP模型上均支持转换,涵盖了19+个Caffe预测模型转换、27+个TensorFlow预测模型转换、32+个ONNX预测模型转换、27+个PyTorch预测模型转换、2+个PyTorch训练项目转换,详见
***[支持列表](./docs/introduction/x2paddle_model_zoo.md)**
*
。
-
**简洁易用**
:一条命令行或者一个API即可完成模型转换。
##
环境依赖
##
能力
-
python >= 3.5
-
paddlepaddle >= 2.0.0
-
预测模型转换
-
支持Caffe/TensorFlow/ONNX/PyTorch的模型一键转为飞桨的预测模型,并使用PaddleInference/PaddleLite进行CPU/GPU/Arm等设备的部署
-
PyTorch训练项目转换
-
支持PyTorch项目Python代码(包括训练、预测)一键转为基于飞桨框架的项目代码,帮助开发者快速迁移项目,并可享受AIStudio平台对于飞桨框架提供的海量免费计算资源
[
【新功能,试一下!】
](
/docs/pytorch_project_convertor/README.md
)
]
-
API对应文档
**按需安装以下依赖**
-
tensorflow : tensorflow == 1.14.0
-
caffe : 无
-
onnx : onnx >= 1.6.0
-
pytorch:torch >=1.5.0 (预测模型转换中的script方式暂不支持1.7.0+)
-
详细的API文档对比分析,帮助开发者快速从PyTorch框架的使用迁移至飞桨框架的使用,大大降低学习成本
[
【新内容,了解一下!】
](
docs/pytorch_project_convertor/API_docs/README.m
)
## 安装
-
python >= 3.5
-
paddlepaddle >= 2.0.0
-
tensorflow == 1.14.0 (仅在转换TensorFlow模型时需要)
-
onnx >= 1.6.0 (仅在转换ONNX模型时需要)
-
torch >= 1.5.0 (仅在转换PyTorch模型时需要)
### 方式一:源码安装
```
git clone https://github.com/PaddlePaddle/X2Paddle.git
cd X2Paddle
...
...
@@ -40,13 +52,31 @@ python setup.py install
```
### 方式二:pip安装(推荐)
我们会定期更新pip源上的x2paddle版本
```
pip install x2paddle --index https://pypi.python.org/simple/
```
## 快速开始
### 功能一:预测模型转换
| 参数 | 作用 |
```
shell
# TensorFlow模型转换
x2paddle
--framework
=
tensorflow
--model
=
tf_model.pb
--save_dir
=
pd_model
# Caffe模型转换
x2paddle
--framework
=
caffe
--prototxt
=
deploy.prototxt
--weight
=
deploy.caffemodel
--save_dir
=
pd_model
# ONNX模型转换
x2paddle
--framework
=
onnx
--model
=
onnx_model.onnx
--save_dir
=
pd_model
# PyTorch模型转换 目前不支持命令行形式转换,参考下面链接文档进行转换
https://github.com/PaddlePaddle/X2Paddle/blob/develop/docs/inference_model_convertor/pytorch2paddle.md
```
#### 转换参数说明
| 参数 | 作用 |
| -------------------- | ------------------------------------------------------------ |
| --framework | 源模型类型 (tensorflow、caffe、onnx) |
| --prototxt | 当framework为caffe时,该参数指定caffe模型的proto文件路径 |
...
...
@@ -56,59 +86,36 @@ pip install x2paddle --index https://pypi.python.org/simple/
| --caffe_proto |
**[可选]**
由caffe.proto编译成caffe_pb2.py文件的存放路径,当存在自定义Layer时使用,默认为None |
| --define_input_shape |
**[可选]**
For TensorFlow, 当指定该参数时,强制用户输入每个Placeholder的shape,见
[
文档Q2
](
./docs/inference_model_convertor/FAQ.md
)
|
#### TensorFlow
```
shell
x2paddle
--framework
=
tensorflow
--model
=
tf_model.pb
--save_dir
=
pd_model
```
【注意】目前只支持FrozenModel格式的TensorFlow模型到PaddlePaddle模型的转换,若为checkpoint或者SavedModel格式的TensorFlow模型参见
[
文档
](
./docs/inference_model_convertor/export_tf_model.md
)
导出FrozenModel格式模型。
#### Caffe
```
shell
x2paddle
--framework
=
caffe
--prototxt
=
deploy.prototxt
--weight
=
deploy.caffemodel
--save_dir
=
pd_model
```
【注意】若caffe模型中出现自定义层,需要按照
[
相关流程
](
./docs/inference_model_convertor/add_caffe_custom_layer.md
)
自行添加自定义层的转换代码。
#### ONNX
```
shell
x2paddle
--framework
=
onnx
--model
=
onnx_model.onnx
--save_dir
=
pd_model
```
【注意】如若需要将PyTorch模型转换为ONNX模型,可参见
[
PyTorch2ONNX转换文档
](
./docs/inference_model_convertor/pytorch2onnx.md
)
。
#### PyTorch
PyTorch仅支持API使用方式,详见
[
PyTorch预测模型转换文档
](
./docs/inference_model_convertor/pytorch2paddle.md
)
。
### 功能二:PyTorch训练项目转换
***[预测模型转换常见问题](./docs/inference_model_convertor/FAQ.md)**
*
项目转换包括3个步骤
1.
项目代码预处理
2.
代码/预训练模型一键转换
3.
转换后代码后处理
### 功能二:训练项目转换:heart: :heart:
详见
[
PyTorch训练项目转换文档
](
./docs/pytorch_project_convertor/README.md
)
。
| 参数 | 作用 |
|----------|--------------|
|--convert_torch_project | 表示使用对PyTorch Project进行转换的功能 |
|--project_dir | PyTorch的项目路径 |
|--save_dir | 指定转换后项目的保存路径 |
|--pretrain_model |
**[可选]**
需要转换的预训练模型的路径(文件后缀名为“.pth”、“.pt”、“.ckpt”)或者包含预训练模型的文件夹路径,转换后的模型将将保在当前路径,后缀名为“.pdiparams” |
```
shell
x2paddle
--convert_torch_project
--project_dir
=
torch_project
--save_dir
=
paddle_project
--pretrain_model
=
model.pth
```
【注意】需要搭配预处理和后处理一起使用,详细可参见
[
训练项目转换文档
](
./docs/pytorch_project_convertor/README.md
)
。 此外,我们为用户提供了:star:
[
PyTorch-PaddlePaddle API映射表
](
docs/pytorch_project_convertor/API_docs/README.md
)
:star:供用户查阅。
***[训练项目转换常见问题](./docs/pytorch_project_convertor/FAQ.md)**
*
## 使用教程
## 转换教程
1.
[
TensorFlow预测模型转换教程
](
./docs/inference_model_convertor/demo/tensorflow2paddle.ipynb
)
2.
[
PyTorch预测模型转换教程
](
./docs/inference_model_convertor/demo/pytorch2paddle.ipynb
)
3.
[
PyTorch训练项目转换教程
](
./docs/pytorch_project_convertor/demo/README.md
)
## 更新历史
**2020.12.09**
1.
新增PyTorch2Paddle转换方式,转换得到Paddle动态图代码,并动转静获得inference_model。
方式一:trace方式,转换后的代码有模块划分,每个模块的功能与PyTorch相同。
方式二:script方式,转换后的代码按执行顺序逐行出现。
方式一:trace方式,转换后的代码有模块划分,每个模块的功能与PyTorch相同。
方式二:script方式,转换后的代码按执行顺序逐行出现。
2.
新增Caffe/ONNX/Tensorflow到Paddle动态图的转换。
3.
新增TensorFlow op映射(14个):Neg、Greater、FloorMod、LogicalAdd、Prd、Equal、Conv3D、Ceil、AddN、DivNoNan、Where、MirrorPad、Size、TopKv2。
4.
新增Optimizer模块,主要包括op融合、op消除功能,转换后的代码可读性更强,进行预测时耗时更短。
**2021.04.30**
1.
新增支持转换的模型:
[
SwinTransformer
](
https://github.com/microsoft/Swin-Transformer/
)
、
[
BASNet
](
https://github.com/xuebinqin/BASNet
)
、
[
DBFace
](
https://github.com/dlunion/DBFace
)
、
[
EasyOCR
](
https://github.com/JaidedAI/EasyOCR
)
、
[
CifarNet
](
https://github.com/tensorflow/models/blob/master/research/slim/nets/cifarnet.py
)
等。
2.
支持Windows上使用本工具。
3.
新增TensorFlow op映射(4个):SplitV、ReverseV2、BatchToSpaceND、SpaceToBatchND。
...
...
@@ -117,8 +124,9 @@ x2paddle --convert_torch_project --project_dir=torch_project --save_dir=paddle_p
6.
新增Caffe op映射(1个):MemoryData。
**2021.05.13**
-
新增PyTorch训练项目功能:
支持转换的项目有
[
StarGAN
](
https://github.com/yunjey/stargan
)
、
[
Ultra-Light-Fast-Generic-Face-Detector-1MB
](
https://github.com/Linzaer/Ultra-Light-Fast-Generic-Face-Detector-1MB
)
。
支持转换的项目有
[
StarGAN
](
https://github.com/yunjey/stargan
)
、
[
Ultra-Light-Fast-Generic-Face-Detector-1MB
](
https://github.com/Linzaer/Ultra-Light-Fast-Generic-Face-Detector-1MB
)
。
## :hugs:贡献代码:hugs:
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录