# mindtorch_tmp

**Repository Path**: fan-jibin/mindtorch_tmp

## Basic Information

- **Project Name**: mindtorch_tmp
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: release_0.2
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-29
- **Last Updated**: 2023-11-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MSAdapter

简体中文 | [English](README_en.md)

MSAdapter是一款MindSpore生态适配工具，在不改变用户原有使用习惯下，将PyTorch/JAX等三方框架代码快速迁移到MindSpore生态上，帮助用户高效使用中国算力网——智算网络的昇腾算力。

## MindTorch
### 简介

MindTorch是将PyTorch训练脚本高效迁移至MindSpore框架执行的工具，其目的是在不改变原有PyTorch用户的使用习惯情况下，使得PyTorch代码能在昇腾上获得高效性能。
<p align="center"><img src="doc/torch/pic/MSA_F.png" width="580"\></p>


- **PyTorch接口支持**： MindTorch的目的是支持PyTorch语法的原生态表达，用户只需要将PyTorch源代码中```import torch```替换为```import mindtorch.torch```即可实现模型能支持昇腾上训练。模型中所使用的高阶APIs支持状态可以从这里找到 [Supported List](doc/torch/SupportedList.md)。
- **PyTorch接口支持范围**： MindTorch目前主要适配PyTorch的数据处理和模型结构部分代码，目前完全支持MindSpore的动态图模式下训练，部分网络结构支持静态图模式训练。
- **TorchVision接口支持**： MindTorch TorchVision是迁移自PyTorch官方实现的计算机视觉工具库，延用PyTorch官方api设计与使用习惯，内部计算调用MindSpore算子，实现与torchvision原始库同等功能。用户只需要将PyTorch源代码中```import torchvision```替换为```import mindtorch.torchvision```即可。TorchVision支持状态可以从这里找到 [TorchVision Supported List](mindtorch/torchvision/TorchVision_SupportedList.md)。

### 安装
首先查看[版本说明](#版本说明)选择所需的MindTorch和MindSpore版本。

#### 安装MindSpore
请根据MindSpore官网[安装指南](https://www.mindspore.cn/install)进行安装。


#### 安装MindTorch
##### 通过pip安装
```bash
pip install mindtorch (MindSpore版本 >= 2.2.1)
```
或
```bash
pip install msadapter (MindSpore版本 == 2.0.0)
```

##### 通过源码安装
```bash
 git clone https://git.openi.org.cn/OpenI/MSAdapter.git
 cd MSAdapter
 python setup.py install
```
如果出现权限不足的提示，请按照如下方式安装：
```bash
 python setup.py install --user || exit 1
```
### 使用
参考[MindTorch用户使用指南](doc/torch/USER_GUIDE.md)，您将快速入门完成PyTorch原生代码的迁移，以及上手各种进阶优化手段；如果您有对精度和性能调优的需求可参考[MindTorch调试调优指南](doc/torch/Debugging_and_Tuning.md)。

### 资源
- 模型库：MindTorch支持丰富的深度学习应用，这里给出了从PyTorch官方代码迁移到MindTorch的模型：[已验证模型资源](https://git.openi.org.cn/OpenI/MSAdapterModelZoo)。

### 版本说明

| **分支名** | **发布版本**  | **发布时间**          | **配套MindSpore版本**        | 启智算力资源 |
|--------------|----------------|--------------------|-------------------------|------------------------------------------------|
| **master** | -    | -           |  [MindSpore 2.3.0](https://www.mindspore.cn/install) | - |
| **release_0.2** | 0.2    | -           |  [MindSpore 2.2.1](https://www.mindspore.cn/install) | - |
| **release_0.1** | 0.1    | 2023-06-15           |  [MindSpore 2.0.0](https://www.mindspore.cn/install) | [智算网络集群](https://openi.pcl.ac.cn/OpenI/MSAdapter/grampus/notebook/create?type=1) - 镜像：mindspore2.0.0_cann6.3_notebook |


- MindTorch已发布版本获取请参阅[RELEASE](https://openi.pcl.ac.cn/OpenI/MSAdapter/releases)。
- MindSpore版本推荐从[MindSpore官网](https://www.mindspore.cn/versions)获取，或者从启智平台[数据资源](https://openi.pcl.ac.cn/OpenI/MSAdapter/datasets)中获取。

*中间版本：*

- 适用于MindSpore 2.2.1，且用户脚本中仍使用导入“msadapter”包名（安装包名已由”msadapter“更名为”mindtorch“，建议使用[工具](mindtorch/tools/replace_import_msadapter_to_mindtorch.sh)一键切换到“mindtorch”）:
`pip install git+https://openi.pcl.ac.cn/OpenI/MSAdapter.git@da13b6719c`
- 适用于MindSpore 2.1.0:
`pip install git+https://openi.pcl.ac.cn/OpenI/MSAdapter.git@59f62a1858`

### 正在进行的工作
- 支持torch自动微分接口。
- 支持torch分布式接口。
- 网络性能优化。


## 贡献
欢迎开发者参与贡献。更多详情，请参阅我们的[贡献指南](doc/common/CONTRIBUTING_CN.md).

## 加入我们
如果您在使用时有任何问题或建议，欢迎加入MSAdapter SIG参与讨论。
<p align="leaf"><img src="doc/common/pic/MSA_SIG.png" width="580"\></p>

## 许可证
[Apache License 2.0](https://openi.pcl.ac.cn/OpenI/MSAdapter/src/branch/master/LICENSE)