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
Qian Zhao bcbfa20c8b [Doc] Add dataset & dataloader tutorial (#696) 
* dataset tutorial abstract

* complete dataloader & dataset tutorial

* minor fix

* minor fix

* resolve comments

* rename some link to be more specific

* add warning to manually constructed sampler

* fix as comments
2022-12-06 17:22:02 +08:00
..
en
[Doc] Add cross library en doc (#703)
2022-12-06 17:22:02 +08:00
resources/config
[Docs] Refine config docs. (#432)
2022-08-30 18:39:19 +08:00
zh_cn
[Doc] Add dataset & dataloader tutorial (#696)
2022-12-06 17:22:02 +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