.. MindTorch documentation master file, created by
   sphinx-quickstart on Thu Feb 29 19:55:52 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

欢迎使用MindTorch
=====================================

.. image:: docs/pic/MindTorch_LOGO.png
  :width: 40 %
  :align: center
  :target: https://openi.pcl.ac.cn/OpenI/MSAdapter

**文档版本:** |release|

MindTorch将PyTorch训练脚本高效迁移至MindSpore框架执行的工具，其目的是在不改变原有PyTorch用户的使用习惯情况下，使得PyTorch代码能在昇腾上获得高效性能。

.. image:: docs/pic/MSA_F.png
  :width: 80 %
  :align: center


- **PyTorch接口支持**： MindTorch目前支持大部分PyTorch常用接口适配。用户接口使用方式不变，基于MindSpore动态图或静态图模式下执行在昇腾算力平台上。可以在[torch接口支持列表](SupportedList.md)中查看接口支持情况。
- **TorchVision接口支持**： MindTorch TorchVision是迁移自PyTorch官方实现的计算机视觉工具库，延用PyTorch官方API设计与使用习惯，内部计算调用MindSpore算子，实现与torchvision原始库同等功能。可以在[TorchVision接口支持列表](TorchVision_SupportedList.md)中查看接口支持情况。

.. note::
   如果你在线阅读文档时遇到问题，可以在`MSAdapter`上下载仓库，
   然后转到`readthedocs/build_zh/html/index.html`来离线阅读文档。
   ``build_zh``文件夹可以在``/doc/readthedocs/``中使用``make html``生成.

用户指南
--------------------
MindTorch用户指南解释了如何安装MindSpore,MindTorch、版本配套、使用MindTorch例子，以及如何作为开发人员为库做出贡献。

.. toctree::
   :maxdepth: 2
   :glob:
   :caption: MindTorch用户指南

   docs/Version_Match.md
   docs/Install.md

.. toctree::
   :glob:
   :maxdepth: 2

   docs/User_Guide_Env.md

.. toctree::
   :glob:
   :maxdepth: 2

   docs/examples.rst

.. toctree::
   :glob:
   :maxdepth: 2

   docs/CONTRIBUTING_CN.md

.. toctree::
   :glob:
   :maxdepth: 2

   docs/FAQ.md

入门
--------------------
MindTorch入门指南介绍了如何使用MindTorch，微分接口、优化器和学习率、分布式适配，混合精度训练，以及模型保存和加载。

.. toctree::
   :glob:
   :maxdepth: 2
   :caption: MindTorch入门

   docs/User_Guide_Begin.md
   docs/User_Guide_Import.md
   docs/User_Guide_Grad.md
   docs/User_Guide_Optim.md
   docs/User_Guide_Mixed.md
   docs/User_Guide_Dist.md
   docs/User_Guide_Load.md
   docs/User_Guide_Adapter.md

进阶
--------------------
MindTorch进阶指南介绍了如何使用MindTorch进行静态图加速以及结合MindSpore框架并行训练。

.. toctree::
   :glob:
   :maxdepth: 2
   :caption: MindTorch进阶

   docs/User_Guide_Advanced.md

MindTorch调试调优介绍了如何使用MindTorch进行精度调优和性能调优。

.. toctree::
   :glob:
   :maxdepth: 2
   :caption: MindTorch调试调优

   docs/Debugging.md
   docs/Tuning_Accuracy.md
   docs/Tuning_Performance.md

API
--------------------
MindTorch API详细列出了和PyTorch API功能的对比。

.. toctree::
   :glob:
   :maxdepth: 2
   :caption: MindTorch API

   docs/SupportedList.md
   docs/TorchVision_SupportedList.md
   docs/ConstraintList.md