mmengine/docs
Yining Li 1323251c02 [Doc] Refine evaluation docs (#701)
* refine evaluation docs

* fix link

* Update docs/zh_cn/design/evaluation.md

Co-authored-by: Qian Zhao <112053249+C1rN09@users.noreply.github.com>

* Update docs/zh_cn/tutorials/evaluation.md

Co-authored-by: RangiLyu <lyuchqi@gmail.com>

* Update docs/zh_cn/tutorials/evaluation.md

Co-authored-by: RangiLyu <lyuchqi@gmail.com>

* resolve comments

* Apply suggestions from code review

* Update docs/zh_cn/tutorials/evaluation.md

Co-authored-by: Qian Zhao <112053249+C1rN09@users.noreply.github.com>
Co-authored-by: RangiLyu <lyuchqi@gmail.com>
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-12-06 17:22:02 +08:00
..
en [Docs] Translate distributed documentation (#712) 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] Refine evaluation docs (#701) 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