From 7e30068a22bb3bcc09bb92014b77e7e9dfa4573d Mon Sep 17 00:00:00 2001 From: ver217 Date: Mon, 21 Mar 2022 10:52:45 +0800 Subject: [PATCH] [doc] update rst (#470) * update rst * remove empty rst --- ...p.naive_amp.grad_scaler.base_grad_scaler.rst | 5 +++++ ...ive_amp.grad_scaler.constant_grad_scaler.rst | 5 +++++ ...aive_amp.grad_scaler.dynamic_grad_scaler.rst | 5 +++++ .../colossalai.amp.naive_amp.grad_scaler.rst | 13 +++++++++++++ docs/colossalai/colossalai.amp.naive_amp.rst | 5 +++++ docs/colossalai/colossalai.constants.rst | 5 +++++ .../colossalai.context.moe_context.rst | 5 +++++ docs/colossalai/colossalai.context.rst | 1 + docs/colossalai/colossalai.core.rst | 5 +++++ .../colossalai.engine.gradient_handler.rst | 6 ++++++ ...colossalai.engine.gradient_handler.utils.rst | 5 +++++ docs/colossalai/colossalai.engine.ophooks.rst | 11 +++++++++++ .../colossalai.engine.ophooks.zero_hook.rst | 5 +++++ .../colossalai/colossalai.engine.paramhooks.rst | 5 +++++ docs/colossalai/colossalai.engine.rst | 2 ++ docs/colossalai/colossalai.global_variables.rst | 5 +++++ .../colossalai.nn.layer.moe.experts.rst | 5 +++++ docs/colossalai/colossalai.nn.layer.moe.rst | 2 ++ .../colossalai.nn.layer.moe.utils.rst | 5 +++++ docs/colossalai/colossalai.nn.loss.loss_1d.rst | 5 +++++ docs/colossalai/colossalai.nn.loss.rst | 1 + .../colossalai.nn.optimizer.cpu_adam.rst | 5 +++++ docs/colossalai/colossalai.nn.optimizer.rst | 1 + docs/colossalai/colossalai.rst | 2 ++ .../colossalai.testing.comparison.rst | 5 +++++ docs/colossalai/colossalai.testing.rst | 12 ++++++++++++ docs/colossalai/colossalai.testing.utils.rst | 5 +++++ ...ossalai.utils.commons.bucket_tensor_copy.rst | 5 +++++ .../colossalai.utils.commons.memory.rst | 5 +++++ docs/colossalai/colossalai.utils.commons.rst | 13 +++++++++++++ .../colossalai.utils.commons.singleton_meta.rst | 5 +++++ ...colossalai.utils.memory_tracer.allocator.rst | 5 +++++ ...alai.utils.memory_tracer.async_memtracer.rst | 5 +++++ .../colossalai.utils.memory_tracer.commons.rst | 5 +++++ ...i.utils.memory_tracer.memstats_collector.rst | 5 +++++ ...utils.memory_tracer.model_data_memtracer.rst | 5 +++++ .../colossalai.utils.memory_tracer.rst | 17 +++++++++++++++++ ...utils.memory_tracer.test_async_memtracer.rst | 5 +++++ ...ls.memory_tracer.test_memstats_collector.rst | 5 +++++ docs/colossalai/colossalai.utils.moe.rst | 5 +++++ .../colossalai.utils.profiler.comm_profiler.rst | 5 +++++ .../colossalai.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 | 5 +++++ .../colossalai.utils.tensor_detector.rst | 11 +++++++++++ ...ai.utils.tensor_detector.tensor_detector.rst | 5 +++++ .../colossalai.zero.init_ctx.init_context.rst | 5 +++++ docs/colossalai/colossalai.zero.init_ctx.rst | 11 +++++++++++ docs/colossalai/colossalai.zero.loss_scaler.rst | 5 ----- docs/colossalai/colossalai.zero.rst | 9 +++++---- ...lai.zero.shard_utils.base_shard_strategy.rst | 5 +++++ ...shard_utils.bucket_tensor_shard_strategy.rst | 5 +++++ docs/colossalai/colossalai.zero.shard_utils.rst | 13 +++++++++++++ ...i.zero.shard_utils.tensor_shard_strategy.rst | 5 +++++ ...ossalai.zero.sharded_model.param_manager.rst | 5 +++++ ...ssalai.zero.sharded_model.reduce_scatter.rst | 5 +++++ .../colossalai.zero.sharded_model.rst | 16 ++++++++++++++++ ...lossalai.zero.sharded_model.sharded_grad.rst | 5 +++++ ...ossalai.zero.sharded_model.sharded_model.rst | 5 +++++ ...alai.zero.sharded_model.sharded_model_v2.rst | 5 +++++ .../colossalai.zero.sharded_model.utils.rst | 5 +++++ ...ero.sharded_optim.bookkeeping.base_store.rst | 5 +++++ ...o.sharded_optim.bookkeeping.bucket_store.rst | 5 +++++ ...sharded_optim.bookkeeping.gradient_store.rst | 5 +++++ ...harded_optim.bookkeeping.parameter_store.rst | 5 +++++ ...olossalai.zero.sharded_optim.bookkeeping.rst | 15 +++++++++++++++ ....sharded_optim.bookkeeping.tensor_bucket.rst | 5 +++++ .../colossalai.zero.sharded_optim.rst | 17 +++++++++++++++++ ...ossalai.zero.sharded_optim.sharded_optim.rst | 5 +++++ ...alai.zero.sharded_optim.sharded_optim_v2.rst | 5 +++++ .../colossalai.zero.sharded_param.rst | 12 ++++++++++++ ...ossalai.zero.sharded_param.sharded_param.rst | 5 +++++ ...ssalai.zero.sharded_param.sharded_tensor.rst | 5 +++++ ...i.zero.zero_redundancy_optimizer_level_2.rst | 5 ----- ...i.zero.zero_redundancy_optimizer_level_3.rst | 5 ----- 76 files changed, 454 insertions(+), 19 deletions(-) create mode 100644 docs/colossalai/colossalai.amp.naive_amp.grad_scaler.base_grad_scaler.rst create mode 100644 docs/colossalai/colossalai.amp.naive_amp.grad_scaler.constant_grad_scaler.rst create mode 100644 docs/colossalai/colossalai.amp.naive_amp.grad_scaler.dynamic_grad_scaler.rst create mode 100644 docs/colossalai/colossalai.amp.naive_amp.grad_scaler.rst create mode 100644 docs/colossalai/colossalai.constants.rst create mode 100644 docs/colossalai/colossalai.context.moe_context.rst create mode 100644 docs/colossalai/colossalai.core.rst create mode 100644 docs/colossalai/colossalai.engine.gradient_handler.utils.rst create mode 100644 docs/colossalai/colossalai.engine.ophooks.rst create mode 100644 docs/colossalai/colossalai.engine.ophooks.zero_hook.rst create mode 100644 docs/colossalai/colossalai.engine.paramhooks.rst create mode 100644 docs/colossalai/colossalai.global_variables.rst create mode 100644 docs/colossalai/colossalai.nn.layer.moe.experts.rst create mode 100644 docs/colossalai/colossalai.nn.layer.moe.utils.rst create mode 100644 docs/colossalai/colossalai.nn.loss.loss_1d.rst create mode 100644 docs/colossalai/colossalai.nn.optimizer.cpu_adam.rst create mode 100644 docs/colossalai/colossalai.testing.comparison.rst create mode 100644 docs/colossalai/colossalai.testing.rst create mode 100644 docs/colossalai/colossalai.testing.utils.rst create mode 100644 docs/colossalai/colossalai.utils.commons.bucket_tensor_copy.rst create mode 100644 docs/colossalai/colossalai.utils.commons.memory.rst create mode 100644 docs/colossalai/colossalai.utils.commons.rst create mode 100644 docs/colossalai/colossalai.utils.commons.singleton_meta.rst create mode 100644 docs/colossalai/colossalai.utils.memory_tracer.allocator.rst create mode 100644 docs/colossalai/colossalai.utils.memory_tracer.async_memtracer.rst create mode 100644 docs/colossalai/colossalai.utils.memory_tracer.commons.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_tracer.rst create mode 100644 docs/colossalai/colossalai.utils.memory_tracer.test_async_memtracer.rst create mode 100644 docs/colossalai/colossalai.utils.memory_tracer.test_memstats_collector.rst create mode 100644 docs/colossalai/colossalai.utils.moe.rst create mode 100644 docs/colossalai/colossalai.utils.profiler.comm_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.profiler.rst create mode 100644 docs/colossalai/colossalai.utils.tensor_detector.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.init_ctx.rst delete mode 100644 docs/colossalai/colossalai.zero.loss_scaler.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.rst create mode 100644 docs/colossalai/colossalai.zero.shard_utils.tensor_shard_strategy.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_model.param_manager.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_model.reduce_scatter.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_model.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_model.sharded_grad.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_model.sharded_model.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.bookkeeping.base_store.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.bucket_store.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.gradient_store.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.parameter_store.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.tensor_bucket.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_optim.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_optim.sharded_optim.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_optim.sharded_optim_v2.rst create mode 100644 docs/colossalai/colossalai.zero.sharded_param.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 delete mode 100644 docs/colossalai/colossalai.zero.zero_redundancy_optimizer_level_2.rst delete mode 100644 docs/colossalai/colossalai.zero.zero_redundancy_optimizer_level_3.rst diff --git a/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.base_grad_scaler.rst b/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.base_grad_scaler.rst new file mode 100644 index 000000000..a796d4947 --- /dev/null +++ b/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.base_grad_scaler.rst @@ -0,0 +1,5 @@ +colossalai.amp.naive\_amp.grad\_scaler.base\_grad\_scaler +========================================================= + +.. automodule:: colossalai.amp.naive_amp.grad_scaler.base_grad_scaler + :members: diff --git a/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.constant_grad_scaler.rst b/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.constant_grad_scaler.rst new file mode 100644 index 000000000..b506ca06d --- /dev/null +++ b/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.constant_grad_scaler.rst @@ -0,0 +1,5 @@ +colossalai.amp.naive\_amp.grad\_scaler.constant\_grad\_scaler +============================================================= + +.. automodule:: colossalai.amp.naive_amp.grad_scaler.constant_grad_scaler + :members: diff --git a/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.dynamic_grad_scaler.rst b/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.dynamic_grad_scaler.rst new file mode 100644 index 000000000..731c1185b --- /dev/null +++ b/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.dynamic_grad_scaler.rst @@ -0,0 +1,5 @@ +colossalai.amp.naive\_amp.grad\_scaler.dynamic\_grad\_scaler +============================================================ + +.. automodule:: colossalai.amp.naive_amp.grad_scaler.dynamic_grad_scaler + :members: diff --git a/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.rst b/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.rst new file mode 100644 index 000000000..4587e2909 --- /dev/null +++ b/docs/colossalai/colossalai.amp.naive_amp.grad_scaler.rst @@ -0,0 +1,13 @@ +colossalai.amp.naive\_amp.grad\_scaler +====================================== + +.. automodule:: colossalai.amp.naive_amp.grad_scaler + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.amp.naive_amp.grad_scaler.base_grad_scaler + colossalai.amp.naive_amp.grad_scaler.constant_grad_scaler + colossalai.amp.naive_amp.grad_scaler.dynamic_grad_scaler diff --git a/docs/colossalai/colossalai.amp.naive_amp.rst b/docs/colossalai/colossalai.amp.naive_amp.rst index 15917e174..fd364c053 100644 --- a/docs/colossalai/colossalai.amp.naive_amp.rst +++ b/docs/colossalai/colossalai.amp.naive_amp.rst @@ -4,6 +4,11 @@ colossalai.amp.naive\_amp .. automodule:: colossalai.amp.naive_amp :members: +.. toctree:: + :maxdepth: 2 + + colossalai.amp.naive_amp.grad_scaler + .. 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 new file mode 100644 index 000000000..9027d19ff --- /dev/null +++ b/docs/colossalai/colossalai.context.moe_context.rst @@ -0,0 +1,5 @@ +colossalai.context.moe\_context +=============================== + +.. automodule:: colossalai.context.moe_context + :members: diff --git a/docs/colossalai/colossalai.context.rst b/docs/colossalai/colossalai.context.rst index babab5099..30ad8b3a5 100644 --- a/docs/colossalai/colossalai.context.rst +++ b/docs/colossalai/colossalai.context.rst @@ -15,5 +15,6 @@ colossalai.context :maxdepth: 2 colossalai.context.config + colossalai.context.moe_context colossalai.context.parallel_context colossalai.context.parallel_mode 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.gradient_handler.rst b/docs/colossalai/colossalai.engine.gradient_handler.rst index d7d1633a6..27eb2b56a 100644 --- a/docs/colossalai/colossalai.engine.gradient_handler.rst +++ b/docs/colossalai/colossalai.engine.gradient_handler.rst @@ -3,3 +3,9 @@ colossalai.engine.gradient\_handler .. automodule:: colossalai.engine.gradient_handler :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.engine.gradient_handler.utils diff --git a/docs/colossalai/colossalai.engine.gradient_handler.utils.rst b/docs/colossalai/colossalai.engine.gradient_handler.utils.rst new file mode 100644 index 000000000..c8997e135 --- /dev/null +++ b/docs/colossalai/colossalai.engine.gradient_handler.utils.rst @@ -0,0 +1,5 @@ +colossalai.engine.gradient\_handler.utils +========================================= + +.. automodule:: colossalai.engine.gradient_handler.utils + :members: diff --git a/docs/colossalai/colossalai.engine.ophooks.rst b/docs/colossalai/colossalai.engine.ophooks.rst new file mode 100644 index 000000000..f4b8a8396 --- /dev/null +++ b/docs/colossalai/colossalai.engine.ophooks.rst @@ -0,0 +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 new file mode 100644 index 000000000..2164bd91d --- /dev/null +++ b/docs/colossalai/colossalai.engine.paramhooks.rst @@ -0,0 +1,5 @@ +colossalai.engine.paramhooks +============================ + +.. automodule:: colossalai.engine.paramhooks + :members: diff --git a/docs/colossalai/colossalai.engine.rst b/docs/colossalai/colossalai.engine.rst index f41c21e67..eaa8b03ea 100644 --- a/docs/colossalai/colossalai.engine.rst +++ b/docs/colossalai/colossalai.engine.rst @@ -8,4 +8,6 @@ colossalai.engine :maxdepth: 2 colossalai.engine.gradient_handler + 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.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.rst b/docs/colossalai/colossalai.nn.layer.moe.rst index 403d39817..f3106b98d 100644 --- a/docs/colossalai/colossalai.nn.layer.moe.rst +++ b/docs/colossalai/colossalai.nn.layer.moe.rst @@ -8,4 +8,6 @@ colossalai.nn.layer.moe .. 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.loss.loss_1d.rst b/docs/colossalai/colossalai.nn.loss.loss_1d.rst new file mode 100644 index 000000000..d9ac2e67d --- /dev/null +++ b/docs/colossalai/colossalai.nn.loss.loss_1d.rst @@ -0,0 +1,5 @@ +colossalai.nn.loss.loss\_1d +=========================== + +.. automodule:: colossalai.nn.loss.loss_1d + :members: diff --git a/docs/colossalai/colossalai.nn.loss.rst b/docs/colossalai/colossalai.nn.loss.rst index 5677b7448..5df7d1ae3 100644 --- a/docs/colossalai/colossalai.nn.loss.rst +++ b/docs/colossalai/colossalai.nn.loss.rst @@ -8,6 +8,7 @@ colossalai.nn.loss .. toctree:: :maxdepth: 2 + colossalai.nn.loss.loss_1d colossalai.nn.loss.loss_2d colossalai.nn.loss.loss_2p5d colossalai.nn.loss.loss_3d diff --git a/docs/colossalai/colossalai.nn.optimizer.cpu_adam.rst b/docs/colossalai/colossalai.nn.optimizer.cpu_adam.rst new file mode 100644 index 000000000..224dfab43 --- /dev/null +++ b/docs/colossalai/colossalai.nn.optimizer.cpu_adam.rst @@ -0,0 +1,5 @@ +colossalai.nn.optimizer.cpu\_adam +================================= + +.. automodule:: colossalai.nn.optimizer.cpu_adam + :members: diff --git a/docs/colossalai/colossalai.nn.optimizer.rst b/docs/colossalai/colossalai.nn.optimizer.rst index 7fbd81406..f1c4e722b 100644 --- a/docs/colossalai/colossalai.nn.optimizer.rst +++ b/docs/colossalai/colossalai.nn.optimizer.rst @@ -9,6 +9,7 @@ colossalai.nn.optimizer :maxdepth: 2 colossalai.nn.optimizer.colossalai_optimizer + colossalai.nn.optimizer.cpu_adam colossalai.nn.optimizer.fused_adam colossalai.nn.optimizer.fused_lamb colossalai.nn.optimizer.fused_sgd diff --git a/docs/colossalai/colossalai.rst b/docs/colossalai/colossalai.rst index eca3e273a..b86475b9e 100644 --- a/docs/colossalai/colossalai.rst +++ b/docs/colossalai/colossalai.rst @@ -16,6 +16,7 @@ colossalai colossalai.logging colossalai.nn colossalai.registry + colossalai.testing colossalai.trainer colossalai.utils colossalai.zero @@ -24,4 +25,5 @@ colossalai .. toctree:: :maxdepth: 2 + colossalai.global_variables colossalai.initialize 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 new file mode 100644 index 000000000..1127aa52c --- /dev/null +++ b/docs/colossalai/colossalai.testing.rst @@ -0,0 +1,12 @@ +colossalai.testing +================== + +.. automodule:: colossalai.testing + :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.commons.bucket_tensor_copy.rst b/docs/colossalai/colossalai.utils.commons.bucket_tensor_copy.rst new file mode 100644 index 000000000..8b96215c5 --- /dev/null +++ b/docs/colossalai/colossalai.utils.commons.bucket_tensor_copy.rst @@ -0,0 +1,5 @@ +colossalai.utils.commons.bucket\_tensor\_copy +============================================= + +.. automodule:: colossalai.utils.commons.bucket_tensor_copy + :members: diff --git a/docs/colossalai/colossalai.utils.commons.memory.rst b/docs/colossalai/colossalai.utils.commons.memory.rst new file mode 100644 index 000000000..9095177f4 --- /dev/null +++ b/docs/colossalai/colossalai.utils.commons.memory.rst @@ -0,0 +1,5 @@ +colossalai.utils.commons.memory +=============================== + +.. automodule:: colossalai.utils.commons.memory + :members: diff --git a/docs/colossalai/colossalai.utils.commons.rst b/docs/colossalai/colossalai.utils.commons.rst new file mode 100644 index 000000000..b608aadb7 --- /dev/null +++ b/docs/colossalai/colossalai.utils.commons.rst @@ -0,0 +1,13 @@ +colossalai.utils.commons +======================== + +.. automodule:: colossalai.utils.commons + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.utils.commons.bucket_tensor_copy + colossalai.utils.commons.memory + colossalai.utils.commons.singleton_meta diff --git a/docs/colossalai/colossalai.utils.commons.singleton_meta.rst b/docs/colossalai/colossalai.utils.commons.singleton_meta.rst new file mode 100644 index 000000000..a0149ceee --- /dev/null +++ b/docs/colossalai/colossalai.utils.commons.singleton_meta.rst @@ -0,0 +1,5 @@ +colossalai.utils.commons.singleton\_meta +======================================== + +.. automodule:: colossalai.utils.commons.singleton_meta + :members: diff --git a/docs/colossalai/colossalai.utils.memory_tracer.allocator.rst b/docs/colossalai/colossalai.utils.memory_tracer.allocator.rst new file mode 100644 index 000000000..61add2f97 --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_tracer.allocator.rst @@ -0,0 +1,5 @@ +colossalai.utils.memory\_tracer.allocator +========================================= + +.. automodule:: colossalai.utils.memory_tracer.allocator + :members: 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.commons.rst b/docs/colossalai/colossalai.utils.memory_tracer.commons.rst new file mode 100644 index 000000000..015664cb5 --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_tracer.commons.rst @@ -0,0 +1,5 @@ +colossalai.utils.memory\_tracer.commons +======================================= + +.. automodule:: colossalai.utils.memory_tracer.commons + :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 new file mode 100644 index 000000000..01598ae59 --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_tracer.rst @@ -0,0 +1,17 @@ +colossalai.utils.memory\_tracer +=============================== + +.. automodule:: colossalai.utils.memory_tracer + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.utils.memory_tracer.allocator + colossalai.utils.memory_tracer.async_memtracer + colossalai.utils.memory_tracer.commons + colossalai.utils.memory_tracer.memstats_collector + colossalai.utils.memory_tracer.model_data_memtracer + colossalai.utils.memory_tracer.test_async_memtracer + colossalai.utils.memory_tracer.test_memstats_collector diff --git a/docs/colossalai/colossalai.utils.memory_tracer.test_async_memtracer.rst b/docs/colossalai/colossalai.utils.memory_tracer.test_async_memtracer.rst new file mode 100644 index 000000000..e9c379f33 --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_tracer.test_async_memtracer.rst @@ -0,0 +1,5 @@ +colossalai.utils.memory\_tracer.test\_async\_memtracer +====================================================== + +.. automodule:: colossalai.utils.memory_tracer.test_async_memtracer + :members: diff --git a/docs/colossalai/colossalai.utils.memory_tracer.test_memstats_collector.rst b/docs/colossalai/colossalai.utils.memory_tracer.test_memstats_collector.rst new file mode 100644 index 000000000..10681e18d --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_tracer.test_memstats_collector.rst @@ -0,0 +1,5 @@ +colossalai.utils.memory\_tracer.test\_memstats\_collector +========================================================= + +.. automodule:: colossalai.utils.memory_tracer.test_memstats_collector + :members: diff --git a/docs/colossalai/colossalai.utils.moe.rst b/docs/colossalai/colossalai.utils.moe.rst new file mode 100644 index 000000000..b66ccdc8e --- /dev/null +++ b/docs/colossalai/colossalai.utils.moe.rst @@ -0,0 +1,5 @@ +colossalai.utils.moe +==================== + +.. automodule:: colossalai.utils.moe + :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.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 new file mode 100644 index 000000000..1035dbced --- /dev/null +++ b/docs/colossalai/colossalai.utils.profiler.rst @@ -0,0 +1,13 @@ +colossalai.utils.profiler +========================= + +.. automodule:: colossalai.utils.profiler + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.utils.profiler.comm_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 5a7d2ea5c..7f7f58bbf 100644 --- a/docs/colossalai/colossalai.utils.rst +++ b/docs/colossalai/colossalai.utils.rst @@ -7,9 +7,13 @@ colossalai.utils .. toctree:: :maxdepth: 2 + colossalai.utils.commons colossalai.utils.data_sampler colossalai.utils.gradient_accumulation + colossalai.utils.memory_tracer colossalai.utils.multi_tensor_apply + colossalai.utils.profiler + colossalai.utils.tensor_detector .. toctree:: @@ -20,4 +24,5 @@ colossalai.utils 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 new file mode 100644 index 000000000..807d67e3a --- /dev/null +++ b/docs/colossalai/colossalai.utils.tensor_detector.rst @@ -0,0 +1,11 @@ +colossalai.utils.tensor\_detector +================================= + +.. 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 new file mode 100644 index 000000000..88cf471df --- /dev/null +++ b/docs/colossalai/colossalai.zero.init_ctx.rst @@ -0,0 +1,11 @@ +colossalai.zero.init\_ctx +========================= + +.. automodule:: colossalai.zero.init_ctx + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.zero.init_ctx.init_context diff --git a/docs/colossalai/colossalai.zero.loss_scaler.rst b/docs/colossalai/colossalai.zero.loss_scaler.rst deleted file mode 100644 index 71c4d4446..000000000 --- a/docs/colossalai/colossalai.zero.loss_scaler.rst +++ /dev/null @@ -1,5 +0,0 @@ -colossalai.zero.loss\_scaler -============================ - -.. automodule:: colossalai.zero.loss_scaler - :members: diff --git a/docs/colossalai/colossalai.zero.rst b/docs/colossalai/colossalai.zero.rst index 136c3c51e..7a2bf227d 100644 --- a/docs/colossalai/colossalai.zero.rst +++ b/docs/colossalai/colossalai.zero.rst @@ -4,10 +4,11 @@ colossalai.zero .. automodule:: colossalai.zero :members: - .. toctree:: :maxdepth: 2 - colossalai.zero.loss_scaler - colossalai.zero.zero_redundancy_optimizer_level_2 - colossalai.zero.zero_redundancy_optimizer_level_3 + colossalai.zero.init_ctx + colossalai.zero.shard_utils + colossalai.zero.sharded_model + colossalai.zero.sharded_optim + colossalai.zero.sharded_param 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.rst b/docs/colossalai/colossalai.zero.shard_utils.rst new file mode 100644 index 000000000..0a7899c64 --- /dev/null +++ b/docs/colossalai/colossalai.zero.shard_utils.rst @@ -0,0 +1,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.tensor_shard_strategy 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.sharded_model.param_manager.rst b/docs/colossalai/colossalai.zero.sharded_model.param_manager.rst new file mode 100644 index 000000000..7692f598d --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_model.param_manager.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_model.param\_manager +============================================= + +.. automodule:: colossalai.zero.sharded_model.param_manager + :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 new file mode 100644 index 000000000..07660ff8b --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_model.rst @@ -0,0 +1,16 @@ +colossalai.zero.sharded\_model +============================== + +.. automodule:: colossalai.zero.sharded_model + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.zero.sharded_model.param_manager + colossalai.zero.sharded_model.reduce_scatter + colossalai.zero.sharded_model.sharded_grad + colossalai.zero.sharded_model.sharded_model + colossalai.zero.sharded_model.sharded_model_v2 + colossalai.zero.sharded_model.utils diff --git a/docs/colossalai/colossalai.zero.sharded_model.sharded_grad.rst b/docs/colossalai/colossalai.zero.sharded_model.sharded_grad.rst new file mode 100644 index 000000000..28607b68e --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_model.sharded_grad.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_model.sharded\_grad +============================================ + +.. automodule:: colossalai.zero.sharded_model.sharded_grad + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_model.sharded_model.rst b/docs/colossalai/colossalai.zero.sharded_model.sharded_model.rst new file mode 100644 index 000000000..e61f6729f --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_model.sharded_model.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_model.sharded\_model +============================================= + +.. automodule:: colossalai.zero.sharded_model.sharded_model + :members: 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.bookkeeping.base_store.rst b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.base_store.rst new file mode 100644 index 000000000..5010367b8 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.base_store.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_optim.bookkeeping.base\_store +====================================================== + +.. automodule:: colossalai.zero.sharded_optim.bookkeeping.base_store + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.bucket_store.rst b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.bucket_store.rst new file mode 100644 index 000000000..7a89a615a --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.bucket_store.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_optim.bookkeeping.bucket\_store +======================================================== + +.. automodule:: colossalai.zero.sharded_optim.bookkeeping.bucket_store + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.gradient_store.rst b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.gradient_store.rst new file mode 100644 index 000000000..ef176e445 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.gradient_store.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_optim.bookkeeping.gradient\_store +========================================================== + +.. automodule:: colossalai.zero.sharded_optim.bookkeeping.gradient_store + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.parameter_store.rst b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.parameter_store.rst new file mode 100644 index 000000000..86ffec727 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.parameter_store.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_optim.bookkeeping.parameter\_store +=========================================================== + +.. automodule:: colossalai.zero.sharded_optim.bookkeeping.parameter_store + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.rst b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.rst new file mode 100644 index 000000000..a0f0bf110 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.rst @@ -0,0 +1,15 @@ +colossalai.zero.sharded\_optim.bookkeeping +========================================== + +.. automodule:: colossalai.zero.sharded_optim.bookkeeping + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.zero.sharded_optim.bookkeeping.base_store + colossalai.zero.sharded_optim.bookkeeping.bucket_store + colossalai.zero.sharded_optim.bookkeeping.gradient_store + colossalai.zero.sharded_optim.bookkeeping.parameter_store + colossalai.zero.sharded_optim.bookkeeping.tensor_bucket diff --git a/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.tensor_bucket.rst b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.tensor_bucket.rst new file mode 100644 index 000000000..b39ec95ac --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.tensor_bucket.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_optim.bookkeeping.tensor\_bucket +========================================================= + +.. automodule:: colossalai.zero.sharded_optim.bookkeeping.tensor_bucket + :members: diff --git a/docs/colossalai/colossalai.zero.sharded_optim.rst b/docs/colossalai/colossalai.zero.sharded_optim.rst new file mode 100644 index 000000000..4b4a167c3 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_optim.rst @@ -0,0 +1,17 @@ +colossalai.zero.sharded\_optim +============================== + +.. automodule:: colossalai.zero.sharded_optim + :members: + +.. toctree:: + :maxdepth: 2 + + colossalai.zero.sharded_optim.bookkeeping + + +.. toctree:: + :maxdepth: 2 + + colossalai.zero.sharded_optim.sharded_optim + colossalai.zero.sharded_optim.sharded_optim_v2 diff --git a/docs/colossalai/colossalai.zero.sharded_optim.sharded_optim.rst b/docs/colossalai/colossalai.zero.sharded_optim.sharded_optim.rst new file mode 100644 index 000000000..4ee9acade --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_optim.sharded_optim.rst @@ -0,0 +1,5 @@ +colossalai.zero.sharded\_optim.sharded\_optim +============================================= + +.. automodule:: colossalai.zero.sharded_optim.sharded_optim + :members: 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 new file mode 100644 index 000000000..02e0fc6c2 --- /dev/null +++ b/docs/colossalai/colossalai.zero.sharded_param.rst @@ -0,0 +1,12 @@ +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 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.zero_redundancy_optimizer_level_2.rst b/docs/colossalai/colossalai.zero.zero_redundancy_optimizer_level_2.rst deleted file mode 100644 index 5929d5c12..000000000 --- a/docs/colossalai/colossalai.zero.zero_redundancy_optimizer_level_2.rst +++ /dev/null @@ -1,5 +0,0 @@ -colossalai.zero.zero\_redundancy\_optimizer\_level\_2 -===================================================== - -.. automodule:: colossalai.zero.zero_redundancy_optimizer_level_2 - :members: diff --git a/docs/colossalai/colossalai.zero.zero_redundancy_optimizer_level_3.rst b/docs/colossalai/colossalai.zero.zero_redundancy_optimizer_level_3.rst deleted file mode 100644 index 063dba60b..000000000 --- a/docs/colossalai/colossalai.zero.zero_redundancy_optimizer_level_3.rst +++ /dev/null @@ -1,5 +0,0 @@ -colossalai.zero.zero\_redundancy\_optimizer\_level\_3 -===================================================== - -.. automodule:: colossalai.zero.zero_redundancy_optimizer_level_3 - :members: