de68cc5007
docs(doc/code-docs): add figure for training docs ( #307 )
...
* add training image for docs
* docs(doc/code-docs): add training img for en doc
* docs(doc/code-docs): fix en docs for initialize
* docs(doc/code-docs): update conf file for readthedocs
* docs(doc/code-docs): fix typos
* docs(doc/code-docs): fix typos for reathedocs
* docs(doc/code-docs): minor typo fix for reathedocs
* docs(doc/code-docs): fix readthedocs conf file
* docs(doc/code-docs): update training image
* docs(doc/code-docs): fix typos
* docs(doc/code-docs): update training image
* docs(doc/code-docs): move training image to section initialize
* docs(doc/code-docs): fix lint
* add badge about reathedocs status
2023-09-15 15:22:22 +08:00
06807a6fd5
docs(doc/code-docs): refine profiler docs ( #295 )
...
* add detailed profiler guide
* added torch profiler detailed docs
* add english docs for profiler page
* docs(code-docs/source/profiler.rst): resize profiler trace image
* docs(code-docs/source/profiler.rst): fix typo
* docs(doc/imgs/torch_profiler_trace.png): update trace image
2023-09-08 16:58:36 +08:00
b6d909d43e
docs(*): add documentation and reST files for readthedocs ( #272 )
...
* add initial reST files for readthedocs
* fix typos
* docs refine and minor fix
* add references for parallel training section
* fix reST format
* fix reST format
* fix reST format
* add comments for trainer API
* add link to step-by-step quickstart guide
* docs(code-docs/source/parallel.rst): add paper link url
* docs(code-docs/source/parallel.rst): add paper link url
* use MyST to render markdown
* docs(code-docs/source/initialize.rst): update model init
* add requirements for myst-parser
* reuse install and usage markdown
* docs(code-docs/source/index.rst): add example and q&a
* docs(doc/code-docs/*): docs refine
* docs(code-docs/source/parallel.rst): update docs for zero config
* docs(code-docs/source/example.rst): fix typos for example.rst
* docs(code-docs/source/example.rst): refine docs
* docs(code-docs/source/example): update example
* docs(code-docs/source/example): delete useless example
* docs(code-docs/source/*): fix image display issue
* docs(code-docs/source/parallel.rst): add docs for communication overlap
* docs(code-docs/source/conf.py): update conf.py
* docs(code-docs/source/example): update example 30B demo
* docs(code-docs/source/parallel.rst): update pipeline parallel
* docs(code-docs/source/parallel.rst): update pipeline parallel
* docs(code-docs/source/parallel.rst): update pipeline parallel
* docs(code-docs/source/parallel.rst): update pipeline parallel
* docs(code-docs/source/parallel.rst): update ZeRO1.5
* docs(code-docs/source/parallel.rst): update ZeRO1.5
* docs(code-docs/source): fix word spelling error
---------
Co-authored-by: huangting4201 <huangting3@sensetime.com>
2023-09-06 15:36:03 +08:00
fa7337b37b
initial commit
2023-07-06 12:55:23 +08:00
Season