mirrors/mmengine
1
0
Fork 0
mirror of https://github.com/open-mmlab/mmengine.git synced 2025-06-03 21:54:44 +08:00
Code Issues Projects Releases Wiki Activity
mmengine/docs
History
Ma Zerun 89b56b240a
[Doc]: Add mmengine demo and do some modifications for it. (#363) 
* Update demo in get started tutorial

* Update demo tutorial

* Refactor the pytorch demo

* Add outline and titles to the demo tutorial.

* Move file and change title

* Add shuffle in dataloader arguments.

* Improve according to comments
2022-08-29 16:19:11 +08:00
..
en
[Docs] Add visualizer docs (#418)
2022-08-26 10:01:04 +08:00
zh_cn
[Doc]: Add mmengine demo and do some modifications for it. (#363)
2022-08-29 16:19:11 +08:00
README.md
[Doc]: fix typo in installation command (#433)
2022-08-16 15:42:27 +08:00

README.md

Build Documentation

  1. Clone MMEngine

    git clone https://github.com/open-mmlab/mmengine.git
cd mmegnine

  2. Install the building dependencies of documentation

    pip install -r requirements/docs.txt

  3. Change directory to docs/en or docs/zh_cn

    cd docs/en  # or docs/zh_cn

  4. Build documentation

    make html

  5. Open _build/html/index.html with browser