Unverified Commit d068af81 authored by ver217's avatar ver217 Committed by GitHub
Browse files

[doc] update rst and docstring (#1351)

* update rst

* add zero docstr

* fix docstr

* remove fx.tracer.meta_patch

* fix docstr

* fix docstr

* update fx rst

* fix fx docstr

* remove useless rst
parent 274c1a3b
colossalai.cli.launcher.hostinfo
================================
.. automodule:: colossalai.cli.launcher.hostinfo
:members:
colossalai.cli.launcher.multinode\_runner
=========================================
.. automodule:: colossalai.cli.launcher.multinode_runner
:members:
colossalai.cli.launcher
=======================
.. automodule:: colossalai.cli.launcher
:members:
.. toctree::
:maxdepth: 2
colossalai.cli.launcher.hostinfo
colossalai.cli.launcher.multinode_runner
colossalai.cli.launcher.run
colossalai.builder.pipeline
colossalai.cli.launcher.run
===========================
.. automodule:: colossalai.builder.pipeline
.. automodule:: colossalai.cli.launcher.run
:members:
colossalai.cli
==============
.. automodule:: colossalai.cli
:members:
.. toctree::
:maxdepth: 2
colossalai.cli.benchmark
colossalai.cli.check
colossalai.cli.launcher
.. toctree::
:maxdepth: 2
colossalai.cli.cli
colossalai.utils.profiler.pcie\_profiler
colossalai.engine.gradient\_accumulation
========================================
.. automodule:: colossalai.utils.profiler.pcie_profiler
.. automodule:: colossalai.engine.gradient_accumulation
:members:
......@@ -3,3 +3,9 @@ colossalai.engine.gradient\_handler
.. automodule:: colossalai.engine.gradient_handler
:members:
.. toctree::
:maxdepth: 2
colossalai.engine.gradient_handler.utils
colossalai.engine.gradient\_handler.utils
=========================================
.. automodule:: colossalai.engine.gradient_handler.utils
:members:
......@@ -7,6 +7,6 @@ colossalai.engine
.. toctree::
:maxdepth: 2
colossalai.engine.gradient_accumulation
colossalai.engine.gradient_handler
colossalai.gemini.ophooks
colossalai.engine.schedule
colossalai.utils.memory\_utils.memory\_monitor
colossalai.fx.passes.adding\_split\_node\_pass
==============================================
.. automodule:: colossalai.utils.memory_utils.memory_monitor
.. automodule:: colossalai.fx.passes.adding_split_node_pass
:members:
colossalai.utils.profiler.prof\_utils
colossalai.fx.passes.meta\_info\_prop
=====================================
.. automodule:: colossalai.utils.profiler.prof_utils
.. automodule:: colossalai.fx.passes.meta_info_prop
:members:
colossalai.fx.passes
====================
.. automodule:: colossalai.fx.passes
:members:
.. toctree::
:maxdepth: 2
colossalai.fx.passes.adding_split_node_pass
colossalai.fx.passes.meta_info_prop
colossalai.fx.passes.shard_1d_pass
colossalai.fx.passes.split_module
colossalai.fx.passes.utils
colossalai.gemini.ophooks.zero\_hook
colossalai.fx.passes.shard\_1d\_pass
====================================
.. automodule:: colossalai.gemini.ophooks.zero_hook
.. automodule:: colossalai.fx.passes.shard_1d_pass
:members:
colossalai.fx.passes.split\_module
==================================
.. automodule:: colossalai.fx.passes.split_module
:members:
colossalai.fx.passes.utils
==========================
.. automodule:: colossalai.fx.passes.utils
:members:
colossalai.fx.proxy
===================
.. automodule:: colossalai.fx.proxy
:members:
colossalai.fx
=============
.. automodule:: colossalai.fx
:members:
.. toctree::
:maxdepth: 2
colossalai.fx.passes
colossalai.fx.tracer
.. toctree::
:maxdepth: 2
colossalai.fx.proxy
colossalai.fx.tracer
====================
.. automodule:: colossalai.fx.tracer
:members:
.. toctree::
:maxdepth: 2
colossalai.fx.tracer.tracer
colossalai.fx.tracer.tracer
===========================
.. automodule:: colossalai.fx.tracer.tracer
:members:
colossalai.gemini.chunk
=======================
.. automodule:: colossalai.gemini.chunk
:members:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment