mirrors
/
mmengine
mirror of https://github.com/open-mmlab/mmengine.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mmengine/docs
History
Alexander Pacha 1aa14b45a0
[Enhancement] Enable timeout in dist training (#877) 
* Adding missing pre-commit requirement to tests.txt

* Added support for setting a timeout for distributed learning

* Adding documentation about how to change the runtime timeout into the distributed manual.

* Fixed type in documentation to correctly specify an integer

* Removing type-cast after checking the correct type already before

* Update mmengine/dist/utils.py

Adding an explicit `is not None` to the check

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Removing explicit type check and replacing it with more pythonic way of assuming it is the right type and handling the exception if the type doesn't match.

* Removing pre-commit from test requirements again

* Simplified the code according to suggestions from PR

* Update distributed.md

---------

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
 		2023-02-03 15:40:39 +08:00
..
en [Enhancement] Enable timeout in dist training (#877) 2023-02-03 15:40:39 +08:00
resources/config [Enhance] Substitute the environment variable in config file (#744) 2023-02-01 10:16:47 +08:00
zh_cn [Enhance] Substitute the environment variable in config file (#744) 2023-02-01 10:16:47 +08:00
README.md [Docs] fix typo (#841) 2022-12-20 15:45:15 +08:00

README.md

Build Documentation

  1. Clone MMEngine

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

  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