diff --git a/docs/sidebars.js b/docs/sidebars.js new file mode 100644 index 000000000..d6273b558 --- /dev/null +++ b/docs/sidebars.js @@ -0,0 +1,73 @@ +module.exports = { + docs: [ + { + type: 'category', + label: 'Get started', + collapsed: false, + items: [ + 'get_started/installation', 'get_started/run_demo', + 'get_started/reading_roadmap' + ], + }, + { + type: 'category', + label: 'Concepts', + collapsed: false, + items: [ + 'concepts/distributed_training', 'concepts/paradigms_of_parallelism', + 'concepts/colossalai_overview' + ], + }, + { + type: 'category', + label: 'Basics', + collapsed: false, + items: [ + 'basics/command_line_tool', + 'basics/define_your_config', + 'basics/launch_colossalai', + 'basics/initialize_features', + 'basics/engine_trainer', + 'basics/configure_parallelization', + 'basics/model_checkpoint', + 'basics/colotensor_concept', + ], + }, + { + type: 'category', + label: 'Features', + collapsed: false, + items: [ + 'features/mixed_precision_training', 'features/gradient_accumulation', + 'features/gradient_clipping', 'features/gradient_handler', + 'features/zero_with_chunk', { + type: 'category', + label: 'Tensor Parallel', + collapsed: true, + items: [ + 'features/1D_tensor_parallel', + 'features/2D_tensor_parallel', + 'features/2p5D_tensor_parallel', + 'features/3D_tensor_parallel', + ], + }, + 'features/pipeline_parallel', 'features/nvme_offload' + ], + }, + { + type: 'category', + label: 'Advanced Tutorials', + collapsed: false, + items: [ + 'advanced_tutorials/train_vit_using_pipeline_parallelism', + 'advanced_tutorials/train_vit_with_hybrid_parallelism', + 'advanced_tutorials/train_gpt_using_hybrid_parallelism', + 'advanced_tutorials/define_your_own_parallel_model', + 'advanced_tutorials/add_your_parallel', + 'advanced_tutorials/meet_gemini', + 'advanced_tutorials/parallelize_your_training_like_Megatron', + 'advanced_tutorials/integrate_mixture_of_experts_into_your_model' + ], + }, + ] +}; diff --git a/docs/versions.json b/docs/versions.json new file mode 100644 index 000000000..dde32982b --- /dev/null +++ b/docs/versions.json @@ -0,0 +1,3 @@ +[ + "current" +]