{"id":13595000,"url":"https://github.com/PaddlePaddle/X2Paddle","last_synced_at":"2025-04-09T10:32:35.507Z","repository":{"id":37663331,"uuid":"164796418","full_name":"PaddlePaddle/X2Paddle","owner":"PaddlePaddle","description":"Deep learning model converter for PaddlePaddle. (『飞桨』深度学习模型转换工具)","archived":false,"fork":false,"pushed_at":"2025-02-24T08:44:57.000Z","size":29283,"stargazers_count":750,"open_issues_count":272,"forks_count":162,"subscribers_count":23,"default_branch":"develop","last_synced_at":"2025-04-03T15:58:42.557Z","etag":null,"topics":["caffe","model-converter","onnx","paddlepaddle","pytorch","tensorflow","x2paddle-model-zoo"],"latest_commit_sha":null,"homepage":"http://www.paddlepaddle.org/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PaddlePaddle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-09T05:46:03.000Z","updated_at":"2025-03-26T20:00:51.000Z","dependencies_parsed_at":"2024-01-16T22:18:54.482Z","dependency_job_id":"d140b347-0a27-449c-bc30-63bf7733030d","html_url":"https://github.com/PaddlePaddle/X2Paddle","commit_stats":{"total_commits":1795,"total_committers":44,"mean_commits":40.79545454545455,"dds":0.7220055710306407,"last_synced_commit":"97c38dba3bbbc131071b2e575dbe539bad026b40"},"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PaddlePaddle%2FX2Paddle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PaddlePaddle%2FX2Paddle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PaddlePaddle%2FX2Paddle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PaddlePaddle%2FX2Paddle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PaddlePaddle","download_url":"https://codeload.github.com/PaddlePaddle/X2Paddle/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248020593,"owners_count":21034459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["caffe","model-converter","onnx","paddlepaddle","pytorch","tensorflow","x2paddle-model-zoo"],"created_at":"2024-08-01T16:01:42.189Z","updated_at":"2025-04-09T10:32:30.498Z","avatar_url":"https://github.com/PaddlePaddle.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# X2Paddle\n\n[![PyPI - X2Paddle Version](https://img.shields.io/pypi/v/x2paddle.svg?label=pip\u0026logo=PyPI\u0026logoColor=white)](https://pypi.org/project/x2paddle/)\n[![PyPI Status](https://pepy.tech/badge/x2paddle/month)](https://pepy.tech/project/x2paddle)\n[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](LICENSE)\n[![Version](https://img.shields.io/github/release/PaddlePaddle/X2Paddle.svg)](https://github.com/PaddlePaddle/X2Paddle/releases)\n![python version](https://img.shields.io/badge/python-3.5+-orange.svg)\n\n## 简介\n\nX2Paddle是飞桨生态下的模型转换工具，致力于帮助其它深度学习框架用户快速迁移至飞桨框架。目前支持**推理模型的框架转换**与**PyTorch训练代码迁移**，我们还提供了详细的不同框架间API对比文档，降低开发者将模型迁移到飞桨的时间成本。\n\n\n\n## 特性\n\n- **支持主流深度学习框架**\n\n  - 目前已经支持Caffe/TensorFlow/ONNX/PyTorch四大框架的预测模型的转换，PyTorch训练项目的转换，涵盖了目前市面主流深度学习框架，详见 ***[测试 demo ](./test_benchmark)***\n\n- **支持的模型丰富**\n\n  - 在主流的CV和NLP模型上支持大部分模型转换，目前X2Paddle支持130+ PyTorch OP，90+ ONNX OP，90+ TensorFlow OP 以及 30+ Caffe OP，详见 ***[支持列表](./docs/inference_model_convertor/op_list.md)***\n\n- **简洁易用**\n\n  - 一条命令行或者一个API即可完成模型转换\n\n\n\n## 能力\n\n- **预测模型转换**\n\n  - 支持Caffe/TensorFlow/ONNX/PyTorch的模型一键转为飞桨的预测模型，并使用PaddleInference/PaddleLite进行CPU/GPU/Arm等设备的部署\n\n- **PyTorch训练项目转换**\n\n  - 支持PyTorch项目Python代码（包括训练、预测）一键转为基于飞桨框架的项目代码，帮助开发者快速迁移项目，并可享受[AIStudio平台](https://aistudio.baidu.com/)对于飞桨框架提供的海量免费计算资源[**【新功能，试一下！】**](/docs/pytorch_project_convertor/README.md)\n\n- **API对应文档**\n\n  - 详细的API文档对比分析，帮助开发者快速从PyTorch框架的使用迁移至飞桨框架的使用，大大降低学习成本 [**【新内容，了解一下！】**](docs/pytorch_project_convertor/API_docs/README.md)\n\n\n\n## 安装\n\n### 环境依赖\n- python \u003e= 3.5\n- paddlepaddle \u003e= 2.2.2 (官方验证到2.4.2)\n- tensorflow == 1.14 (如需转换TensorFlow模型)\n- onnx \u003e= 1.6.0 (如需转换ONNX模型)\n- torch \u003e= 1.5.0 (如需转换PyTorch模型)\n- paddlelite \u003e= 2.9.0 (如需一键转换成Paddle-Lite支持格式,推荐最新版本)\n\n### pip安装(推荐）\n\n如需使用稳定版本，可通过pip方式安装X2Paddle：\n```\npip install x2paddle\n```\n\n### 源码安装\n\n如需体验最新功能，可使用源码安装方式：\n```\ngit clone https://github.com/PaddlePaddle/X2Paddle.git\ncd X2Paddle\ngit checkout develop\npython setup.py install\n```\n\n## 快速开始\n\n### 功能一：推理模型转换\n\n#### PyTorch模型转换\n``` python\nfrom x2paddle.convert import pytorch2paddle\npytorch2paddle(module=torch_module,\n               save_dir=\"./pd_model\",\n               jit_type=\"trace\",\n               input_examples=[torch_input])\n# module (torch.nn.Module): PyTorch的Module。\n# save_dir (str): 转换后模型的保存路径。\n# jit_type (str): 转换方式。默认为\"trace\"。\n# input_examples (list[torch.tensor]): torch.nn.Module的输入示例，list的长度必须与输入的长度一致。默认为None。\n```\n```script```模式以及更多细节可参考[PyTorch模型转换文档](./docs/inference_model_convertor/pytorch2paddle.md)。\n\n#### TensorFlow模型转换\n```shell\nx2paddle --framework=tensorflow --model=tf_model.pb --save_dir=pd_model\n```\n\n#### ONNX模型转换\n```shell\nx2paddle --framework=onnx --model=onnx_model.onnx --save_dir=pd_model\n```\n\n#### Caffe模型转换\n```shell\nx2paddle --framework=caffe --prototxt=deploy.prototxt --weight=deploy.caffemodel --save_dir=pd_model\n```\n\n#### 转换参数说明\n\n| 参数                 | 作用                                                         |\n| -------------------- | ------------------------------------------------------------ |\n| --framework          | 源模型类型 (tensorflow、caffe、onnx)                         |\n| --prototxt           | 当framework为caffe时，该参数指定caffe模型的proto文件路径     |\n| --weight             | 当framework为caffe时，该参数指定caffe模型的参数文件路径      |\n| --save_dir           | 指定转换后的模型保存目录路径                                 |\n| --model              | 当framework为tensorflow/onnx时，该参数指定tensorflow的pb模型文件或onnx模型路径 |\n| --input_shape_dict   | **[可选]** For ONNX, 定义ONNX模型输入大小 |\n| --caffe_proto        | **[可选]** 由caffe.proto编译成caffe_pb2.py文件的存放路径，当存在自定义Layer时使用，默认为None |\n| --define_input_shape | **[可选]** For TensorFlow, 当指定该参数时，强制用户输入每个Placeholder的shape，见[文档Q2](./docs/inference_model_convertor/FAQ.md) |\n| --enable_code_optim  | **[可选]** For PyTorch, 是否对生成代码进行优化，默认为False |\n| --to_lite            | **[可选]** 是否使用opt工具转成Paddle-Lite支持格式，默认为False |\n| --lite_valid_places  | **[可选]** 指定转换类型，可以同时指定多个backend(以逗号分隔)，opt将会自动选择最佳方式，默认为arm |\n| --lite_model_type    | **[可选]** 指定模型转化类型，目前支持两种类型：protobuf和naive_buffer，默认为naive_buffer |\n| --disable_feedback   | **[可选]** 是否关闭X2Paddle使用反馈；X2Paddle默认会统计用户在进行模型转换时的成功率，以及转换框架来源等信息，以便于帮忙X2Paddle根据用户需求进行迭代，不会上传用户的模型文件。如若不想参与反馈，可指定此参数为False即可 |\n\n#### X2Paddle API\n目前X2Paddle提供API方式转换模型，可参考[X2PaddleAPI](docs/inference_model_convertor/x2paddle_api.md)\n\n#### 一键转换Paddle-Lite支持格式\n可参考[使用X2paddle导出Paddle-Lite支持格式](docs/inference_model_convertor/convert2lite_api.md)\n\n### 功能二：PyTorch模型训练迁移\n\n项目转换包括3个步骤\n\n1. 项目代码预处理\n2. 代码/预训练模型一键转换\n3. 转换后代码后处理\n\n详见[PyTorch训练项目转换文档](./docs/pytorch_project_convertor/README.md)。\n\n### 使用VisualDL进行模型转换\n\n飞桨可视化工具VisualDL已经将模型转换工具部署在官网提供服务，可以点击[服务链接](https://www.paddlepaddle.org.cn/paddle/visualdl/modelconverter/)进行在线的ONNX2Paddle模型转换。\n\n![ONNX2Paddle](https://user-images.githubusercontent.com/22424850/226797893-ef697887-a056-445f-933e-f1bbc7c7df76.gif)\n\n\n## 使用教程\n\n1. [TensorFlow预测模型转换教程](./docs/inference_model_convertor/demo/tensorflow2paddle.ipynb)\n2. [MMDetection模型转换指南](./docs/inference_model_convertor/toolkits/MMDetection2paddle.md)\n3. [PyTorch预测模型转换教程](./docs/inference_model_convertor/demo/pytorch2paddle.ipynb)\n4. [PyTorch训练项目转换教程](./docs/pytorch_project_convertor/demo/README.md)\n\n\n## :hugs:贡献代码:hugs:\n\n我们非常欢迎您为X2Paddle贡献代码或者提供使用建议:\n- 如果您可以修复某个issue或者增加一个新功能，欢迎给我们提交Pull Requests\n- 可以使用[开发镜像](./docker)：[paddlepaddle/x2paddle:latest-dev-cuda11.2-cudnn8-gcc82](https://hub.docker.com/r/paddlepaddle/x2paddle/tags)，国内镜像下载地址：https://x2paddle.bj.bcebos.com/Docker/latest-dev-cuda11.2-cudnn8-gcc82.tar\n- 如果有PyTorch训练项目转换需求欢迎随时提issue\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPaddlePaddle%2FX2Paddle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPaddlePaddle%2FX2Paddle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPaddlePaddle%2FX2Paddle/lists"}