update rst (#615)

pull/616/head
ver217 2022-04-01 15:46:38 +08:00 committed by GitHub
parent 93f14d2a33
commit f69507dd22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
97 changed files with 490 additions and 127 deletions

View File

@ -0,0 +1,5 @@
colossalai.amp.apex\_amp.apex\_amp
==================================
.. automodule:: colossalai.amp.apex_amp.apex_amp
:members:

View File

@ -3,3 +3,9 @@ colossalai.amp.apex\_amp
.. automodule:: colossalai.amp.apex_amp
:members:
.. toctree::
:maxdepth: 2
colossalai.amp.apex_amp.apex_amp

View File

@ -0,0 +1,5 @@
colossalai.amp.naive\_amp.naive\_amp
====================================
.. automodule:: colossalai.amp.naive_amp.naive_amp
:members:

View File

@ -3,3 +3,9 @@ colossalai.amp.naive\_amp
.. automodule:: colossalai.amp.naive_amp
:members:
.. toctree::
:maxdepth: 2
colossalai.amp.naive_amp.naive_amp

View File

@ -1,7 +1,8 @@
colossalai.amp
==============
*This module contains different amp models and optimizers.*
.. automodule:: colossalai.amp
:members:
.. toctree::
:maxdepth: 2
@ -15,6 +16,3 @@ colossalai.amp
:maxdepth: 2
colossalai.amp.amp_type
.. automodule:: colossalai.amp
:members: convert_to_amp

View File

@ -2,4 +2,10 @@ colossalai.amp.torch\_amp
=========================
.. automodule:: colossalai.amp.torch_amp
:members:
:members:
.. toctree::
:maxdepth: 2
colossalai.amp.torch_amp.torch_amp

View File

@ -0,0 +1,5 @@
colossalai.amp.torch\_amp.torch\_amp
====================================
.. automodule:: colossalai.amp.torch_amp.torch_amp
:members:

View File

@ -1,8 +1,9 @@
colossalai.builder
==================
*This module contains different methods to build* ``schedule``, ``model``, ``optimizer``,
``layers`` *and other important classes.*
.. automodule:: colossalai.builder
:members:
.. toctree::
:maxdepth: 2

View File

@ -1,7 +1,9 @@
colossalai.communication
========================
*This module contains different methods for communication in parallel training.*
.. automodule:: colossalai.communication
:members:
.. toctree::
:maxdepth: 2

View File

@ -0,0 +1,5 @@
colossalai.constants
====================
.. automodule:: colossalai.constants
:members:

View File

@ -1,5 +1,5 @@
colossalai.context.moe\_context
====================================
===============================
.. automodule:: colossalai.context.moe_context
:members:
:members:

View File

@ -2,4 +2,4 @@ colossalai.context.process\_group\_initializer.initializer\_2d
==============================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_2d
:members: Initializer_2D_Row, Initializer_2D_Col
:members:

View File

@ -2,4 +2,4 @@ colossalai.context.process\_group\_initializer.initializer\_2p5d
================================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_2p5d
:members: Initializer_2p5D_ROW, Initializer_2p5D_Col, Initializer_2p5D_Dep, Initializer_2p5D_XZ
:members:

View File

@ -2,4 +2,4 @@ colossalai.context.process\_group\_initializer.initializer\_3d
==============================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_3d
:members: Initializer_3D_Input, Initializer_3D_Weight, Initializer_3D_Output
:members:

View File

@ -2,4 +2,4 @@ colossalai.context.process\_group\_initializer.initializer\_sequence
====================================================================
.. automodule:: colossalai.context.process_group_initializer.initializer_sequence
:members: Initializer_Sequence_DP
:members:

View File

@ -14,7 +14,6 @@ colossalai.context.process\_group\_initializer
colossalai.context.process_group_initializer.initializer_3d
colossalai.context.process_group_initializer.initializer_data
colossalai.context.process_group_initializer.initializer_model
colossalai.context.process_group_initializer.initializer_moe
colossalai.context.process_group_initializer.initializer_pipeline
colossalai.context.process_group_initializer.initializer_sequence
colossalai.context.process_group_initializer.initializer_tensor

View File

@ -1,8 +1,8 @@
colossalai.context
==================
*This module is serving for receiving and passing user's configuration to all devices to
initialize and construct parallel training.*
.. automodule:: colossalai.context
:members:
.. toctree::
:maxdepth: 2
@ -15,9 +15,7 @@ initialize and construct parallel training.*
:maxdepth: 2
colossalai.context.config
colossalai.context.parallel_context
colossalai.context.moe_context
colossalai.context.parallel_context
colossalai.context.parallel_mode
.. automodule:: colossalai.context
:members:
colossalai.context.singleton_meta

View File

@ -0,0 +1,5 @@
colossalai.context.singleton\_meta
==================================
.. automodule:: colossalai.context.singleton_meta
:members:

View File

@ -0,0 +1,5 @@
colossalai.core
===============
.. automodule:: colossalai.core
:members:

View File

@ -1,5 +1,11 @@
colossalai.engine.ophooks
===========================
=========================
.. automodule:: colossalai.engine.ophooks
:members:
.. toctree::
:maxdepth: 2
colossalai.engine.ophooks.zero_hook

View File

@ -0,0 +1,5 @@
colossalai.engine.ophooks.zero\_hook
====================================
.. automodule:: colossalai.engine.ophooks.zero_hook
:members:

View File

@ -1,5 +0,0 @@
colossalai.engine.paramhooks
==============================
.. automodule:: colossalai.engine.paramhooks
:members:

View File

@ -8,6 +8,5 @@ colossalai.engine
:maxdepth: 2
colossalai.engine.gradient_handler
colossalai.engine.schedule
colossalai.engine.ophooks
colossalai.engine.paramhooks
colossalai.engine.schedule

View File

@ -0,0 +1,5 @@
colossalai.global\_variables
============================
.. automodule:: colossalai.global_variables
:members:

View File

@ -0,0 +1,5 @@
colossalai.logging.logger
=========================
.. automodule:: colossalai.logging.logger
:members:

View File

@ -3,3 +3,9 @@ colossalai.logging
.. automodule:: colossalai.logging
:members:
.. toctree::
:maxdepth: 2
colossalai.logging.logger

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.colossalai\_layer.dropout
=============================================
.. automodule:: colossalai.nn.layer.colossalai_layer.dropout
:members:

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.colossalai\_layer.embedding
===============================================
.. automodule:: colossalai.nn.layer.colossalai_layer.embedding
:members:

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.colossalai\_layer.linear
============================================
.. automodule:: colossalai.nn.layer.colossalai_layer.linear
:members:

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.colossalai\_layer.normalization
===================================================
.. automodule:: colossalai.nn.layer.colossalai_layer.normalization
:members:

View File

@ -3,3 +3,12 @@ colossalai.nn.layer.colossalai\_layer
.. automodule:: colossalai.nn.layer.colossalai_layer
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.layer.colossalai_layer.dropout
colossalai.nn.layer.colossalai_layer.embedding
colossalai.nn.layer.colossalai_layer.linear
colossalai.nn.layer.colossalai_layer.normalization

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.moe.experts
===============================
.. automodule:: colossalai.nn.layer.moe.experts
:members:

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.moe.layers
==============================
.. automodule:: colossalai.nn.layer.moe.layers
:members:

View File

@ -3,3 +3,11 @@ colossalai.nn.layer.moe
.. automodule:: colossalai.nn.layer.moe
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.layer.moe.experts
colossalai.nn.layer.moe.layers
colossalai.nn.layer.moe.utils

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.moe.utils
=============================
.. automodule:: colossalai.nn.layer.moe.utils
:members:

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.parallel\_1d.layers
=======================================
.. automodule:: colossalai.nn.layer.parallel_1d.layers
:members:

View File

@ -3,3 +3,9 @@ colossalai.nn.layer.parallel\_1d
.. automodule:: colossalai.nn.layer.parallel_1d
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.layer.parallel_1d.layers

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.parallel\_2d.layers
=======================================
.. automodule:: colossalai.nn.layer.parallel_2d.layers
:members:

View File

@ -2,4 +2,10 @@ colossalai.nn.layer.parallel\_2d
================================
.. automodule:: colossalai.nn.layer.parallel_2d
:members:
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.layer.parallel_2d.layers

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.parallel\_2p5d.layers
=========================================
.. automodule:: colossalai.nn.layer.parallel_2p5d.layers
:members:

View File

@ -3,3 +3,9 @@ colossalai.nn.layer.parallel\_2p5d
.. automodule:: colossalai.nn.layer.parallel_2p5d
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.layer.parallel_2p5d.layers

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.parallel\_3d.layers
=======================================
.. automodule:: colossalai.nn.layer.parallel_3d.layers
:members:

View File

@ -3,3 +3,9 @@ colossalai.nn.layer.parallel\_3d
.. automodule:: colossalai.nn.layer.parallel_3d
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.layer.parallel_3d.layers

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.parallel\_sequence.layers
=============================================
.. automodule:: colossalai.nn.layer.parallel_sequence.layers
:members:

View File

@ -3,3 +3,9 @@ colossalai.nn.layer.parallel\_sequence
.. automodule:: colossalai.nn.layer.parallel_sequence
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.layer.parallel_sequence.layers

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.utils.common
================================
.. automodule:: colossalai.nn.layer.utils.common
:members:

View File

@ -3,3 +3,9 @@ colossalai.nn.layer.utils
.. automodule:: colossalai.nn.layer.utils
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.layer.utils.common

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.vanilla.layers
==================================
.. automodule:: colossalai.nn.layer.vanilla.layers
:members:

View File

@ -3,3 +3,9 @@ colossalai.nn.layer.vanilla
.. automodule:: colossalai.nn.layer.vanilla
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.layer.vanilla.layers

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.wrapper.lambda\_wrapper
===========================================
.. automodule:: colossalai.nn.layer.wrapper.lambda_wrapper
:members:

View File

@ -0,0 +1,5 @@
colossalai.nn.layer.wrapper.pipeline\_wrapper
=============================================
.. automodule:: colossalai.nn.layer.wrapper.pipeline_wrapper
:members:

View File

@ -3,3 +3,10 @@ colossalai.nn.layer.wrapper
.. automodule:: colossalai.nn.layer.wrapper
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.layer.wrapper.lambda_wrapper
colossalai.nn.layer.wrapper.pipeline_wrapper

View File

@ -1,6 +1,10 @@
colossalai.nn.lr\_scheduler
===========================
.. automodule:: colossalai.nn.lr_scheduler
:members:
.. toctree::
:maxdepth: 2

View File

@ -1,6 +1,10 @@
colossalai.nn.optimizer
=======================
.. automodule:: colossalai.nn.optimizer
:members:
.. toctree::
:maxdepth: 2

View File

@ -1,57 +1,21 @@
colossalai.nn
=============
*This part contains different colossalai layers for constructing your model.
You can easily use them as the way of using layers in torch.nn.*
*Now colossalai support layer types below:* ``Linear``, ``Classifier``, ``Embedding``,
``PatchEmbedding``, ``LayerNorm``, ``Dropout`` *for different parallelisms.*
.. automodule:: colossalai.nn
:members:
.. toctree::
:maxdepth: 2
colossalai.nn.layer
*This part contains different loss functions for different parallelisms.*
.. toctree::
:maxdepth: 2
colossalai.nn.loss
*This part contains different learning rate schedules to control your learning rate
in training process*
.. toctree::
:maxdepth: 2
colossalai.nn.lr_scheduler
*This part contains different metric to measure performance of your model.*
.. toctree::
:maxdepth: 2
colossalai.nn.metric
*This part contains some colossalai optimizers*
.. toctree::
:maxdepth: 2
colossalai.nn.model
.. toctree::
:maxdepth: 2
colossalai.nn.optimizer
*This part contains different methods to initialize weights.*
.. toctree::
:maxdepth: 2
colossalai.nn.init
.. automodule:: colossalai.nn
:members:

View File

@ -1,4 +1,4 @@
Colossal-AI
colossalai
==========
.. toctree::
@ -23,6 +23,3 @@ Colossal-AI
:maxdepth: 2
colossalai.initialize
.. automodule:: colossalai
:members:

View File

@ -0,0 +1,5 @@
colossalai.testing.comparison
=============================
.. automodule:: colossalai.testing.comparison
:members:

View File

@ -1,5 +1,12 @@
colossalai.testing
========================
==================
.. automodule:: colossalai.testing
:members:
:members:
.. toctree::
:maxdepth: 2
colossalai.testing.comparison
colossalai.testing.utils

View File

@ -0,0 +1,5 @@
colossalai.testing.utils
========================
.. automodule:: colossalai.testing.utils
:members:

View File

@ -0,0 +1,5 @@
colossalai.utils.data\_sampler.base\_sampler
============================================
.. automodule:: colossalai.utils.data_sampler.base_sampler
:members:

View File

@ -0,0 +1,5 @@
colossalai.utils.data\_sampler.data\_parallel\_sampler
======================================================
.. automodule:: colossalai.utils.data_sampler.data_parallel_sampler
:members:

View File

@ -3,3 +3,10 @@ colossalai.utils.data\_sampler
.. automodule:: colossalai.utils.data_sampler
:members:
.. toctree::
:maxdepth: 2
colossalai.utils.data_sampler.base_sampler
colossalai.utils.data_sampler.data_parallel_sampler

View File

@ -0,0 +1,5 @@
colossalai.utils.memory\_tracer.async\_memtracer
================================================
.. automodule:: colossalai.utils.memory_tracer.async_memtracer
:members:

View File

@ -0,0 +1,5 @@
colossalai.utils.memory\_tracer.memstats\_collector
===================================================
.. automodule:: colossalai.utils.memory_tracer.memstats_collector
:members:

View File

@ -0,0 +1,5 @@
colossalai.utils.memory\_tracer.model\_data\_memtracer
======================================================
.. automodule:: colossalai.utils.memory_tracer.model_data_memtracer
:members:

View File

@ -1,5 +1,13 @@
colossalai.utils.memory\_tracer
=======================
===============================
.. automodule:: colossalai.utils.memory_tracer
:members:
:members:
.. toctree::
:maxdepth: 2
colossalai.utils.memory_tracer.async_memtracer
colossalai.utils.memory_tracer.memstats_collector
colossalai.utils.memory_tracer.model_data_memtracer

View File

@ -0,0 +1,5 @@
colossalai.utils.memory\_utils.memory\_monitor
==============================================
.. automodule:: colossalai.utils.memory_utils.memory_monitor
:members:

View File

@ -0,0 +1,12 @@
colossalai.utils.memory\_utils
==============================
.. automodule:: colossalai.utils.memory_utils
:members:
.. toctree::
:maxdepth: 2
colossalai.utils.memory_utils.memory_monitor
colossalai.utils.memory_utils.utils

View File

@ -0,0 +1,5 @@
colossalai.utils.memory\_utils.utils
====================================
.. automodule:: colossalai.utils.memory_utils.utils
:members:

View File

@ -1,5 +1,5 @@
colossalai.utils.moe
=======================
====================
.. automodule:: colossalai.utils.moe
:members:
:members:

View File

@ -0,0 +1,5 @@
colossalai.utils.profiler.comm\_profiler
========================================
.. automodule:: colossalai.utils.profiler.comm_profiler
:members:

View File

@ -0,0 +1,5 @@
colossalai.utils.profiler.mem\_profiler
=======================================
.. automodule:: colossalai.utils.profiler.mem_profiler
:members:

View File

@ -0,0 +1,5 @@
colossalai.utils.profiler.pcie\_profiler
========================================
.. automodule:: colossalai.utils.profiler.pcie_profiler
:members:

View File

@ -0,0 +1,5 @@
colossalai.utils.profiler.prof\_utils
=====================================
.. automodule:: colossalai.utils.profiler.prof_utils
:members:

View File

@ -1,5 +1,14 @@
colossalai.utils.profiler
=======================
=========================
.. automodule:: colossalai.utils.profiler
:members:
:members:
.. toctree::
:maxdepth: 2
colossalai.utils.profiler.comm_profiler
colossalai.utils.profiler.mem_profiler
colossalai.utils.profiler.pcie_profiler
colossalai.utils.profiler.prof_utils

View File

@ -1,7 +1,8 @@
colossalai.utils
================
*This part contains useful utils for colossalai*
.. automodule:: colossalai.utils
:members:
.. toctree::
:maxdepth: 2
@ -9,8 +10,9 @@ colossalai.utils
colossalai.utils.data_sampler
colossalai.utils.gradient_accumulation
colossalai.utils.memory_tracer
colossalai.utils.memory_utils
colossalai.utils.multi_tensor_apply
colossalai.utils.profile
colossalai.utils.profiler
colossalai.utils.tensor_detector
@ -21,6 +23,5 @@ colossalai.utils
colossalai.utils.checkpointing
colossalai.utils.common
colossalai.utils.cuda
colossalai.utils.memory
colossalai.utils.moe
colossalai.utils.timer

View File

@ -1,5 +1,11 @@
colossalai.utils.tensor\_detector
=======================
=================================
.. automodule:: colossalai.utils.tensor_detector.tensor_detector
:members:
.. automodule:: colossalai.utils.tensor_detector
:members:
.. toctree::
:maxdepth: 2
colossalai.utils.tensor_detector.tensor_detector

View File

@ -0,0 +1,5 @@
colossalai.utils.tensor\_detector.tensor\_detector
==================================================
.. automodule:: colossalai.utils.tensor_detector.tensor_detector
:members:

View File

@ -0,0 +1,5 @@
colossalai.zero.init\_ctx.init\_context
=======================================
.. automodule:: colossalai.zero.init_ctx.init_context
:members:

View File

@ -1,8 +1,11 @@
colossalai.zero.init\_ctx
=========================
colossalai.zero.init\_ctx.init\_context
-----------------------------------------
.. automodule:: colossalai.zero.init_ctx.init_context
.. automodule:: colossalai.zero.init_ctx
:members:
.. toctree::
:maxdepth: 2
colossalai.zero.init_ctx.init_context

View File

@ -0,0 +1,5 @@
colossalai.zero.shard\_utils.base\_shard\_strategy
==================================================
.. automodule:: colossalai.zero.shard_utils.base_shard_strategy
:members:

View File

@ -0,0 +1,5 @@
colossalai.zero.shard\_utils.bucket\_tensor\_shard\_strategy
============================================================
.. automodule:: colossalai.zero.shard_utils.bucket_tensor_shard_strategy
:members:

View File

@ -0,0 +1,5 @@
colossalai.zero.shard\_utils.commons
====================================
.. automodule:: colossalai.zero.shard_utils.commons
:members:

View File

@ -3,3 +3,13 @@ colossalai.zero.shard\_utils
.. automodule:: colossalai.zero.shard_utils
:members:
.. toctree::
:maxdepth: 2
colossalai.zero.shard_utils.base_shard_strategy
colossalai.zero.shard_utils.bucket_tensor_shard_strategy
colossalai.zero.shard_utils.commons
colossalai.zero.shard_utils.tensor_shard_strategy
colossalai.zero.shard_utils.tensor_utils

View File

@ -0,0 +1,5 @@
colossalai.zero.shard\_utils.tensor\_shard\_strategy
====================================================
.. automodule:: colossalai.zero.shard_utils.tensor_shard_strategy
:members:

View File

@ -0,0 +1,5 @@
colossalai.zero.shard\_utils.tensor\_utils
==========================================
.. automodule:: colossalai.zero.shard_utils.tensor_utils
:members:

View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_model.reduce\_scatter
==============================================
.. automodule:: colossalai.zero.sharded_model.reduce_scatter
:members:

View File

@ -1,39 +1,13 @@
colossalai.zero.sharded\_model
==============================
colossalai.zero.sharded\_model.sharded\_model\_v2
--------------------------------------------------
.. automodule:: colossalai.zero.sharded_model.sharded_model_v2
:members:
colossalai.zero.sharded\_model.reduce\_scatter
-----------------------------------------------
.. automodule:: colossalai.zero.sharded_model.reduce_scatter
:members:
colossalai.zero.sharded\_model.utils
--------------------------------------
.. automodule:: colossalai.zero.sharded_model.utils
:members:
colossalai.zero.sharded\_model.sharded\_model
--------------------------------------------------
.. automodule:: colossalai.zero.sharded_model
:members:
colossalai.zero.sharded\_model.sharded\_grad
--------------------------------------------------
.. automodule:: colossalai.zero.sharded_grad
:members:
.. toctree::
:maxdepth: 2
colossalai.zero.sharded\_model.param\_manager
----------------------------------------------
.. automodule:: colossalai.zero.sharded_model.param_manager
:members:
colossalai.zero.sharded_model.reduce_scatter
colossalai.zero.sharded_model.sharded_model_v2
colossalai.zero.sharded_model.utils

View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_model.sharded\_model\_v2
=================================================
.. automodule:: colossalai.zero.sharded_model.sharded_model_v2
:members:

View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_model.utils
====================================
.. automodule:: colossalai.zero.sharded_model.utils
:members:

View File

@ -1,5 +1,11 @@
colossalai.zero.sharded\_optim
===============================
==============================
.. automodule:: colossalai.zero.sharded_optim
:members:
.. toctree::
:maxdepth: 2
colossalai.zero.sharded_optim.sharded_optim_v2

View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_optim.sharded\_optim\_v2
=================================================
.. automodule:: colossalai.zero.sharded_optim.sharded_optim_v2
:members:

View File

@ -3,3 +3,11 @@ colossalai.zero.sharded\_param
.. automodule:: colossalai.zero.sharded_param
:members:
.. toctree::
:maxdepth: 2
colossalai.zero.sharded_param.sharded_param
colossalai.zero.sharded_param.sharded_tensor
colossalai.zero.sharded_param.tensorful_state

View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_param.sharded\_param
=============================================
.. automodule:: colossalai.zero.sharded_param.sharded_param
:members:

View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_param.sharded\_tensor
==============================================
.. automodule:: colossalai.zero.sharded_param.sharded_tensor
:members:

View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_param.tensorful\_state
===============================================
.. automodule:: colossalai.zero.sharded_param.tensorful_state
:members:

View File

@ -1,5 +0,0 @@
colossalai.zero.sharded\_utils
===============
.. automodule:: colossalai.zero.sharded_utils
:members: