From 72e2f6d2e17596cf20477c5fb51124b8f38d4a0e Mon Sep 17 00:00:00 2001 From: Zeyu Chen Date: Fri, 23 Apr 2021 23:27:11 +0800 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 210f276..d0fd2d7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![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支持Caffe/TensorFlow/ONNX/PyTorch的预测模型，一步转换至PaddlePaddle预测模型；同时，支持PyTorch训练项目，转换至PaddlePaddle项目，助力用户在PaddlePaddlePaddle上进行模型训练。 @@ -11,24 +12,25 @@ X2Paddle的架构设计着重考虑了对多深度学习框架的的支持以及 ![](./docs/images/frame.png) ### 特性 -- ***支持框架丰富***：目前已经支持Caffe/TensorFlow/ONNX/PyTorch四大框架的迁移，涵盖目前市面主流深度学习框架。 -- ***转换模型丰富***：在主流的CV和NLP模型上均支持转换，涵盖了19+个Caffe模型转换、27+个TensorFlow模型转换、32+个ONNX模型转换、27+个PyTorch模型转换、2+个PyTorch项目转换。 +- **支持主流深度学习框架**：目前已经支持Caffe/TensorFlow/ONNX/PyTorch四大框架的迁移，涵盖目前市面主流深度学习框架。 + +- **支持的模型丰富**：在主流的CV和NLP模型上均支持转换，涵盖了19+个Caffe模型转换、27+个TensorFlow模型转换、32+个ONNX模型转换、27+个PyTorch模型转换、2+个PyTorch项目转换。 -- ***简洁易用***：一条命令行或者一个API即可完成迁移。 +- **简洁易用**：一条命令行或者一个API即可完成模型转换。 ## 环境依赖 -> python >= 3.5 -> paddlepaddle 2.0.0+ +- python >= 3.5 +- paddlepaddle >= 2.0.0 **按需安装以下依赖** -> tensorflow ： tensorflow == 1.14.0 -> caffe ： 无 -> onnx ： onnx >= 1.6.0 -> pytorch：torch >=1.5.0 (script方式暂不支持1.7.0) +- tensorflow ： tensorflow == 1.14.0 +- caffe ： 无 +- onnx ： onnx >= 1.6.0 +- pytorch：torch >=1.5.0 (script方式暂不支持1.7.0) ## 安装 ### 方式一：源码安装（推荐） @@ -42,7 +44,7 @@ python setup.py install ### 方式二：pip安装 我们会定期更新pip源上的x2paddle版本 ``` -pip install x2paddle --index https://pypi.Python.org/simple/ +pip install x2paddle --index https://pypi.python.org/simple/ ``` ## 快速开始 ### 预测模型转换 @@ -56,6 +58,7 @@ 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/user_guides/FAQ.md) | | --paddle_type | **[可选]** 该参数指定转换为动态图代码（dygraph）或者静态图代码（static），默认为dygraph | + #### TensorFlow ``` x2paddle --framework=tensorflow --model=tf_model.pb --save_dir=pd_model --paddle_type dygraph @@ -73,6 +76,7 @@ x2paddle --framework=onnx --model=onnx_model.onnx --save_dir=pd_model --paddle_t PyTorch仅支持API使用方式，详见[PyTorch预测模型转换文档](./docs/user_guides/pytorch2paddle.md)。 ### 训练项目转换 + #### PyTorch 【待更新】可安装[分支](https://github.com/PaddlePaddle/X2Paddle/tree/pytorch_project_convertor)源码进行使用。 详见[PyTorch训练项目转换文档](https://github.com/SunAhong1993/X2Paddle/blob/code_convert_last/docs/pytorch_project_convertor/README.md)。 -- GitLab