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
Mashiro d68fd5a654
[Docs] Add docs for OptimWrapper (#411) 
* add optimizer wrapper docs

* remove optimizer.md

* minor refine

* Fix as comment

* minor refine

* tmp save ipynb

* add default constructor docs

* remove ipynb

* fix as comment

* remove color charactor

* fix as comment
2022-08-28 17:11:58 +08:00
..
en
[Docs] Add visualizer docs (#418)
2022-08-26 10:01:04 +08:00
zh_cn
[Docs] Add docs for OptimWrapper (#411)
2022-08-28 17:11:58 +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