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.gemini.chunk\_mgr
============================
.. automodule:: colossalai.gemini.chunk_mgr
:members:
colossalai.gemini.gemini\_context
=================================
.. automodule:: colossalai.gemini.gemini_context
:members:
colossalai.gemini.gemini\_mgr
=============================
.. automodule:: colossalai.gemini.gemini_mgr
:members:
colossalai.utils.memory\_tracer.async\_memtracer colossalai.gemini.memory\_tracer.memory\_monitor
================================================ ================================================
.. automodule:: colossalai.gemini.memory_tracer.async_memtracer .. automodule:: colossalai.gemini.memory_tracer.memory_monitor
:members: :members:
colossalai.utils.memory\_tracer.memstats\_collector colossalai.gemini.memory\_tracer.memstats\_collector
=================================================== ====================================================
.. automodule:: colossalai.gemini.memory_tracer.memstats_collector .. automodule:: colossalai.gemini.memory_tracer.memstats_collector
:members: :members:
colossalai.utils.memory\_tracer.model\_data\_memtracer colossalai.gemini.memory\_tracer.model\_data\_memtracer
====================================================== =======================================================
.. automodule:: colossalai.gemini.memory_tracer.model_data_memtracer .. automodule:: colossalai.gemini.memory_tracer.model_data_memtracer
:members: :members:
colossalai.utils.memory\_tracer colossalai.gemini.memory\_tracer
=============================== ================================
.. automodule:: colossalai.gemini.memory_tracer .. automodule:: colossalai.gemini.memory_tracer
:members: :members:
...@@ -8,6 +8,6 @@ colossalai.utils.memory\_tracer ...@@ -8,6 +8,6 @@ colossalai.utils.memory\_tracer
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
colossalai.gemini.memory_tracer.async_memtracer colossalai.gemini.memory_tracer.memory_monitor
colossalai.gemini.memory_tracer.memstats_collector colossalai.gemini.memory_tracer.memstats_collector
colossalai.gemini.memory_tracer.model_data_memtracer colossalai.gemini.memory_tracer.model_data_memtracer
...@@ -8,4 +8,4 @@ colossalai.gemini.ophooks ...@@ -8,4 +8,4 @@ colossalai.gemini.ophooks
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
colossalai.gemini.ophooks.zero_hook colossalai.gemini.ophooks.utils
colossalai.gemini.ophooks.utils
===============================
.. automodule:: colossalai.gemini.ophooks.utils
:members:
colossalai.gemini.paramhooks
============================
.. automodule:: colossalai.gemini.paramhooks
:members:
colossalai.gemini.placement\_policy
===================================
.. automodule:: colossalai.gemini.placement_policy
:members:
colossalai.gemini
=================
.. automodule:: colossalai.gemini
:members:
.. toctree::
:maxdepth: 2
colossalai.gemini.memory_tracer
colossalai.gemini.ophooks
colossalai.gemini.paramhooks
.. toctree::
:maxdepth: 2
colossalai.gemini.chunk
colossalai.gemini.chunk_mgr
colossalai.gemini.gemini_context
colossalai.gemini.gemini_mgr
colossalai.gemini.placement_policy
colossalai.gemini.stateful_tensor
colossalai.gemini.stateful_tensor_container
colossalai.gemini.stateful_tensor_mgr
colossalai.gemini.tensor_placement_policy
colossalai.gemini.tensor_utils
colossalai.gemini.stateful\_tensor
==================================
.. automodule:: colossalai.gemini.stateful_tensor
:members:
colossalai.gemini.stateful\_tensor\_container
=============================================
.. automodule:: colossalai.gemini.stateful_tensor_container
:members:
colossalai.nn.model.model\_from\_config colossalai.gemini.stateful\_tensor\_mgr
======================================= =======================================
.. automodule:: colossalai.nn.model.model_from_config .. automodule:: colossalai.gemini.stateful_tensor_mgr
:members: :members:
colossalai.nn.layer.wrapper.lambda\_wrapper colossalai.gemini.tensor\_placement\_policy
=========================================== ===========================================
.. automodule:: colossalai.nn.layer.wrapper.lambda_wrapper .. automodule:: colossalai.gemini.tensor_placement_policy
:members: :members:
colossalai.gemini.tensor\_utils
===============================
.. automodule:: colossalai.gemini.tensor_utils
:members:
colossalai.nn.graph.graph\_node
===============================
.. automodule:: colossalai.nn.graph.graph_node
:members:
colossalai.nn.model colossalai.nn.graph
=================== ===================
.. automodule:: colossalai.nn.model .. automodule:: colossalai.nn.graph
:members: :members:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
colossalai.nn.model.model_from_config colossalai.nn.graph.graph_node
colossalai.nn.graph.utils
colossalai.nn.graph.utils
=========================
.. automodule:: colossalai.nn.graph.utils
: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