From ffca99d18791484ca45e3de47df9eff356b28863 Mon Sep 17 00:00:00 2001 From: ver217 Date: Fri, 25 Mar 2022 18:29:43 +0800 Subject: [PATCH] [doc] update apidoc (#530) --- ...xt.process_group_initializer.initializer_moe.rst | 5 ----- ...colossalai.context.process_group_initializer.rst | 1 - docs/colossalai/colossalai.context.rst | 1 + .../colossalai.context.singleton_meta.rst | 5 +++++ docs/colossalai/colossalai.logging.logger.rst | 5 +++++ docs/colossalai/colossalai.logging.logging.rst | 5 ----- docs/colossalai/colossalai.logging.rst | 2 +- .../colossalai.utils.commons.bucket_tensor_copy.rst | 5 ----- docs/colossalai/colossalai.utils.commons.memory.rst | 5 ----- docs/colossalai/colossalai.utils.commons.rst | 13 ------------- .../colossalai.utils.commons.singleton_meta.rst | 5 ----- docs/colossalai/colossalai.utils.memory.rst | 5 ----- .../colossalai.utils.memory_tracer.allocator.rst | 5 ----- .../colossalai.utils.memory_tracer.commons.rst | 5 ----- docs/colossalai/colossalai.utils.memory_tracer.rst | 2 -- ...ssalai.utils.memory_utils.bucket_tensor_copy.rst | 5 +++++ ...colossalai.utils.memory_utils.memory_monitor.rst | 5 +++++ docs/colossalai/colossalai.utils.memory_utils.rst | 13 +++++++++++++ .../colossalai.utils.memory_utils.utils.rst | 5 +++++ docs/colossalai/colossalai.utils.rst | 3 +-- 20 files changed, 41 insertions(+), 59 deletions(-) delete mode 100644 docs/colossalai/colossalai.context.process_group_initializer.initializer_moe.rst create mode 100644 docs/colossalai/colossalai.context.singleton_meta.rst create mode 100644 docs/colossalai/colossalai.logging.logger.rst delete mode 100644 docs/colossalai/colossalai.logging.logging.rst delete mode 100644 docs/colossalai/colossalai.utils.commons.bucket_tensor_copy.rst delete mode 100644 docs/colossalai/colossalai.utils.commons.memory.rst delete mode 100644 docs/colossalai/colossalai.utils.commons.rst delete mode 100644 docs/colossalai/colossalai.utils.commons.singleton_meta.rst delete mode 100644 docs/colossalai/colossalai.utils.memory.rst delete mode 100644 docs/colossalai/colossalai.utils.memory_tracer.allocator.rst delete mode 100644 docs/colossalai/colossalai.utils.memory_tracer.commons.rst create mode 100644 docs/colossalai/colossalai.utils.memory_utils.bucket_tensor_copy.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 diff --git a/docs/colossalai/colossalai.context.process_group_initializer.initializer_moe.rst b/docs/colossalai/colossalai.context.process_group_initializer.initializer_moe.rst deleted file mode 100644 index be2314629..000000000 --- a/docs/colossalai/colossalai.context.process_group_initializer.initializer_moe.rst +++ /dev/null @@ -1,5 +0,0 @@ -colossalai.context.process\_group\_initializer.initializer\_moe -=============================================================== - -.. automodule:: colossalai.context.process_group_initializer.initializer_moe - :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 30ad8b3a5..102a9e02e 100644 --- a/docs/colossalai/colossalai.context.rst +++ b/docs/colossalai/colossalai.context.rst @@ -18,3 +18,4 @@ colossalai.context colossalai.context.moe_context colossalai.context.parallel_context colossalai.context.parallel_mode + 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.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.logging.rst b/docs/colossalai/colossalai.logging.logging.rst deleted file mode 100644 index 05374b8f4..000000000 --- a/docs/colossalai/colossalai.logging.logging.rst +++ /dev/null @@ -1,5 +0,0 @@ -colossalai.logging.logging -========================== - -.. automodule:: colossalai.logging.logging - :members: diff --git a/docs/colossalai/colossalai.logging.rst b/docs/colossalai/colossalai.logging.rst index a7a5cec72..bc593fc81 100644 --- a/docs/colossalai/colossalai.logging.rst +++ b/docs/colossalai/colossalai.logging.rst @@ -8,4 +8,4 @@ colossalai.logging .. toctree:: :maxdepth: 2 - colossalai.logging.logging + colossalai.logging.logger diff --git a/docs/colossalai/colossalai.utils.commons.bucket_tensor_copy.rst b/docs/colossalai/colossalai.utils.commons.bucket_tensor_copy.rst deleted file mode 100644 index 8b96215c5..000000000 --- a/docs/colossalai/colossalai.utils.commons.bucket_tensor_copy.rst +++ /dev/null @@ -1,5 +0,0 @@ -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 deleted file mode 100644 index 9095177f4..000000000 --- a/docs/colossalai/colossalai.utils.commons.memory.rst +++ /dev/null @@ -1,5 +0,0 @@ -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 deleted file mode 100644 index b608aadb7..000000000 --- a/docs/colossalai/colossalai.utils.commons.rst +++ /dev/null @@ -1,13 +0,0 @@ -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 deleted file mode 100644 index a0149ceee..000000000 --- a/docs/colossalai/colossalai.utils.commons.singleton_meta.rst +++ /dev/null @@ -1,5 +0,0 @@ -colossalai.utils.commons.singleton\_meta -======================================== - -.. automodule:: colossalai.utils.commons.singleton_meta - :members: diff --git a/docs/colossalai/colossalai.utils.memory.rst b/docs/colossalai/colossalai.utils.memory.rst deleted file mode 100644 index 67c5d6002..000000000 --- a/docs/colossalai/colossalai.utils.memory.rst +++ /dev/null @@ -1,5 +0,0 @@ -colossalai.utils.memory -======================= - -.. automodule:: colossalai.utils.memory - :members: diff --git a/docs/colossalai/colossalai.utils.memory_tracer.allocator.rst b/docs/colossalai/colossalai.utils.memory_tracer.allocator.rst deleted file mode 100644 index 61add2f97..000000000 --- a/docs/colossalai/colossalai.utils.memory_tracer.allocator.rst +++ /dev/null @@ -1,5 +0,0 @@ -colossalai.utils.memory\_tracer.allocator -========================================= - -.. automodule:: colossalai.utils.memory_tracer.allocator - :members: diff --git a/docs/colossalai/colossalai.utils.memory_tracer.commons.rst b/docs/colossalai/colossalai.utils.memory_tracer.commons.rst deleted file mode 100644 index 015664cb5..000000000 --- a/docs/colossalai/colossalai.utils.memory_tracer.commons.rst +++ /dev/null @@ -1,5 +0,0 @@ -colossalai.utils.memory\_tracer.commons -======================================= - -.. automodule:: colossalai.utils.memory_tracer.commons - :members: diff --git a/docs/colossalai/colossalai.utils.memory_tracer.rst b/docs/colossalai/colossalai.utils.memory_tracer.rst index 01598ae59..1caf85aec 100644 --- a/docs/colossalai/colossalai.utils.memory_tracer.rst +++ b/docs/colossalai/colossalai.utils.memory_tracer.rst @@ -8,9 +8,7 @@ colossalai.utils.memory\_tracer .. 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 diff --git a/docs/colossalai/colossalai.utils.memory_utils.bucket_tensor_copy.rst b/docs/colossalai/colossalai.utils.memory_utils.bucket_tensor_copy.rst new file mode 100644 index 000000000..cccd52bb3 --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_utils.bucket_tensor_copy.rst @@ -0,0 +1,5 @@ +colossalai.utils.memory\_utils.bucket\_tensor\_copy +=================================================== + +.. automodule:: colossalai.utils.memory_utils.bucket_tensor_copy + :members: 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..0087116e0 --- /dev/null +++ b/docs/colossalai/colossalai.utils.memory_utils.rst @@ -0,0 +1,13 @@ +colossalai.utils.memory\_utils +============================== + +.. automodule:: colossalai.utils.memory_utils + :members: + + +.. toctree:: + :maxdepth: 2 + + colossalai.utils.memory_utils.bucket_tensor_copy + 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.rst b/docs/colossalai/colossalai.utils.rst index 7f7f58bbf..f6a74fe4e 100644 --- a/docs/colossalai/colossalai.utils.rst +++ b/docs/colossalai/colossalai.utils.rst @@ -7,10 +7,10 @@ colossalai.utils .. toctree:: :maxdepth: 2 - colossalai.utils.commons colossalai.utils.data_sampler colossalai.utils.gradient_accumulation colossalai.utils.memory_tracer + colossalai.utils.memory_utils colossalai.utils.multi_tensor_apply colossalai.utils.profiler colossalai.utils.tensor_detector @@ -23,6 +23,5 @@ colossalai.utils colossalai.utils.checkpointing colossalai.utils.common colossalai.utils.cuda - colossalai.utils.memory colossalai.utils.moe colossalai.utils.timer