github
/
ColossalAI
mirror of https://github.com/hpcaitech/ColossalAI
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[doc] update rst (#470) 

* update rst

* remove empty rst
pull/472/head
ver217 2022-03-21 10:52:45 +08:00 committed by GitHub
parent aff9d354f7
commit 7e30068a22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
76 changed files with 454 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/colossalai/colossalai.amp.naive_amp.grad_scaler.base_grad_scaler.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.amp.naive\_amp.grad\_scaler.base\_grad\_scaler
=========================================================
.. automodule:: colossalai.amp.naive_amp.grad_scaler.base_grad_scaler
:members:

5
docs/colossalai/colossalai.amp.naive_amp.grad_scaler.constant_grad_scaler.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.amp.naive\_amp.grad\_scaler.constant\_grad\_scaler
=============================================================
.. automodule:: colossalai.amp.naive_amp.grad_scaler.constant_grad_scaler
:members:

5
docs/colossalai/colossalai.amp.naive_amp.grad_scaler.dynamic_grad_scaler.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.amp.naive\_amp.grad\_scaler.dynamic\_grad\_scaler
============================================================
.. automodule:: colossalai.amp.naive_amp.grad_scaler.dynamic_grad_scaler
:members:

13
docs/colossalai/colossalai.amp.naive_amp.grad_scaler.rst Normal file
View File

@ -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

5
docs/colossalai/colossalai.amp.naive_amp.rst
View File

@ -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

5
docs/colossalai/colossalai.constants.rst Normal file
View File

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

5
docs/colossalai/colossalai.context.moe_context.rst Normal file
View File

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

1
docs/colossalai/colossalai.context.rst
View File

@ -15,5 +15,6 @@ colossalai.context
:maxdepth: 2
colossalai.context.config
colossalai.context.moe_context
colossalai.context.parallel_context
colossalai.context.parallel_mode

5
docs/colossalai/colossalai.core.rst Normal file
View File

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

6
docs/colossalai/colossalai.engine.gradient_handler.rst
View File

@ -3,3 +3,9 @@ colossalai.engine.gradient\_handler
.. automodule:: colossalai.engine.gradient_handler
:members:
.. toctree::
:maxdepth: 2
colossalai.engine.gradient_handler.utils

5
docs/colossalai/colossalai.engine.gradient_handler.utils.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.engine.gradient\_handler.utils
=========================================
.. automodule:: colossalai.engine.gradient_handler.utils
:members:

11
docs/colossalai/colossalai.engine.ophooks.rst Normal file
View File

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

5
docs/colossalai/colossalai.engine.ophooks.zero_hook.rst Normal file
View File

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

5
docs/colossalai/colossalai.engine.paramhooks.rst Normal file
View File

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

2
docs/colossalai/colossalai.engine.rst
View File

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

5
docs/colossalai/colossalai.global_variables.rst Normal file
View File

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

5
docs/colossalai/colossalai.nn.layer.moe.experts.rst Normal file
View File

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

2
docs/colossalai/colossalai.nn.layer.moe.rst
View File

@ -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

5
docs/colossalai/colossalai.nn.layer.moe.utils.rst Normal file
View File

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

5
docs/colossalai/colossalai.nn.loss.loss_1d.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.nn.loss.loss\_1d
===========================
.. automodule:: colossalai.nn.loss.loss_1d
:members:

1
docs/colossalai/colossalai.nn.loss.rst
View File

@ -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

5
docs/colossalai/colossalai.nn.optimizer.cpu_adam.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.nn.optimizer.cpu\_adam
=================================
.. automodule:: colossalai.nn.optimizer.cpu_adam
:members:

1
docs/colossalai/colossalai.nn.optimizer.rst
View File

@ -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

2
docs/colossalai/colossalai.rst
View File

@ -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

5
docs/colossalai/colossalai.testing.comparison.rst Normal file
View File

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

12
docs/colossalai/colossalai.testing.rst Normal file
View File

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

5
docs/colossalai/colossalai.testing.utils.rst Normal file
View File

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

5
docs/colossalai/colossalai.utils.commons.bucket_tensor_copy.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.utils.commons.bucket\_tensor\_copy
=============================================
.. automodule:: colossalai.utils.commons.bucket_tensor_copy
:members:

5
docs/colossalai/colossalai.utils.commons.memory.rst Normal file
View File

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

13
docs/colossalai/colossalai.utils.commons.rst Normal file
View File

@ -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

5
docs/colossalai/colossalai.utils.commons.singleton_meta.rst Normal file
View File

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

5
docs/colossalai/colossalai.utils.memory_tracer.allocator.rst Normal file
View File

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

5
docs/colossalai/colossalai.utils.memory_tracer.async_memtracer.rst Normal file
View File

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

5
docs/colossalai/colossalai.utils.memory_tracer.commons.rst Normal file
View File

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

5
docs/colossalai/colossalai.utils.memory_tracer.memstats_collector.rst Normal file
View File

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

5
docs/colossalai/colossalai.utils.memory_tracer.model_data_memtracer.rst Normal file
View File

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

17
docs/colossalai/colossalai.utils.memory_tracer.rst Normal file
View File

@ -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

5
docs/colossalai/colossalai.utils.memory_tracer.test_async_memtracer.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.utils.memory\_tracer.test\_async\_memtracer
======================================================
.. automodule:: colossalai.utils.memory_tracer.test_async_memtracer
:members:

5
docs/colossalai/colossalai.utils.memory_tracer.test_memstats_collector.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.utils.memory\_tracer.test\_memstats\_collector
=========================================================
.. automodule:: colossalai.utils.memory_tracer.test_memstats_collector
:members:

5
docs/colossalai/colossalai.utils.moe.rst Normal file
View File

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

5
docs/colossalai/colossalai.utils.profiler.comm_profiler.rst Normal file
View File

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

5
docs/colossalai/colossalai.utils.profiler.pcie_profiler.rst Normal file
View File

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

5
docs/colossalai/colossalai.utils.profiler.prof_utils.rst Normal file
View File

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

13
docs/colossalai/colossalai.utils.profiler.rst Normal file
View File

@ -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

5
docs/colossalai/colossalai.utils.rst
View File

@ -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

11
docs/colossalai/colossalai.utils.tensor_detector.rst Normal file
View File

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

5
docs/colossalai/colossalai.utils.tensor_detector.tensor_detector.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.init_ctx.init_context.rst Normal file
View File

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

11
docs/colossalai/colossalai.zero.init_ctx.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.loss_scaler.rst
View File

@ -1,5 +0,0 @@
colossalai.zero.loss\_scaler
============================
.. automodule:: colossalai.zero.loss_scaler
:members:

9
docs/colossalai/colossalai.zero.rst
View File

@ -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

5
docs/colossalai/colossalai.zero.shard_utils.base_shard_strategy.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.shard_utils.bucket_tensor_shard_strategy.rst Normal file
View File

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

13
docs/colossalai/colossalai.zero.shard_utils.rst Normal file
View File

@ -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

5
docs/colossalai/colossalai.zero.shard_utils.tensor_shard_strategy.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.sharded_model.param_manager.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.sharded_model.reduce_scatter.rst Normal file
View File

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

16
docs/colossalai/colossalai.zero.sharded_model.rst Normal file
View File

@ -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

5
docs/colossalai/colossalai.zero.sharded_model.sharded_grad.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.sharded_model.sharded_model.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.sharded_model.sharded_model_v2.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.sharded_model.utils.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.base_store.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_optim.bookkeeping.base\_store
======================================================
.. automodule:: colossalai.zero.sharded_optim.bookkeeping.base_store
:members:

5
docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.bucket_store.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_optim.bookkeeping.bucket\_store
========================================================
.. automodule:: colossalai.zero.sharded_optim.bookkeeping.bucket_store
:members:

5
docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.gradient_store.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_optim.bookkeeping.gradient\_store
==========================================================
.. automodule:: colossalai.zero.sharded_optim.bookkeeping.gradient_store
:members:

5
docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.parameter_store.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_optim.bookkeeping.parameter\_store
===========================================================
.. automodule:: colossalai.zero.sharded_optim.bookkeeping.parameter_store
:members:

15
docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.rst Normal file
View File

@ -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

5
docs/colossalai/colossalai.zero.sharded_optim.bookkeeping.tensor_bucket.rst Normal file
View File

@ -0,0 +1,5 @@
colossalai.zero.sharded\_optim.bookkeeping.tensor\_bucket
=========================================================
.. automodule:: colossalai.zero.sharded_optim.bookkeeping.tensor_bucket
:members:

17
docs/colossalai/colossalai.zero.sharded_optim.rst Normal file
View File

@ -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

5
docs/colossalai/colossalai.zero.sharded_optim.sharded_optim.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.sharded_optim.sharded_optim_v2.rst Normal file
View File

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

12
docs/colossalai/colossalai.zero.sharded_param.rst Normal file
View File

@ -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

5
docs/colossalai/colossalai.zero.sharded_param.sharded_param.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.sharded_param.sharded_tensor.rst Normal file
View File

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

5
docs/colossalai/colossalai.zero.zero_redundancy_optimizer_level_2.rst
View File

@ -1,5 +0,0 @@
colossalai.zero.zero\_redundancy\_optimizer\_level\_2
=====================================================
.. automodule:: colossalai.zero.zero_redundancy_optimizer_level_2
:members:

5
docs/colossalai/colossalai.zero.zero_redundancy_optimizer_level_3.rst
View File

@ -1,5 +0,0 @@
colossalai.zero.zero\_redundancy\_optimizer\_level\_3
=====================================================
.. automodule:: colossalai.zero.zero_redundancy_optimizer_level_3
:members: