From c770b2ff4c79c3ded73253fa76df79d1120a7bc6 Mon Sep 17 00:00:00 2001 From: FrankLeeeee Date: Thu, 9 Feb 2023 17:03:04 +0800 Subject: [PATCH] [doc] fixed compatiblity with docusaurus --- docs/source/en/Colossal-Auto/get_started/run_demo.md | 2 +- .../{zh => zh-Hans}/Colossal-Auto/feature/auto_checkpoint.md | 0 .../source/{zh => zh-Hans}/Colossal-Auto/feature/device_mesh.md | 0 .../{zh => zh-Hans}/Colossal-Auto/feature/shape_consistency.md | 0 docs/source/{zh => zh-Hans}/Colossal-Auto/feature/tracer.md | 0 .../{zh => zh-Hans}/Colossal-Auto/get_started/installation.md | 0 .../{zh => zh-Hans}/Colossal-Auto/get_started/introduction.md | 0 .../{zh => zh-Hans}/Colossal-Auto/get_started/run_demo.md | 2 +- .../{zh => zh-Hans}/advanced_tutorials/add_your_parallel.md | 0 .../advanced_tutorials/define_your_own_parallel_model.md | 0 .../integrate_mixture_of_experts_into_your_model.md | 0 docs/source/{zh => zh-Hans}/advanced_tutorials/meet_gemini.md | 0 docs/source/{zh => zh-Hans}/advanced_tutorials/opt_service.md | 0 .../parallelize_your_training_like_Megatron.md | 0 .../advanced_tutorials/train_gpt_using_hybrid_parallelism.md | 0 .../advanced_tutorials/train_vit_using_pipeline_parallelism.md | 0 .../advanced_tutorials/train_vit_with_hybrid_parallelism.md | 0 docs/source/{zh => zh-Hans}/basics/colotensor_concept.md | 0 docs/source/{zh => zh-Hans}/basics/command_line_tool.md | 0 docs/source/{zh => zh-Hans}/basics/configure_parallelization.md | 0 docs/source/{zh => zh-Hans}/basics/define_your_config.md | 0 docs/source/{zh => zh-Hans}/basics/engine_trainer.md | 0 docs/source/{zh => zh-Hans}/basics/initialize_features.md | 0 docs/source/{zh => zh-Hans}/basics/launch_colossalai.md | 0 docs/source/{zh => zh-Hans}/basics/model_checkpoint.md | 0 docs/source/{zh => zh-Hans}/concepts/colossalai_overview.md | 0 docs/source/{zh => zh-Hans}/concepts/distributed_training.md | 0 .../source/{zh => zh-Hans}/concepts/paradigms_of_parallelism.md | 0 docs/source/{zh => zh-Hans}/features/1D_tensor_parallel.md | 0 docs/source/{zh => zh-Hans}/features/2D_tensor_parallel.md | 0 docs/source/{zh => zh-Hans}/features/2p5D_tensor_parallel.md | 0 docs/source/{zh => zh-Hans}/features/3D_tensor_parallel.md | 0 docs/source/{zh => zh-Hans}/features/gradient_accumulation.md | 0 docs/source/{zh => zh-Hans}/features/gradient_clipping.md | 0 docs/source/{zh => zh-Hans}/features/gradient_handler.md | 0 .../source/{zh => zh-Hans}/features/mixed_precision_training.md | 0 docs/source/{zh => zh-Hans}/features/nvme_offload.md | 0 docs/source/{zh => zh-Hans}/features/pipeline_parallel.md | 0 docs/source/{zh => zh-Hans}/features/zero_with_chunk.md | 0 docs/source/{zh => zh-Hans}/get_started/installation.md | 0 docs/source/{zh => zh-Hans}/get_started/reading_roadmap.md | 0 docs/source/{zh => zh-Hans}/get_started/run_demo.md | 0 42 files changed, 2 insertions(+), 2 deletions(-) rename docs/source/{zh => zh-Hans}/Colossal-Auto/feature/auto_checkpoint.md (100%) rename docs/source/{zh => zh-Hans}/Colossal-Auto/feature/device_mesh.md (100%) rename docs/source/{zh => zh-Hans}/Colossal-Auto/feature/shape_consistency.md (100%) rename docs/source/{zh => zh-Hans}/Colossal-Auto/feature/tracer.md (100%) rename docs/source/{zh => zh-Hans}/Colossal-Auto/get_started/installation.md (100%) rename docs/source/{zh => zh-Hans}/Colossal-Auto/get_started/introduction.md (100%) rename docs/source/{zh => zh-Hans}/Colossal-Auto/get_started/run_demo.md (94%) rename docs/source/{zh => zh-Hans}/advanced_tutorials/add_your_parallel.md (100%) rename docs/source/{zh => zh-Hans}/advanced_tutorials/define_your_own_parallel_model.md (100%) rename docs/source/{zh => zh-Hans}/advanced_tutorials/integrate_mixture_of_experts_into_your_model.md (100%) rename docs/source/{zh => zh-Hans}/advanced_tutorials/meet_gemini.md (100%) rename docs/source/{zh => zh-Hans}/advanced_tutorials/opt_service.md (100%) rename docs/source/{zh => zh-Hans}/advanced_tutorials/parallelize_your_training_like_Megatron.md (100%) rename docs/source/{zh => zh-Hans}/advanced_tutorials/train_gpt_using_hybrid_parallelism.md (100%) rename docs/source/{zh => zh-Hans}/advanced_tutorials/train_vit_using_pipeline_parallelism.md (100%) rename docs/source/{zh => zh-Hans}/advanced_tutorials/train_vit_with_hybrid_parallelism.md (100%) rename docs/source/{zh => zh-Hans}/basics/colotensor_concept.md (100%) rename docs/source/{zh => zh-Hans}/basics/command_line_tool.md (100%) rename docs/source/{zh => zh-Hans}/basics/configure_parallelization.md (100%) rename docs/source/{zh => zh-Hans}/basics/define_your_config.md (100%) rename docs/source/{zh => zh-Hans}/basics/engine_trainer.md (100%) rename docs/source/{zh => zh-Hans}/basics/initialize_features.md (100%) rename docs/source/{zh => zh-Hans}/basics/launch_colossalai.md (100%) rename docs/source/{zh => zh-Hans}/basics/model_checkpoint.md (100%) rename docs/source/{zh => zh-Hans}/concepts/colossalai_overview.md (100%) rename docs/source/{zh => zh-Hans}/concepts/distributed_training.md (100%) rename docs/source/{zh => zh-Hans}/concepts/paradigms_of_parallelism.md (100%) rename docs/source/{zh => zh-Hans}/features/1D_tensor_parallel.md (100%) rename docs/source/{zh => zh-Hans}/features/2D_tensor_parallel.md (100%) rename docs/source/{zh => zh-Hans}/features/2p5D_tensor_parallel.md (100%) rename docs/source/{zh => zh-Hans}/features/3D_tensor_parallel.md (100%) rename docs/source/{zh => zh-Hans}/features/gradient_accumulation.md (100%) rename docs/source/{zh => zh-Hans}/features/gradient_clipping.md (100%) rename docs/source/{zh => zh-Hans}/features/gradient_handler.md (100%) rename docs/source/{zh => zh-Hans}/features/mixed_precision_training.md (100%) rename docs/source/{zh => zh-Hans}/features/nvme_offload.md (100%) rename docs/source/{zh => zh-Hans}/features/pipeline_parallel.md (100%) rename docs/source/{zh => zh-Hans}/features/zero_with_chunk.md (100%) rename docs/source/{zh => zh-Hans}/get_started/installation.md (100%) rename docs/source/{zh => zh-Hans}/get_started/reading_roadmap.md (100%) rename docs/source/{zh => zh-Hans}/get_started/run_demo.md (100%) diff --git a/docs/source/en/Colossal-Auto/get_started/run_demo.md b/docs/source/en/Colossal-Auto/get_started/run_demo.md index 6918ef497d19..bcf88cafc786 100644 --- a/docs/source/en/Colossal-Auto/get_started/run_demo.md +++ b/docs/source/en/Colossal-Auto/get_started/run_demo.md @@ -9,7 +9,7 @@ Detailed instructions can be found in its `README.md`. ### 2. Integration with activation checkpoint -Colossal-Auto's automatic search function for activation checkpointing finds the most efficient checkpoint within a given memory budget, rather than just aiming for maximum memory compression. To avoid a lengthy search process for an optimal activation checkpoint, Colossal-Auto has implemented a two-stage search process. This allows the system to find a feasible distributed training solution in a reasonable amount of time while still benefiting from activation checkpointing for memory management. The integration of activation checkpointing in Colossal-AI improves the efficiency and effectiveness of large model training. You can follow the [Resnet example](TBA). +Colossal-Auto's automatic search function for activation checkpointing finds the most efficient checkpoint within a given memory budget, rather than just aiming for maximum memory compression. To avoid a lengthy search process for an optimal activation checkpoint, Colossal-Auto has implemented a two-stage search process. This allows the system to find a feasible distributed training solution in a reasonable amount of time while still benefiting from activation checkpointing for memory management. The integration of activation checkpointing in Colossal-AI improves the efficiency and effectiveness of large model training. You can follow the [Resnet example](https://github.com/hpcaitech/ColossalAI/tree/main/examples/tutorial/auto_parallel). Detailed instructions can be found in its `README.md`.
diff --git a/docs/source/zh/Colossal-Auto/feature/auto_checkpoint.md b/docs/source/zh-Hans/Colossal-Auto/feature/auto_checkpoint.md similarity index 100% rename from docs/source/zh/Colossal-Auto/feature/auto_checkpoint.md rename to docs/source/zh-Hans/Colossal-Auto/feature/auto_checkpoint.md diff --git a/docs/source/zh/Colossal-Auto/feature/device_mesh.md b/docs/source/zh-Hans/Colossal-Auto/feature/device_mesh.md similarity index 100% rename from docs/source/zh/Colossal-Auto/feature/device_mesh.md rename to docs/source/zh-Hans/Colossal-Auto/feature/device_mesh.md diff --git a/docs/source/zh/Colossal-Auto/feature/shape_consistency.md b/docs/source/zh-Hans/Colossal-Auto/feature/shape_consistency.md similarity index 100% rename from docs/source/zh/Colossal-Auto/feature/shape_consistency.md rename to docs/source/zh-Hans/Colossal-Auto/feature/shape_consistency.md diff --git a/docs/source/zh/Colossal-Auto/feature/tracer.md b/docs/source/zh-Hans/Colossal-Auto/feature/tracer.md similarity index 100% rename from docs/source/zh/Colossal-Auto/feature/tracer.md rename to docs/source/zh-Hans/Colossal-Auto/feature/tracer.md diff --git a/docs/source/zh/Colossal-Auto/get_started/installation.md b/docs/source/zh-Hans/Colossal-Auto/get_started/installation.md similarity index 100% rename from docs/source/zh/Colossal-Auto/get_started/installation.md rename to docs/source/zh-Hans/Colossal-Auto/get_started/installation.md diff --git a/docs/source/zh/Colossal-Auto/get_started/introduction.md b/docs/source/zh-Hans/Colossal-Auto/get_started/introduction.md similarity index 100% rename from docs/source/zh/Colossal-Auto/get_started/introduction.md rename to docs/source/zh-Hans/Colossal-Auto/get_started/introduction.md diff --git a/docs/source/zh/Colossal-Auto/get_started/run_demo.md b/docs/source/zh-Hans/Colossal-Auto/get_started/run_demo.md similarity index 94% rename from docs/source/zh/Colossal-Auto/get_started/run_demo.md rename to docs/source/zh-Hans/Colossal-Auto/get_started/run_demo.md index cdeb227eb261..1050dcec6842 100644 --- a/docs/source/zh/Colossal-Auto/get_started/run_demo.md +++ b/docs/source/zh-Hans/Colossal-Auto/get_started/run_demo.md @@ -8,7 +8,7 @@ Colossal-Auto 可被用于为每一次操作寻找一个包含数据、张量（ ### 2. 与 activation checkpoint 结合 -作为大模型训练中必不可少的显存压缩技术，Colossal-AI 也提供了对于 activation checkpoint 的自动搜索功能。相比于大部分将最大显存压缩作为目标的技术方案，Colossal-AI 的搜索目标是在显存预算以内，找到最快的 activation checkpoint 方案。同时，为了避免将 activation checkpoint 的搜索一起建模到 SPMD solver 中导致搜索时间爆炸，Colossal-AI 做了 2-stage search 的设计，因此可以在合理的时间内搜索到有效可行的分布式训练方案。 您可参考 [Resnet 示例](TBA)。 +作为大模型训练中必不可少的显存压缩技术，Colossal-AI 也提供了对于 activation checkpoint 的自动搜索功能。相比于大部分将最大显存压缩作为目标的技术方案，Colossal-AI 的搜索目标是在显存预算以内，找到最快的 activation checkpoint 方案。同时，为了避免将 activation checkpoint 的搜索一起建模到 SPMD solver 中导致搜索时间爆炸，Colossal-AI 做了 2-stage search 的设计，因此可以在合理的时间内搜索到有效可行的分布式训练方案。 您可参考 [Resnet 示例](https://github.com/hpcaitech/ColossalAI/tree/main/examples/tutorial/auto_parallel)。 详细的操作指引见其 `README.md`。
diff --git a/docs/source/zh/advanced_tutorials/add_your_parallel.md b/docs/source/zh-Hans/advanced_tutorials/add_your_parallel.md similarity index 100% rename from docs/source/zh/advanced_tutorials/add_your_parallel.md rename to docs/source/zh-Hans/advanced_tutorials/add_your_parallel.md diff --git a/docs/source/zh/advanced_tutorials/define_your_own_parallel_model.md b/docs/source/zh-Hans/advanced_tutorials/define_your_own_parallel_model.md similarity index 100% rename from docs/source/zh/advanced_tutorials/define_your_own_parallel_model.md rename to docs/source/zh-Hans/advanced_tutorials/define_your_own_parallel_model.md diff --git a/docs/source/zh/advanced_tutorials/integrate_mixture_of_experts_into_your_model.md b/docs/source/zh-Hans/advanced_tutorials/integrate_mixture_of_experts_into_your_model.md similarity index 100% rename from docs/source/zh/advanced_tutorials/integrate_mixture_of_experts_into_your_model.md rename to docs/source/zh-Hans/advanced_tutorials/integrate_mixture_of_experts_into_your_model.md diff --git a/docs/source/zh/advanced_tutorials/meet_gemini.md b/docs/source/zh-Hans/advanced_tutorials/meet_gemini.md similarity index 100% rename from docs/source/zh/advanced_tutorials/meet_gemini.md rename to docs/source/zh-Hans/advanced_tutorials/meet_gemini.md diff --git a/docs/source/zh/advanced_tutorials/opt_service.md b/docs/source/zh-Hans/advanced_tutorials/opt_service.md similarity index 100% rename from docs/source/zh/advanced_tutorials/opt_service.md rename to docs/source/zh-Hans/advanced_tutorials/opt_service.md diff --git a/docs/source/zh/advanced_tutorials/parallelize_your_training_like_Megatron.md b/docs/source/zh-Hans/advanced_tutorials/parallelize_your_training_like_Megatron.md similarity index 100% rename from docs/source/zh/advanced_tutorials/parallelize_your_training_like_Megatron.md rename to docs/source/zh-Hans/advanced_tutorials/parallelize_your_training_like_Megatron.md diff --git a/docs/source/zh/advanced_tutorials/train_gpt_using_hybrid_parallelism.md b/docs/source/zh-Hans/advanced_tutorials/train_gpt_using_hybrid_parallelism.md similarity index 100% rename from docs/source/zh/advanced_tutorials/train_gpt_using_hybrid_parallelism.md rename to docs/source/zh-Hans/advanced_tutorials/train_gpt_using_hybrid_parallelism.md diff --git a/docs/source/zh/advanced_tutorials/train_vit_using_pipeline_parallelism.md b/docs/source/zh-Hans/advanced_tutorials/train_vit_using_pipeline_parallelism.md similarity index 100% rename from docs/source/zh/advanced_tutorials/train_vit_using_pipeline_parallelism.md rename to docs/source/zh-Hans/advanced_tutorials/train_vit_using_pipeline_parallelism.md diff --git a/docs/source/zh/advanced_tutorials/train_vit_with_hybrid_parallelism.md b/docs/source/zh-Hans/advanced_tutorials/train_vit_with_hybrid_parallelism.md similarity index 100% rename from docs/source/zh/advanced_tutorials/train_vit_with_hybrid_parallelism.md rename to docs/source/zh-Hans/advanced_tutorials/train_vit_with_hybrid_parallelism.md diff --git a/docs/source/zh/basics/colotensor_concept.md b/docs/source/zh-Hans/basics/colotensor_concept.md similarity index 100% rename from docs/source/zh/basics/colotensor_concept.md rename to docs/source/zh-Hans/basics/colotensor_concept.md diff --git a/docs/source/zh/basics/command_line_tool.md b/docs/source/zh-Hans/basics/command_line_tool.md similarity index 100% rename from docs/source/zh/basics/command_line_tool.md rename to docs/source/zh-Hans/basics/command_line_tool.md diff --git a/docs/source/zh/basics/configure_parallelization.md b/docs/source/zh-Hans/basics/configure_parallelization.md similarity index 100% rename from docs/source/zh/basics/configure_parallelization.md rename to docs/source/zh-Hans/basics/configure_parallelization.md diff --git a/docs/source/zh/basics/define_your_config.md b/docs/source/zh-Hans/basics/define_your_config.md similarity index 100% rename from docs/source/zh/basics/define_your_config.md rename to docs/source/zh-Hans/basics/define_your_config.md diff --git a/docs/source/zh/basics/engine_trainer.md b/docs/source/zh-Hans/basics/engine_trainer.md similarity index 100% rename from docs/source/zh/basics/engine_trainer.md rename to docs/source/zh-Hans/basics/engine_trainer.md diff --git a/docs/source/zh/basics/initialize_features.md b/docs/source/zh-Hans/basics/initialize_features.md similarity index 100% rename from docs/source/zh/basics/initialize_features.md rename to docs/source/zh-Hans/basics/initialize_features.md diff --git a/docs/source/zh/basics/launch_colossalai.md b/docs/source/zh-Hans/basics/launch_colossalai.md similarity index 100% rename from docs/source/zh/basics/launch_colossalai.md rename to docs/source/zh-Hans/basics/launch_colossalai.md diff --git a/docs/source/zh/basics/model_checkpoint.md b/docs/source/zh-Hans/basics/model_checkpoint.md similarity index 100% rename from docs/source/zh/basics/model_checkpoint.md rename to docs/source/zh-Hans/basics/model_checkpoint.md diff --git a/docs/source/zh/concepts/colossalai_overview.md b/docs/source/zh-Hans/concepts/colossalai_overview.md similarity index 100% rename from docs/source/zh/concepts/colossalai_overview.md rename to docs/source/zh-Hans/concepts/colossalai_overview.md diff --git a/docs/source/zh/concepts/distributed_training.md b/docs/source/zh-Hans/concepts/distributed_training.md similarity index 100% rename from docs/source/zh/concepts/distributed_training.md rename to docs/source/zh-Hans/concepts/distributed_training.md diff --git a/docs/source/zh/concepts/paradigms_of_parallelism.md b/docs/source/zh-Hans/concepts/paradigms_of_parallelism.md similarity index 100% rename from docs/source/zh/concepts/paradigms_of_parallelism.md rename to docs/source/zh-Hans/concepts/paradigms_of_parallelism.md diff --git a/docs/source/zh/features/1D_tensor_parallel.md b/docs/source/zh-Hans/features/1D_tensor_parallel.md similarity index 100% rename from docs/source/zh/features/1D_tensor_parallel.md rename to docs/source/zh-Hans/features/1D_tensor_parallel.md diff --git a/docs/source/zh/features/2D_tensor_parallel.md b/docs/source/zh-Hans/features/2D_tensor_parallel.md similarity index 100% rename from docs/source/zh/features/2D_tensor_parallel.md rename to docs/source/zh-Hans/features/2D_tensor_parallel.md diff --git a/docs/source/zh/features/2p5D_tensor_parallel.md b/docs/source/zh-Hans/features/2p5D_tensor_parallel.md similarity index 100% rename from docs/source/zh/features/2p5D_tensor_parallel.md rename to docs/source/zh-Hans/features/2p5D_tensor_parallel.md diff --git a/docs/source/zh/features/3D_tensor_parallel.md b/docs/source/zh-Hans/features/3D_tensor_parallel.md similarity index 100% rename from docs/source/zh/features/3D_tensor_parallel.md rename to docs/source/zh-Hans/features/3D_tensor_parallel.md diff --git a/docs/source/zh/features/gradient_accumulation.md b/docs/source/zh-Hans/features/gradient_accumulation.md similarity index 100% rename from docs/source/zh/features/gradient_accumulation.md rename to docs/source/zh-Hans/features/gradient_accumulation.md diff --git a/docs/source/zh/features/gradient_clipping.md b/docs/source/zh-Hans/features/gradient_clipping.md similarity index 100% rename from docs/source/zh/features/gradient_clipping.md rename to docs/source/zh-Hans/features/gradient_clipping.md diff --git a/docs/source/zh/features/gradient_handler.md b/docs/source/zh-Hans/features/gradient_handler.md similarity index 100% rename from docs/source/zh/features/gradient_handler.md rename to docs/source/zh-Hans/features/gradient_handler.md diff --git a/docs/source/zh/features/mixed_precision_training.md b/docs/source/zh-Hans/features/mixed_precision_training.md similarity index 100% rename from docs/source/zh/features/mixed_precision_training.md rename to docs/source/zh-Hans/features/mixed_precision_training.md diff --git a/docs/source/zh/features/nvme_offload.md b/docs/source/zh-Hans/features/nvme_offload.md similarity index 100% rename from docs/source/zh/features/nvme_offload.md rename to docs/source/zh-Hans/features/nvme_offload.md diff --git a/docs/source/zh/features/pipeline_parallel.md b/docs/source/zh-Hans/features/pipeline_parallel.md similarity index 100% rename from docs/source/zh/features/pipeline_parallel.md rename to docs/source/zh-Hans/features/pipeline_parallel.md diff --git a/docs/source/zh/features/zero_with_chunk.md b/docs/source/zh-Hans/features/zero_with_chunk.md similarity index 100% rename from docs/source/zh/features/zero_with_chunk.md rename to docs/source/zh-Hans/features/zero_with_chunk.md diff --git a/docs/source/zh/get_started/installation.md b/docs/source/zh-Hans/get_started/installation.md similarity index 100% rename from docs/source/zh/get_started/installation.md rename to docs/source/zh-Hans/get_started/installation.md diff --git a/docs/source/zh/get_started/reading_roadmap.md b/docs/source/zh-Hans/get_started/reading_roadmap.md similarity index 100% rename from docs/source/zh/get_started/reading_roadmap.md rename to docs/source/zh-Hans/get_started/reading_roadmap.md diff --git a/docs/source/zh/get_started/run_demo.md b/docs/source/zh-Hans/get_started/run_demo.md similarity index 100% rename from docs/source/zh/get_started/run_demo.md rename to docs/source/zh-Hans/get_started/run_demo.md