Skip to content
/ docs Public

The repository provides docs & api & tutorials & FAQ and all things like that.

Notifications You must be signed in to change notification settings

Ascend/docs

Repository files navigation

The documentation of Ascend NPU for PyTorch(torch_npu)

This repository is a collection of documentation, api and stuff like that for torch_npu (Ascend NPU for PyTorch).

Contributing

If you are interested in the project, please feel free to contribute it.

We use sphinx and rst file to create docs and you need to refer to rst syntax for help. Here is how you can create a new docs:

  1. Create a rst file. You can put it anywhere, but it must be better to classify it.
  2. Add the rst into the index.rst

Building locally

When the development is ready, you can check and test it locally by following the directives below:

  1. Install the required dependencies:
pip install -r requirements.txt
  1. Building:
make html
  1. Server on localhost:
python -m http.server -d _build/html 4000

Then open localhost:4000 in your browser.