From f69507dd2225956661d5c3841eedbe80525284ed Mon Sep 17 00:00:00 2001 From: ver217 Date: Fri, 1 Apr 2022 15:46:38 +0800 Subject: [PATCH] update rst (#615) --- .../colossalai.amp.apex_amp.apex_amp.rst | 5 +++ docs/colossalai/colossalai.amp.apex_amp.rst | 6 +++ .../colossalai.amp.naive_amp.naive_amp.rst | 5 +++ docs/colossalai/colossalai.amp.naive_amp.rst | 6 +++ docs/colossalai/colossalai.amp.rst | 6 +-- docs/colossalai/colossalai.amp.torch_amp.rst | 8 +++- .../colossalai.amp.torch_amp.torch_amp.rst | 5 +++ docs/colossalai/colossalai.builder.rst | 5 ++- docs/colossalai/colossalai.communication.rst | 4 +- docs/colossalai/colossalai.constants.rst | 5 +++ .../colossalai.context.moe_context.rst | 4 +- ...ocess_group_initializer.initializer_2d.rst | 2 +- ...ess_group_initializer.initializer_2p5d.rst | 2 +- ...ocess_group_initializer.initializer_3d.rst | 2 +- ...group_initializer.initializer_sequence.rst | 2 +- ...alai.context.process_group_initializer.rst | 1 - docs/colossalai/colossalai.context.rst | 10 ++--- .../colossalai.context.singleton_meta.rst | 5 +++ docs/colossalai/colossalai.core.rst | 5 +++ docs/colossalai/colossalai.engine.ophooks.rst | 8 +++- .../colossalai.engine.ophooks.zero_hook.rst | 5 +++ .../colossalai.engine.paramhooks.rst | 5 --- docs/colossalai/colossalai.engine.rst | 3 +- .../colossalai.global_variables.rst | 5 +++ docs/colossalai/colossalai.logging.logger.rst | 5 +++ docs/colossalai/colossalai.logging.rst | 6 +++ ...alai.nn.layer.colossalai_layer.dropout.rst | 5 +++ ...ai.nn.layer.colossalai_layer.embedding.rst | 5 +++ ...salai.nn.layer.colossalai_layer.linear.rst | 5 +++ ...n.layer.colossalai_layer.normalization.rst | 5 +++ .../colossalai.nn.layer.colossalai_layer.rst | 9 +++++ .../colossalai.nn.layer.moe.experts.rst | 5 +++ .../colossalai.nn.layer.moe.layers.rst | 5 +++ docs/colossalai/colossalai.nn.layer.moe.rst | 8 ++++ .../colossalai.nn.layer.moe.utils.rst | 5 +++ ...colossalai.nn.layer.parallel_1d.layers.rst | 5 +++ .../colossalai.nn.layer.parallel_1d.rst | 6 +++ ...colossalai.nn.layer.parallel_2d.layers.rst | 5 +++ .../colossalai.nn.layer.parallel_2d.rst | 8 +++- ...lossalai.nn.layer.parallel_2p5d.layers.rst | 5 +++ .../colossalai.nn.layer.parallel_2p5d.rst | 6 +++ ...colossalai.nn.layer.parallel_3d.layers.rst | 5 +++ .../colossalai.nn.layer.parallel_3d.rst | 6 +++ ...alai.nn.layer.parallel_sequence.layers.rst | 5 +++ .../colossalai.nn.layer.parallel_sequence.rst | 6 +++ .../colossalai.nn.layer.utils.common.rst | 5 +++ docs/colossalai/colossalai.nn.layer.utils.rst | 6 +++ .../colossalai.nn.layer.vanilla.layers.rst | 5 +++ .../colossalai.nn.layer.vanilla.rst | 6 +++ ...ssalai.nn.layer.wrapper.lambda_wrapper.rst | 5 +++ ...alai.nn.layer.wrapper.pipeline_wrapper.rst | 5 +++ .../colossalai.nn.layer.wrapper.rst | 7 ++++ .../colossalai/colossalai.nn.lr_scheduler.rst | 4 ++ docs/colossalai/colossalai.nn.optimizer.rst | 4 ++ docs/colossalai/colossalai.nn.rst | 40 +------------------ docs/colossalai/colossalai.rst | 5 +-- .../colossalai.testing.comparison.rst | 5 +++ docs/colossalai/colossalai.testing.rst | 11 ++++- docs/colossalai/colossalai.testing.utils.rst | 5 +++ ...ssalai.utils.data_sampler.base_sampler.rst | 5 +++ ...ils.data_sampler.data_parallel_sampler.rst | 5 +++ .../colossalai.utils.data_sampler.rst | 7 ++++ ...ai.utils.memory_tracer.async_memtracer.rst | 5 +++ ...utils.memory_tracer.memstats_collector.rst | 5 +++ ...ils.memory_tracer.model_data_memtracer.rst | 5 +++ .../colossalai.utils.memory_tracer.rst | 12 +++++- ...alai.utils.memory_utils.memory_monitor.rst | 5 +++ .../colossalai.utils.memory_utils.rst | 12 ++++++ .../colossalai.utils.memory_utils.utils.rst | 5 +++ docs/colossalai/colossalai.utils.moe.rst | 4 +- ...olossalai.utils.profiler.comm_profiler.rst | 5 +++ ...colossalai.utils.profiler.mem_profiler.rst | 5 +++ ...olossalai.utils.profiler.pcie_profiler.rst | 5 +++ .../colossalai.utils.profiler.prof_utils.rst | 5 +++ docs/colossalai/colossalai.utils.profiler.rst | 13 +++++- docs/colossalai/colossalai.utils.rst | 7 ++-- .../colossalai.utils.tensor_detector.rst | 12 ++++-- ....utils.tensor_detector.tensor_detector.rst | 5 +++ .../colossalai.zero.init_ctx.init_context.rst | 5 +++ docs/colossalai/colossalai.zero.init_ctx.rst | 11 +++-- ...i.zero.shard_utils.base_shard_strategy.rst | 5 +++ ...ard_utils.bucket_tensor_shard_strategy.rst | 5 +++ .../colossalai.zero.shard_utils.commons.rst | 5 +++ .../colossalai.zero.shard_utils.rst | 10 +++++ ...zero.shard_utils.tensor_shard_strategy.rst | 5 +++ ...lossalai.zero.shard_utils.tensor_utils.rst | 5 +++ ...alai.zero.sharded_model.reduce_scatter.rst | 5 +++ .../colossalai.zero.sharded_model.rst | 36 +++-------------- ...ai.zero.sharded_model.sharded_model_v2.rst | 5 +++ .../colossalai.zero.sharded_model.utils.rst | 5 +++ .../colossalai.zero.sharded_optim.rst | 8 +++- ...ai.zero.sharded_optim.sharded_optim_v2.rst | 5 +++ .../colossalai.zero.sharded_param.rst | 8 ++++ ...salai.zero.sharded_param.sharded_param.rst | 5 +++ ...alai.zero.sharded_param.sharded_tensor.rst | 5 +++ ...lai.zero.sharded_param.tensorful_state.rst | 5 +++ .../colossalai.zero.sharded_utils.rst | 5 --- 97 files changed, 490 insertions(+), 127 deletions(-) create mode 100644 docs/colossalai/colossalai.amp.apex_amp.apex_amp.rst create mode 100644 docs/colossalai/colossalai.amp.naive_amp.naive_amp.rst create mode 100644 docs/colossalai/colossalai.amp.torch_amp.torch_amp.rst create mode 100644 docs/colossalai/colossalai.constants.rst create mode 100644 docs/colossalai/colossalai.context.singleton_meta.rst create mode 100644 docs/colossalai/colossalai.core.rst create mode 100644 docs/colossalai/colossalai.engine.ophooks.zero_hook.rst delete mode 100644 docs/colossalai/colossalai.engine.paramhooks.rst create mode 100644 docs/colossalai/colossalai.global_variables.rst create mode 100644 docs/colossalai/colossalai.logging.logger.rst create mode 100644 docs/colossalai/colossalai.nn.layer.colossalai_layer.dropout.rst create mode 100644 docs/colossalai/colossalai.nn.layer.colossalai_layer.embedding.rst create mode 100644 docs/colossalai/colossalai.nn.layer.colossalai_layer.linear.rst create mode 100644 docs/colossalai/colossalai.nn.layer.colossalai_layer.normalization.rst create mode 100644 docs/colossalai/colossalai.nn.layer.moe.experts.rst create mode 100644 docs/colossalai/colossalai.nn.layer.moe.layers.rst create mode 100644 docs/colossalai/colossalai.nn.layer.moe.utils.rst create mode 100644 docs/colossalai/colossalai.nn.layer.parallel_1d.layers.rst create mode 100644 docs/colossalai/colossalai.nn.layer.parallel_2d.layers.rst create mode 100644 docs/colossalai/colossalai.nn.layer.parallel_2p5d.layers.rst create mode 100644 docs/colossalai/colossalai.nn.layer.parallel_3d.layers.rst create mode 100644 docs/colossalai/colossalai.nn.layer.parallel_sequence.layers.rst create mode 100644 docs/colossalai/colossalai.nn.layer.utils.common.rst create mode 100644 docs/colossalai/colossalai.nn.layer.vanilla.layers.rst create mode 100644 docs/colossalai/colossalai.nn.layer.wrapper.lambda_wrapper.rst create mode 100644 docs/colossalai/colossalai.nn.layer.wrapper.pipeline_wrapper.rst create mode 100644 docs/colossalai/colossalai.testing.comparison.rst create mode 100644 docs/colossalai/colossalai.testing.utils.rst create mode 100644 docs/colossalai/colossalai.utils.data_sampler.base_sampler.rst create mode 100644 docs/colossalai/colossalai.utils.data_sampler.data_parallel_sampler.rst create mode 100644 docs/colossalai/colossalai.utils.memory_tracer.async_memtracer.rst create mode 100644 docs/colossalai/colossalai.utils.memory_tracer.memstats_collector.rst create mode 100644 docs/colossalai/colossalai.utils.memory_tracer.model_data_memtracer.rst create mode 100644 docs/colossalai/colossalai.utils.memory_utils.memory_monitor.rst create mode 100644 docs/colossalai/colossalai.utils.memory_utils.rst create mode 100644 docs/colossalai/colossalai.utils.memory_utils.utils.rst create mode 100644 docs/colossalai/colossalai.utils.profiler.comm_profiler.rst create mode 100644 docs/colossalai/colossalai.utils.profiler.mem_profiler.rst create mode 100644 docs/colossalai/colossalai.utils.profiler.pcie_profiler.rst create mode 100644 docs/colossalai/colossalai.utils.profiler.prof_utils.rst create mode 100644 docs/colossalai/colossalai.utils.tensor_detector.tensor_detector.rst create mode 100644 docs/colossalai/colossalai.zero.init_ctx.init_context.rst create mode 100644 docs/colossalai/colossalai.zero.shard_utils.base_shard_strategy.rst create mode 100644 docs/colossalai/colossalai.zero.shard_utils.bucket_tensor_shard_strategy.rst create mode 100644 docs/colossalai/colossalai.zero.shard_utils.commons.rst create mode 100644 docs/colossalai/colossalai.zero.shard_utils.tensor_shard_strategy.rst create mode 100644 docs/colossalai/colossalai.zero.shard_utils.tensor_utils.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_model.reduce_scatter.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_model.sharded_model_v2.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_model.utils.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_optim.sharded_optim_v2.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_param.sharded_param.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_param.sharded_tensor.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_param.tensorful_state.rst delete mode 100644 docs/colossalai/colossalai.zero.sharded_utils.rst diff --git a/docs/colossalai/colossalai.amp.apex_amp.apex_amp.rst b/docs/colossalai/colossalai.amp.apex_amp.apex_amp.rst new file mode 100644 index 000000000..cba7e0062 --- /dev/null +++ b/docs/colossalai/colossalai.amp.apex_amp.apex_amp.rst @@ -0,0 +1,5 @@ +colossalai.amp.apex\_amp.apex\_amp +================================== + +.. automodule:: colossalai.amp.apex_amp.apex_amp + :members: diff --git a/docs/colossalai/colossalai.amp.apex_amp.rst b/docs/colossalai/colossalai.amp.apex_amp.rst index 0352ef9a6..7116a538b 100644 --- a/docs/colossalai/colossalai.amp.apex_amp.rst +++ b/docs/colossalai/colossalai.amp.apex_amp.rst @@ -3,3 +3,9 @@ colossalai.amp.apex\_amp .. automodule:: colossalai.amp.apex_amp :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.amp.apex_amp.apex_amp diff --git a/docs/colossalai/colossalai.amp.naive_amp.naive_amp.rst b/docs/colossalai/colossalai.amp.naive_amp.naive_amp.rst new file mode 100644 index 000000000..e20f22b2e --- /dev/null +++ b/docs/colossalai/colossalai.amp.naive_amp.naive_amp.rst @@ -0,0 +1,5 @@ +colossalai.amp.naive\_amp.naive\_amp +==================================== + +.. automodule:: colossalai.amp.naive_amp.naive_amp + :members: diff --git a/docs/colossalai/colossalai.amp.naive_amp.rst b/docs/colossalai/colossalai.amp.naive_amp.rst index fac0cc3db..15917e174 100644 --- a/docs/colossalai/colossalai.amp.naive_amp.rst +++ b/docs/colossalai/colossalai.amp.naive_amp.rst @@ -3,3 +3,9 @@ colossalai.amp.naive\_amp .. automodule:: colossalai.amp.naive_amp :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.amp.naive_amp.naive_amp diff --git a/docs/colossalai/colossalai.amp.rst b/docs/colossalai/colossalai.amp.rst index ffea8bbc7..5ef4f36c1 100644 --- a/docs/colossalai/colossalai.amp.rst +++ b/docs/colossalai/colossalai.amp.rst @@ -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 diff --git a/docs/colossalai/colossalai.amp.torch_amp.rst b/docs/colossalai/colossalai.amp.torch_amp.rst index 62fe4741c..f10095f13 100644 --- a/docs/colossalai/colossalai.amp.torch_amp.rst +++ b/docs/colossalai/colossalai.amp.torch_amp.rst @@ -2,4 +2,10 @@ colossalai.amp.torch\_amp ========================= .. automodule:: colossalai.amp.torch_amp - :members: \ No newline at end of file + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.amp.torch_amp.torch_amp diff --git a/docs/colossalai/colossalai.amp.torch_amp.torch_amp.rst b/docs/colossalai/colossalai.amp.torch_amp.torch_amp.rst new file mode 100644 index 000000000..5f1549cb8 --- /dev/null +++ b/docs/colossalai/colossalai.amp.torch_amp.torch_amp.rst @@ -0,0 +1,5 @@ +colossalai.amp.torch\_amp.torch\_amp +==================================== + +.. automodule:: colossalai.amp.torch_amp.torch_amp + :members: diff --git a/docs/colossalai/colossalai.builder.rst b/docs/colossalai/colossalai.builder.rst index c6641f742..60b8501c8 100644 --- a/docs/colossalai/colossalai.builder.rst +++ b/docs/colossalai/colossalai.builder.rst @@ -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 diff --git a/docs/colossalai/colossalai.communication.rst b/docs/colossalai/colossalai.communication.rst index 150c18687..5086fa663 100644 --- a/docs/colossalai/colossalai.communication.rst +++ b/docs/colossalai/colossalai.communication.rst @@ -1,7 +1,9 @@ colossalai.communication ======================== -*This module contains different methods for communication in parallel training.* +.. automodule:: colossalai.communication + :members: + .. toctree:: :maxdepth: 2 diff --git a/docs/colossalai/colossalai.constants.rst b/docs/colossalai/colossalai.constants.rst new file mode 100644 index 000000000..330b3e866 --- /dev/null +++ b/docs/colossalai/colossalai.constants.rst @@ -0,0 +1,5 @@ +colossalai.constants +==================== + +.. automodule:: colossalai.constants + :members: diff --git a/docs/colossalai/colossalai.context.moe_context.rst b/docs/colossalai/colossalai.context.moe_context.rst index b652c3df4..9027d19ff 100644 --- a/docs/colossalai/colossalai.context.moe_context.rst +++ b/docs/colossalai/colossalai.context.moe_context.rst @@ -1,5 +1,5 @@ colossalai.context.moe\_context -==================================== +=============================== .. automodule:: colossalai.context.moe_context - :members: \ No newline at end of file + :members: diff --git a/docs/colossalai/colossalai.context.process_group_initializer.initializer_2d.rst b/docs/colossalai/colossalai.context.process_group_initializer.initializer_2d.rst index 883fb03dc..d99a2e1c3 100644 --- a/docs/colossalai/colossalai.context.process_group_initializer.initializer_2d.rst +++ b/docs/colossalai/colossalai.context.process_group_initializer.initializer_2d.rst @@ -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: diff --git a/docs/colossalai/colossalai.context.process_group_initializer.initializer_2p5d.rst b/docs/colossalai/colossalai.context.process_group_initializer.initializer_2p5d.rst index 9fcce069c..73d80e443 100644 --- a/docs/colossalai/colossalai.context.process_group_initializer.initializer_2p5d.rst +++ b/docs/colossalai/colossalai.context.process_group_initializer.initializer_2p5d.rst @@ -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: diff --git a/docs/colossalai/colossalai.context.process_group_initializer.initializer_3d.rst b/docs/colossalai/colossalai.context.process_group_initializer.initializer_3d.rst index e81678038..5cfba5ce0 100644 --- a/docs/colossalai/colossalai.context.process_group_initializer.initializer_3d.rst +++ b/docs/colossalai/colossalai.context.process_group_initializer.initializer_3d.rst @@ -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: diff --git a/docs/colossalai/colossalai.context.process_group_initializer.initializer_sequence.rst b/docs/colossalai/colossalai.context.process_group_initializer.initializer_sequence.rst index b4bc76bfa..dab71cc3c 100644 --- a/docs/colossalai/colossalai.context.process_group_initializer.initializer_sequence.rst +++ b/docs/colossalai/colossalai.context.process_group_initializer.initializer_sequence.rst @@ -2,4 +2,4 @@ colossalai.context.process\_group\_initializer.initializer\_sequence ==================================================================== .. automodule:: colossalai.context.process_group_initializer.initializer_sequence - :members: Initializer_Sequence_DP + :members: diff --git a/docs/colossalai/colossalai.context.process_group_initializer.rst b/docs/colossalai/colossalai.context.process_group_initializer.rst index b5e261195..519337e9c 100644 --- a/docs/colossalai/colossalai.context.process_group_initializer.rst +++ b/docs/colossalai/colossalai.context.process_group_initializer.rst @@ -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 diff --git a/docs/colossalai/colossalai.context.rst b/docs/colossalai/colossalai.context.rst index b1311cab8..102a9e02e 100644 --- a/docs/colossalai/colossalai.context.rst +++ b/docs/colossalai/colossalai.context.rst @@ -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 diff --git a/docs/colossalai/colossalai.context.singleton_meta.rst b/docs/colossalai/colossalai.context.singleton_meta.rst new file mode 100644 index 000000000..ae4ceb314 --- /dev/null +++ b/docs/colossalai/colossalai.context.singleton_meta.rst @@ -0,0 +1,5 @@ +colossalai.context.singleton\_meta +================================== + +.. automodule:: colossalai.context.singleton_meta + :members: diff --git a/docs/colossalai/colossalai.core.rst b/docs/colossalai/colossalai.core.rst new file mode 100644 index 000000000..d9ddb76ed --- /dev/null +++ b/docs/colossalai/colossalai.core.rst @@ -0,0 +1,5 @@ +colossalai.core +=============== + +.. automodule:: colossalai.core + :members: diff --git a/docs/colossalai/colossalai.engine.ophooks.rst b/docs/colossalai/colossalai.engine.ophooks.rst index a43ca7a6f..f4b8a8396 100644 --- a/docs/colossalai/colossalai.engine.ophooks.rst +++ b/docs/colossalai/colossalai.engine.ophooks.rst @@ -1,5 +1,11 @@ colossalai.engine.ophooks -=========================== +========================= .. automodule:: colossalai.engine.ophooks :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.engine.ophooks.zero_hook diff --git a/docs/colossalai/colossalai.engine.ophooks.zero_hook.rst b/docs/colossalai/colossalai.engine.ophooks.zero_hook.rst new file mode 100644 index 000000000..270d1839c --- /dev/null +++ b/docs/colossalai/colossalai.engine.ophooks.zero_hook.rst @@ -0,0 +1,5 @@ +colossalai.engine.ophooks.zero\_hook +==================================== + +.. automodule:: colossalai.engine.ophooks.zero_hook + :members: diff --git a/docs/colossalai/colossalai.engine.paramhooks.rst b/docs/colossalai/colossalai.engine.paramhooks.rst deleted file mode 100644 index 663f26ec6..000000000 --- a/docs/colossalai/colossalai.engine.paramhooks.rst +++ /dev/null @@ -1,5 +0,0 @@ -colossalai.engine.paramhooks -============================== - -.. automodule:: colossalai.engine.paramhooks - :members: diff --git a/docs/colossalai/colossalai.engine.rst b/docs/colossalai/colossalai.engine.rst index 87db7152f..00028968a 100644 --- a/docs/colossalai/colossalai.engine.rst +++ b/docs/colossalai/colossalai.engine.rst @@ -8,6 +8,5 @@ colossalai.engine :maxdepth: 2 colossalai.engine.gradient_handler - colossalai.engine.schedule colossalai.engine.ophooks - colossalai.engine.paramhooks + colossalai.engine.schedule diff --git a/docs/colossalai/colossalai.global_variables.rst b/docs/colossalai/colossalai.global_variables.rst new file mode 100644 index 000000000..1900c8835 --- /dev/null +++ b/docs/colossalai/colossalai.global_variables.rst @@ -0,0 +1,5 @@ +colossalai.global\_variables +============================ + +.. automodule:: colossalai.global_variables + :members: diff --git a/docs/colossalai/colossalai.logging.logger.rst b/docs/colossalai/colossalai.logging.logger.rst new file mode 100644 index 000000000..047deb8a1 --- /dev/null +++ b/docs/colossalai/colossalai.logging.logger.rst @@ -0,0 +1,5 @@ +colossalai.logging.logger +========================= + +.. automodule:: colossalai.logging.logger + :members: diff --git a/docs/colossalai/colossalai.logging.rst b/docs/colossalai/colossalai.logging.rst index 65492bbb7..bc593fc81 100644 --- a/docs/colossalai/colossalai.logging.rst +++ b/docs/colossalai/colossalai.logging.rst @@ -3,3 +3,9 @@ colossalai.logging .. automodule:: colossalai.logging :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.logging.logger diff --git a/docs/colossalai/colossalai.nn.layer.colossalai_layer.dropout.rst b/docs/colossalai/colossalai.nn.layer.colossalai_layer.dropout.rst new file mode 100644 index 000000000..ec1dfd395 --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.colossalai_layer.dropout.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.colossalai\_layer.dropout +============================================= + +.. automodule:: colossalai.nn.layer.colossalai_layer.dropout + :members: diff --git a/docs/colossalai/colossalai.nn.layer.colossalai_layer.embedding.rst b/docs/colossalai/colossalai.nn.layer.colossalai_layer.embedding.rst new file mode 100644 index 000000000..8438b3a07 --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.colossalai_layer.embedding.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.colossalai\_layer.embedding +=============================================== + +.. automodule:: colossalai.nn.layer.colossalai_layer.embedding + :members: diff --git a/docs/colossalai/colossalai.nn.layer.colossalai_layer.linear.rst b/docs/colossalai/colossalai.nn.layer.colossalai_layer.linear.rst new file mode 100644 index 000000000..321328254 --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.colossalai_layer.linear.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.colossalai\_layer.linear +============================================ + +.. automodule:: colossalai.nn.layer.colossalai_layer.linear + :members: diff --git a/docs/colossalai/colossalai.nn.layer.colossalai_layer.normalization.rst b/docs/colossalai/colossalai.nn.layer.colossalai_layer.normalization.rst new file mode 100644 index 000000000..f94dd27b8 --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.colossalai_layer.normalization.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.colossalai\_layer.normalization +=================================================== + +.. automodule:: colossalai.nn.layer.colossalai_layer.normalization + :members: diff --git a/docs/colossalai/colossalai.nn.layer.colossalai_layer.rst b/docs/colossalai/colossalai.nn.layer.colossalai_layer.rst index ae5af4c0e..0f685e6c2 100644 --- a/docs/colossalai/colossalai.nn.layer.colossalai_layer.rst +++ b/docs/colossalai/colossalai.nn.layer.colossalai_layer.rst @@ -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 diff --git a/docs/colossalai/colossalai.nn.layer.moe.experts.rst b/docs/colossalai/colossalai.nn.layer.moe.experts.rst new file mode 100644 index 000000000..c05e763d5 --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.moe.experts.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.moe.experts +=============================== + +.. automodule:: colossalai.nn.layer.moe.experts + :members: diff --git a/docs/colossalai/colossalai.nn.layer.moe.layers.rst b/docs/colossalai/colossalai.nn.layer.moe.layers.rst new file mode 100644 index 000000000..d109d47b8 --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.moe.layers.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.moe.layers +============================== + +.. automodule:: colossalai.nn.layer.moe.layers + :members: diff --git a/docs/colossalai/colossalai.nn.layer.moe.rst b/docs/colossalai/colossalai.nn.layer.moe.rst index d13eb3649..f3106b98d 100644 --- a/docs/colossalai/colossalai.nn.layer.moe.rst +++ b/docs/colossalai/colossalai.nn.layer.moe.rst @@ -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 diff --git a/docs/colossalai/colossalai.nn.layer.moe.utils.rst b/docs/colossalai/colossalai.nn.layer.moe.utils.rst new file mode 100644 index 000000000..fc085d136 --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.moe.utils.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.moe.utils +============================= + +.. automodule:: colossalai.nn.layer.moe.utils + :members: diff --git a/docs/colossalai/colossalai.nn.layer.parallel_1d.layers.rst b/docs/colossalai/colossalai.nn.layer.parallel_1d.layers.rst new file mode 100644 index 000000000..380f6bf8d --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.parallel_1d.layers.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.parallel\_1d.layers +======================================= + +.. automodule:: colossalai.nn.layer.parallel_1d.layers + :members: diff --git a/docs/colossalai/colossalai.nn.layer.parallel_1d.rst b/docs/colossalai/colossalai.nn.layer.parallel_1d.rst index e487563c9..3a8ed6206 100644 --- a/docs/colossalai/colossalai.nn.layer.parallel_1d.rst +++ b/docs/colossalai/colossalai.nn.layer.parallel_1d.rst @@ -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 diff --git a/docs/colossalai/colossalai.nn.layer.parallel_2d.layers.rst b/docs/colossalai/colossalai.nn.layer.parallel_2d.layers.rst new file mode 100644 index 000000000..b64d402bd --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.parallel_2d.layers.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.parallel\_2d.layers +======================================= + +.. automodule:: colossalai.nn.layer.parallel_2d.layers + :members: diff --git a/docs/colossalai/colossalai.nn.layer.parallel_2d.rst b/docs/colossalai/colossalai.nn.layer.parallel_2d.rst index b2609ad42..f5ad41a1b 100644 --- a/docs/colossalai/colossalai.nn.layer.parallel_2d.rst +++ b/docs/colossalai/colossalai.nn.layer.parallel_2d.rst @@ -2,4 +2,10 @@ colossalai.nn.layer.parallel\_2d ================================ .. automodule:: colossalai.nn.layer.parallel_2d - :members: \ No newline at end of file + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.nn.layer.parallel_2d.layers diff --git a/docs/colossalai/colossalai.nn.layer.parallel_2p5d.layers.rst b/docs/colossalai/colossalai.nn.layer.parallel_2p5d.layers.rst new file mode 100644 index 000000000..ebc99d56c --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.parallel_2p5d.layers.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.parallel\_2p5d.layers +========================================= + +.. automodule:: colossalai.nn.layer.parallel_2p5d.layers + :members: diff --git a/docs/colossalai/colossalai.nn.layer.parallel_2p5d.rst b/docs/colossalai/colossalai.nn.layer.parallel_2p5d.rst index 9a27f93e9..5869bdee9 100644 --- a/docs/colossalai/colossalai.nn.layer.parallel_2p5d.rst +++ b/docs/colossalai/colossalai.nn.layer.parallel_2p5d.rst @@ -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 diff --git a/docs/colossalai/colossalai.nn.layer.parallel_3d.layers.rst b/docs/colossalai/colossalai.nn.layer.parallel_3d.layers.rst new file mode 100644 index 000000000..a1702f1fc --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.parallel_3d.layers.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.parallel\_3d.layers +======================================= + +.. automodule:: colossalai.nn.layer.parallel_3d.layers + :members: diff --git a/docs/colossalai/colossalai.nn.layer.parallel_3d.rst b/docs/colossalai/colossalai.nn.layer.parallel_3d.rst index 37af0c1e7..bb55a63e5 100644 --- a/docs/colossalai/colossalai.nn.layer.parallel_3d.rst +++ b/docs/colossalai/colossalai.nn.layer.parallel_3d.rst @@ -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 diff --git a/docs/colossalai/colossalai.nn.layer.parallel_sequence.layers.rst b/docs/colossalai/colossalai.nn.layer.parallel_sequence.layers.rst new file mode 100644 index 000000000..54929d2e7 --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.parallel_sequence.layers.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.parallel\_sequence.layers +============================================= + +.. automodule:: colossalai.nn.layer.parallel_sequence.layers + :members: diff --git a/docs/colossalai/colossalai.nn.layer.parallel_sequence.rst b/docs/colossalai/colossalai.nn.layer.parallel_sequence.rst index 9b252d459..24e8941d4 100644 --- a/docs/colossalai/colossalai.nn.layer.parallel_sequence.rst +++ b/docs/colossalai/colossalai.nn.layer.parallel_sequence.rst @@ -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 diff --git a/docs/colossalai/colossalai.nn.layer.utils.common.rst b/docs/colossalai/colossalai.nn.layer.utils.common.rst new file mode 100644 index 000000000..6a552830f --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.utils.common.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.utils.common +================================ + +.. automodule:: colossalai.nn.layer.utils.common + :members: diff --git a/docs/colossalai/colossalai.nn.layer.utils.rst b/docs/colossalai/colossalai.nn.layer.utils.rst index f241396a4..16c3d7182 100644 --- a/docs/colossalai/colossalai.nn.layer.utils.rst +++ b/docs/colossalai/colossalai.nn.layer.utils.rst @@ -3,3 +3,9 @@ colossalai.nn.layer.utils .. automodule:: colossalai.nn.layer.utils :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.nn.layer.utils.common diff --git a/docs/colossalai/colossalai.nn.layer.vanilla.layers.rst b/docs/colossalai/colossalai.nn.layer.vanilla.layers.rst new file mode 100644 index 000000000..f993b1f50 --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.vanilla.layers.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.vanilla.layers +================================== + +.. automodule:: colossalai.nn.layer.vanilla.layers + :members: diff --git a/docs/colossalai/colossalai.nn.layer.vanilla.rst b/docs/colossalai/colossalai.nn.layer.vanilla.rst index 1567788d5..fe1ea5c6c 100644 --- a/docs/colossalai/colossalai.nn.layer.vanilla.rst +++ b/docs/colossalai/colossalai.nn.layer.vanilla.rst @@ -3,3 +3,9 @@ colossalai.nn.layer.vanilla .. automodule:: colossalai.nn.layer.vanilla :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.nn.layer.vanilla.layers diff --git a/docs/colossalai/colossalai.nn.layer.wrapper.lambda_wrapper.rst b/docs/colossalai/colossalai.nn.layer.wrapper.lambda_wrapper.rst new file mode 100644 index 000000000..f2ced6725 --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.wrapper.lambda_wrapper.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.wrapper.lambda\_wrapper +=========================================== + +.. automodule:: colossalai.nn.layer.wrapper.lambda_wrapper + :members: diff --git a/docs/colossalai/colossalai.nn.layer.wrapper.pipeline_wrapper.rst b/docs/colossalai/colossalai.nn.layer.wrapper.pipeline_wrapper.rst new file mode 100644 index 000000000..e5648873d --- /dev/null +++ b/docs/colossalai/colossalai.nn.layer.wrapper.pipeline_wrapper.rst @@ -0,0 +1,5 @@ +colossalai.nn.layer.wrapper.pipeline\_wrapper +============================================= + +.. automodule:: colossalai.nn.layer.wrapper.pipeline_wrapper + :members: diff --git a/docs/colossalai/colossalai.nn.layer.wrapper.rst b/docs/colossalai/colossalai.nn.layer.wrapper.rst index 0508c46ed..4e66651dc 100644 --- a/docs/colossalai/colossalai.nn.layer.wrapper.rst +++ b/docs/colossalai/colossalai.nn.layer.wrapper.rst @@ -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 diff --git a/docs/colossalai/colossalai.nn.lr_scheduler.rst b/docs/colossalai/colossalai.nn.lr_scheduler.rst index a6d5708c1..427a3ee45 100644 --- a/docs/colossalai/colossalai.nn.lr_scheduler.rst +++ b/docs/colossalai/colossalai.nn.lr_scheduler.rst @@ -1,6 +1,10 @@ colossalai.nn.lr\_scheduler =========================== +.. automodule:: colossalai.nn.lr_scheduler + :members: + + .. toctree:: :maxdepth: 2 diff --git a/docs/colossalai/colossalai.nn.optimizer.rst b/docs/colossalai/colossalai.nn.optimizer.rst index 6939c85d7..d0063179d 100644 --- a/docs/colossalai/colossalai.nn.optimizer.rst +++ b/docs/colossalai/colossalai.nn.optimizer.rst @@ -1,6 +1,10 @@ colossalai.nn.optimizer ======================= +.. automodule:: colossalai.nn.optimizer + :members: + + .. toctree:: :maxdepth: 2 diff --git a/docs/colossalai/colossalai.nn.rst b/docs/colossalai/colossalai.nn.rst index 6167ce5ba..32e5eae2f 100644 --- a/docs/colossalai/colossalai.nn.rst +++ b/docs/colossalai/colossalai.nn.rst @@ -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: diff --git a/docs/colossalai/colossalai.rst b/docs/colossalai/colossalai.rst index 08371f580..15599f587 100644 --- a/docs/colossalai/colossalai.rst +++ b/docs/colossalai/colossalai.rst @@ -1,4 +1,4 @@ -Colossal-AI +colossalai ========== .. toctree:: @@ -23,6 +23,3 @@ Colossal-AI :maxdepth: 2 colossalai.initialize - -.. automodule:: colossalai - :members: diff --git a/docs/colossalai/colossalai.testing.comparison.rst b/docs/colossalai/colossalai.testing.comparison.rst new file mode 100644 index 000000000..bcfdf0598 --- /dev/null +++ b/docs/colossalai/colossalai.testing.comparison.rst @@ -0,0 +1,5 @@ +colossalai.testing.comparison +============================= + +.. automodule:: colossalai.testing.comparison + :members: diff --git a/docs/colossalai/colossalai.testing.rst b/docs/colossalai/colossalai.testing.rst index e35e82353..1127aa52c 100644 --- a/docs/colossalai/colossalai.testing.rst +++ b/docs/colossalai/colossalai.testing.rst @@ -1,5 +1,12 @@ colossalai.testing -======================== +================== .. automodule:: colossalai.testing - :members: \ No newline at end of file + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.testing.comparison + colossalai.testing.utils diff --git a/docs/colossalai/colossalai.testing.utils.rst b/docs/colossalai/colossalai.testing.utils.rst new file mode 100644 index 000000000..d8c2edcce --- /dev/null +++ b/docs/colossalai/colossalai.testing.utils.rst @@ -0,0 +1,5 @@ +colossalai.testing.utils +======================== + +.. automodule:: colossalai.testing.utils + :members: diff --git a/docs/colossalai/colossalai.utils.data_sampler.base_sampler.rst b/docs/colossalai/colossalai.utils.data_sampler.base_sampler.rst new file mode 100644 index 000000000..199e8fcf8 --- /dev/null +++ b/docs/colossalai/colossalai.utils.data_sampler.base_sampler.rst @@ -0,0 +1,5 @@ +colossalai.utils.data\_sampler.base\_sampler +============================================ + +.. automodule:: colossalai.utils.data_sampler.base_sampler + :members: diff --git a/docs/colossalai/colossalai.utils.data_sampler.data_parallel_sampler.rst b/docs/colossalai/colossalai.utils.data_sampler.data_parallel_sampler.rst new file mode 100644 index 000000000..85e1b121c --- /dev/null +++ b/docs/colossalai/colossalai.utils.data_sampler.data_parallel_sampler.rst @@ -0,0 +1,5 @@ +colossalai.utils.data\_sampler.data\_parallel\_sampler +====================================================== + +.. automodule:: colossalai.utils.data_sampler.data_parallel_sampler + :members: diff --git a/docs/colossalai/colossalai.utils.data_sampler.rst b/docs/colossalai/colossalai.utils.data_sampler.rst index b822aaa0b..61dde070b 100644 --- a/docs/colossalai/colossalai.utils.data_sampler.rst +++ b/docs/colossalai/colossalai.utils.data_sampler.rst @@ -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 diff --git a/docs/colossalai/colossalai.utils.memory_tracer.async_memtracer.rst b/docs/colossalai/colossalai.utils.memory_tracer.async_memtracer.rst new file mode 100644 index 000000000..789d28aaf --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_tracer.async_memtracer.rst @@ -0,0 +1,5 @@ +colossalai.utils.memory\_tracer.async\_memtracer +================================================ + +.. automodule:: colossalai.utils.memory_tracer.async_memtracer + :members: diff --git a/docs/colossalai/colossalai.utils.memory_tracer.memstats_collector.rst b/docs/colossalai/colossalai.utils.memory_tracer.memstats_collector.rst new file mode 100644 index 000000000..b078807f9 --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_tracer.memstats_collector.rst @@ -0,0 +1,5 @@ +colossalai.utils.memory\_tracer.memstats\_collector +=================================================== + +.. automodule:: colossalai.utils.memory_tracer.memstats_collector + :members: diff --git a/docs/colossalai/colossalai.utils.memory_tracer.model_data_memtracer.rst b/docs/colossalai/colossalai.utils.memory_tracer.model_data_memtracer.rst new file mode 100644 index 000000000..51a7a986c --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_tracer.model_data_memtracer.rst @@ -0,0 +1,5 @@ +colossalai.utils.memory\_tracer.model\_data\_memtracer +====================================================== + +.. automodule:: colossalai.utils.memory_tracer.model_data_memtracer + :members: diff --git a/docs/colossalai/colossalai.utils.memory_tracer.rst b/docs/colossalai/colossalai.utils.memory_tracer.rst index b67c2684d..85b0382ed 100644 --- a/docs/colossalai/colossalai.utils.memory_tracer.rst +++ b/docs/colossalai/colossalai.utils.memory_tracer.rst @@ -1,5 +1,13 @@ colossalai.utils.memory\_tracer -======================= +=============================== .. automodule:: colossalai.utils.memory_tracer - :members: \ No newline at end of file + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.utils.memory_tracer.async_memtracer + colossalai.utils.memory_tracer.memstats_collector + colossalai.utils.memory_tracer.model_data_memtracer diff --git a/docs/colossalai/colossalai.utils.memory_utils.memory_monitor.rst b/docs/colossalai/colossalai.utils.memory_utils.memory_monitor.rst new file mode 100644 index 000000000..4b6d805ae --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_utils.memory_monitor.rst @@ -0,0 +1,5 @@ +colossalai.utils.memory\_utils.memory\_monitor +============================================== + +.. automodule:: colossalai.utils.memory_utils.memory_monitor + :members: diff --git a/docs/colossalai/colossalai.utils.memory_utils.rst b/docs/colossalai/colossalai.utils.memory_utils.rst new file mode 100644 index 000000000..6777334e1 --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_utils.rst @@ -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 diff --git a/docs/colossalai/colossalai.utils.memory_utils.utils.rst b/docs/colossalai/colossalai.utils.memory_utils.utils.rst new file mode 100644 index 000000000..a7bc1c607 --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_utils.utils.rst @@ -0,0 +1,5 @@ +colossalai.utils.memory\_utils.utils +==================================== + +.. automodule:: colossalai.utils.memory_utils.utils + :members: diff --git a/docs/colossalai/colossalai.utils.moe.rst b/docs/colossalai/colossalai.utils.moe.rst index aa6e66367..b66ccdc8e 100644 --- a/docs/colossalai/colossalai.utils.moe.rst +++ b/docs/colossalai/colossalai.utils.moe.rst @@ -1,5 +1,5 @@ colossalai.utils.moe -======================= +==================== .. automodule:: colossalai.utils.moe - :members: \ No newline at end of file + :members: diff --git a/docs/colossalai/colossalai.utils.profiler.comm_profiler.rst b/docs/colossalai/colossalai.utils.profiler.comm_profiler.rst new file mode 100644 index 000000000..88532eff2 --- /dev/null +++ b/docs/colossalai/colossalai.utils.profiler.comm_profiler.rst @@ -0,0 +1,5 @@ +colossalai.utils.profiler.comm\_profiler +======================================== + +.. automodule:: colossalai.utils.profiler.comm_profiler + :members: diff --git a/docs/colossalai/colossalai.utils.profiler.mem_profiler.rst b/docs/colossalai/colossalai.utils.profiler.mem_profiler.rst new file mode 100644 index 000000000..a68c17055 --- /dev/null +++ b/docs/colossalai/colossalai.utils.profiler.mem_profiler.rst @@ -0,0 +1,5 @@ +colossalai.utils.profiler.mem\_profiler +======================================= + +.. automodule:: colossalai.utils.profiler.mem_profiler + :members: diff --git a/docs/colossalai/colossalai.utils.profiler.pcie_profiler.rst b/docs/colossalai/colossalai.utils.profiler.pcie_profiler.rst new file mode 100644 index 000000000..fd2f4ea15 --- /dev/null +++ b/docs/colossalai/colossalai.utils.profiler.pcie_profiler.rst @@ -0,0 +1,5 @@ +colossalai.utils.profiler.pcie\_profiler +======================================== + +.. automodule:: colossalai.utils.profiler.pcie_profiler + :members: diff --git a/docs/colossalai/colossalai.utils.profiler.prof_utils.rst b/docs/colossalai/colossalai.utils.profiler.prof_utils.rst new file mode 100644 index 000000000..9b34a8505 --- /dev/null +++ b/docs/colossalai/colossalai.utils.profiler.prof_utils.rst @@ -0,0 +1,5 @@ +colossalai.utils.profiler.prof\_utils +===================================== + +.. automodule:: colossalai.utils.profiler.prof_utils + :members: diff --git a/docs/colossalai/colossalai.utils.profiler.rst b/docs/colossalai/colossalai.utils.profiler.rst index d28ffe2bc..2b49c8186 100644 --- a/docs/colossalai/colossalai.utils.profiler.rst +++ b/docs/colossalai/colossalai.utils.profiler.rst @@ -1,5 +1,14 @@ colossalai.utils.profiler -======================= +========================= .. automodule:: colossalai.utils.profiler - :members: \ No newline at end of file + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.utils.profiler.comm_profiler + colossalai.utils.profiler.mem_profiler + colossalai.utils.profiler.pcie_profiler + colossalai.utils.profiler.prof_utils diff --git a/docs/colossalai/colossalai.utils.rst b/docs/colossalai/colossalai.utils.rst index 92ac3222a..f6a74fe4e 100644 --- a/docs/colossalai/colossalai.utils.rst +++ b/docs/colossalai/colossalai.utils.rst @@ -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 diff --git a/docs/colossalai/colossalai.utils.tensor_detector.rst b/docs/colossalai/colossalai.utils.tensor_detector.rst index 2708b5011..807d67e3a 100644 --- a/docs/colossalai/colossalai.utils.tensor_detector.rst +++ b/docs/colossalai/colossalai.utils.tensor_detector.rst @@ -1,5 +1,11 @@ colossalai.utils.tensor\_detector -======================= +================================= -.. automodule:: colossalai.utils.tensor_detector.tensor_detector - :members: \ No newline at end of file +.. automodule:: colossalai.utils.tensor_detector + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.utils.tensor_detector.tensor_detector diff --git a/docs/colossalai/colossalai.utils.tensor_detector.tensor_detector.rst b/docs/colossalai/colossalai.utils.tensor_detector.tensor_detector.rst new file mode 100644 index 000000000..991cea343 --- /dev/null +++ b/docs/colossalai/colossalai.utils.tensor_detector.tensor_detector.rst @@ -0,0 +1,5 @@ +colossalai.utils.tensor\_detector.tensor\_detector +================================================== + +.. automodule:: colossalai.utils.tensor_detector.tensor_detector + :members: diff --git a/docs/colossalai/colossalai.zero.init_ctx.init_context.rst b/docs/colossalai/colossalai.zero.init_ctx.init_context.rst new file mode 100644 index 000000000..1694074e8 --- /dev/null +++ b/docs/colossalai/colossalai.zero.init_ctx.init_context.rst @@ -0,0 +1,5 @@ +colossalai.zero.init\_ctx.init\_context +======================================= + +.. automodule:: colossalai.zero.init_ctx.init_context + :members: diff --git a/docs/colossalai/colossalai.zero.init_ctx.rst b/docs/colossalai/colossalai.zero.init_ctx.rst index 46a459685..88cf471df 100644 --- a/docs/colossalai/colossalai.zero.init_ctx.rst +++ b/docs/colossalai/colossalai.zero.init_ctx.rst @@ -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 diff --git a/docs/colossalai/colossalai.zero.shard_utils.base_shard_strategy.rst b/docs/colossalai/colossalai.zero.shard_utils.base_shard_strategy.rst new file mode 100644 index 000000000..d5b59e06a --- /dev/null +++ b/docs/colossalai/colossalai.zero.shard_utils.base_shard_strategy.rst @@ -0,0 +1,5 @@ +colossalai.zero.shard\_utils.base\_shard\_strategy +================================================== + +.. automodule:: colossalai.zero.shard_utils.base_shard_strategy + :members: diff --git a/docs/colossalai/colossalai.zero.shard_utils.bucket_tensor_shard_strategy.rst b/docs/colossalai/colossalai.zero.shard_utils.bucket_tensor_shard_strategy.rst new file mode 100644 index 000000000..952c5bbdd --- /dev/null +++ b/docs/colossalai/colossalai.zero.shard_utils.bucket_tensor_shard_strategy.rst @@ -0,0 +1,5 @@ +colossalai.zero.shard\_utils.bucket\_tensor\_shard\_strategy +============================================================ + +.. automodule:: colossalai.zero.shard_utils.bucket_tensor_shard_strategy + :members: diff --git a/docs/colossalai/colossalai.zero.shard_utils.commons.rst b/docs/colossalai/colossalai.zero.shard_utils.commons.rst new file mode 100644 index 000000000..aa6682d79 --- /dev/null +++ b/docs/colossalai/colossalai.zero.shard_utils.commons.rst @@ -0,0 +1,5 @@ +colossalai.zero.shard\_utils.commons +==================================== + +.. automodule:: colossalai.zero.shard_utils.commons + :members: diff --git a/docs/colossalai/colossalai.zero.shard_utils.rst b/docs/colossalai/colossalai.zero.shard_utils.rst index 10f5146c4..0b7ee8683 100644 --- a/docs/colossalai/colossalai.zero.shard_utils.rst +++ b/docs/colossalai/colossalai.zero.shard_utils.rst @@ -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 diff --git a/docs/colossalai/colossalai.zero.shard_utils.tensor_shard_strategy.rst b/docs/colossalai/colossalai.zero.shard_utils.tensor_shard_strategy.rst new file mode 100644 index 000000000..571b7bd7a --- /dev/null +++ b/docs/colossalai/colossalai.zero.shard_utils.tensor_shard_strategy.rst @@ -0,0 +1,5 @@ +colossalai.zero.shard\_utils.tensor\_shard\_strategy +==================================================== + +.. automodule:: colossalai.zero.shard_utils.tensor_shard_strategy + :members: diff --git a/docs/colossalai/colossalai.zero.shard_utils.tensor_utils.rst b/docs/colossalai/colossalai.zero.shard_utils.tensor_utils.rst new file mode 100644 index 000000000..84e66d514 --- /dev/null +++ b/docs/colossalai/colossalai.zero.shard_utils.tensor_utils.rst @@ -0,0 +1,5 @@ +colossalai.zero.shard\_utils.tensor\_utils +========================================== + +.. automodule:: colossalai.zero.shard_utils.tensor_utils + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_model.reduce_scatter.rst b/docs/colossalai/colossalai.zero.sharded_model.reduce_scatter.rst new file mode 100644 index 000000000..cf861ee70 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_model.reduce_scatter.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_model.reduce\_scatter +============================================== + +.. automodule:: colossalai.zero.sharded_model.reduce_scatter + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_model.rst b/docs/colossalai/colossalai.zero.sharded_model.rst index c2a959e58..fb3f5a845 100644 --- a/docs/colossalai/colossalai.zero.sharded_model.rst +++ b/docs/colossalai/colossalai.zero.sharded_model.rst @@ -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: \ No newline at end of file + colossalai.zero.sharded_model.reduce_scatter + colossalai.zero.sharded_model.sharded_model_v2 + colossalai.zero.sharded_model.utils diff --git a/docs/colossalai/colossalai.zero.sharded_model.sharded_model_v2.rst b/docs/colossalai/colossalai.zero.sharded_model.sharded_model_v2.rst new file mode 100644 index 000000000..a0e191377 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_model.sharded_model_v2.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_model.sharded\_model\_v2 +================================================= + +.. automodule:: colossalai.zero.sharded_model.sharded_model_v2 + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_model.utils.rst b/docs/colossalai/colossalai.zero.sharded_model.utils.rst new file mode 100644 index 000000000..5e3767742 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_model.utils.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_model.utils +==================================== + +.. automodule:: colossalai.zero.sharded_model.utils + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_optim.rst b/docs/colossalai/colossalai.zero.sharded_optim.rst index 86e299260..db3dfdddb 100644 --- a/docs/colossalai/colossalai.zero.sharded_optim.rst +++ b/docs/colossalai/colossalai.zero.sharded_optim.rst @@ -1,5 +1,11 @@ colossalai.zero.sharded\_optim -=============================== +============================== .. automodule:: colossalai.zero.sharded_optim :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.zero.sharded_optim.sharded_optim_v2 diff --git a/docs/colossalai/colossalai.zero.sharded_optim.sharded_optim_v2.rst b/docs/colossalai/colossalai.zero.sharded_optim.sharded_optim_v2.rst new file mode 100644 index 000000000..01fbe0c4c --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_optim.sharded_optim_v2.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_optim.sharded\_optim\_v2 +================================================= + +.. automodule:: colossalai.zero.sharded_optim.sharded_optim_v2 + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_param.rst b/docs/colossalai/colossalai.zero.sharded_param.rst index ccbb98a3e..f4a00cfd5 100644 --- a/docs/colossalai/colossalai.zero.sharded_param.rst +++ b/docs/colossalai/colossalai.zero.sharded_param.rst @@ -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 diff --git a/docs/colossalai/colossalai.zero.sharded_param.sharded_param.rst b/docs/colossalai/colossalai.zero.sharded_param.sharded_param.rst new file mode 100644 index 000000000..efa2f0de3 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_param.sharded_param.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_param.sharded\_param +============================================= + +.. automodule:: colossalai.zero.sharded_param.sharded_param + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_param.sharded_tensor.rst b/docs/colossalai/colossalai.zero.sharded_param.sharded_tensor.rst new file mode 100644 index 000000000..930c28de4 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_param.sharded_tensor.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_param.sharded\_tensor +============================================== + +.. automodule:: colossalai.zero.sharded_param.sharded_tensor + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_param.tensorful_state.rst b/docs/colossalai/colossalai.zero.sharded_param.tensorful_state.rst new file mode 100644 index 000000000..8dd3f7053 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_param.tensorful_state.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_param.tensorful\_state +=============================================== + +.. automodule:: colossalai.zero.sharded_param.tensorful_state + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_utils.rst b/docs/colossalai/colossalai.zero.sharded_utils.rst deleted file mode 100644 index ad375c24f..000000000 --- a/docs/colossalai/colossalai.zero.sharded_utils.rst +++ /dev/null @@ -1,5 +0,0 @@ -colossalai.zero.sharded\_utils -=============== - -.. automodule:: colossalai.zero.sharded_utils - :members: \ No newline at end of file