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
...@@ -8,5 +8,4 @@ colossalai.nn.layer.wrapper ...@@ -8,5 +8,4 @@ colossalai.nn.layer.wrapper
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
colossalai.nn.layer.wrapper.lambda_wrapper
colossalai.nn.layer.wrapper.pipeline_wrapper colossalai.nn.layer.wrapper.pipeline_wrapper
...@@ -16,3 +16,4 @@ colossalai.nn.optimizer ...@@ -16,3 +16,4 @@ colossalai.nn.optimizer
colossalai.nn.optimizer.hybrid_adam colossalai.nn.optimizer.hybrid_adam
colossalai.nn.optimizer.lamb colossalai.nn.optimizer.lamb
colossalai.nn.optimizer.lars colossalai.nn.optimizer.lars
colossalai.nn.optimizer.utils
colossalai.nn.optimizer.utils
=============================
.. automodule:: colossalai.nn.optimizer.utils
:members:
colossalai.nn.parallel.data\_parallel
=====================================
.. automodule:: colossalai.nn.parallel.data_parallel
:members:
colossalai.nn.parallel.layers.colo\_module
==========================================
.. automodule:: colossalai.nn.parallel.layers.colo_module
:members:
colossalai.utils.profiler.mem\_profiler colossalai.nn.parallel.layers.embedding
======================================= =======================================
.. automodule:: colossalai.utils.profiler.mem_profiler .. automodule:: colossalai.nn.parallel.layers.embedding
:members: :members:
colossalai.nn.parallel.layers.linear
====================================
.. automodule:: colossalai.nn.parallel.layers.linear
:members:
colossalai.nn.parallel.layers.module\_utils
===========================================
.. automodule:: colossalai.nn.parallel.layers.module_utils
:members:
colossalai.nn.parallel.layers
=============================
.. automodule:: colossalai.nn.parallel.layers
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.parallel.layers.colo_module
colossalai.nn.parallel.layers.embedding
colossalai.nn.parallel.layers.linear
colossalai.nn.parallel.layers.module_utils
colossalai.nn.parallel.reducer
==============================
.. automodule:: colossalai.nn.parallel.reducer
:members:
colossalai.nn.parallel
======================
.. automodule:: colossalai.nn.parallel
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.parallel.layers
.. toctree::
:maxdepth: 2
colossalai.nn.parallel.data_parallel
colossalai.nn.parallel.reducer
...@@ -7,12 +7,13 @@ colossalai.nn ...@@ -7,12 +7,13 @@ colossalai.nn
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
colossalai.nn.graph
colossalai.nn.layer colossalai.nn.layer
colossalai.nn.loss colossalai.nn.loss
colossalai.nn.lr_scheduler colossalai.nn.lr_scheduler
colossalai.nn.metric colossalai.nn.metric
colossalai.nn.model
colossalai.nn.optimizer colossalai.nn.optimizer
colossalai.nn.parallel
.. toctree:: .. toctree::
......
colossalai.pipeline.layer\_sepc
===============================
.. automodule:: colossalai.pipeline.layer_sepc
:members:
colossalai.pipeline.pipelinable
===============================
.. automodule:: colossalai.pipeline.pipelinable
:members:
colossalai.pipeline
===================
.. automodule:: colossalai.pipeline
:members:
.. toctree::
:maxdepth: 2
colossalai.pipeline.layer_sepc
colossalai.pipeline.pipelinable
colossalai.pipeline.utils
colossalai.pipeline.utils
=========================
.. automodule:: colossalai.pipeline.utils
:members:
colossalai colossalai
========== ==========
.. automodule:: colossalai
:members:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
colossalai.amp colossalai.amp
colossalai.builder colossalai.builder
colossalai.cli
colossalai.communication colossalai.communication
colossalai.context colossalai.context
colossalai.engine colossalai.engine
colossalai.fx
colossalai.gemini
colossalai.kernel colossalai.kernel
colossalai.logging colossalai.logging
colossalai.nn colossalai.nn
colossalai.pipeline
colossalai.registry colossalai.registry
colossalai.tensor
colossalai.testing colossalai.testing
colossalai.trainer colossalai.trainer
colossalai.utils colossalai.utils
...@@ -22,4 +30,7 @@ colossalai ...@@ -22,4 +30,7 @@ colossalai
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
colossalai.constants
colossalai.core
colossalai.global_variables
colossalai.initialize colossalai.initialize
colossalai.tensor.colo\_parameter
=================================
.. automodule:: colossalai.tensor.colo_parameter
:members:
colossalai.tensor.colo\_tensor
==============================
.. automodule:: colossalai.tensor.colo_tensor
:members:
colossalai.tensor.compute\_spec
===============================
.. automodule:: colossalai.tensor.compute_spec
: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