From d9393b85f1353d14f22c78a9b2d23edf7ce6e9cf Mon Sep 17 00:00:00 2001 From: Yanjia0 <42895286+Yanjia0@users.noreply.github.com> Date: Mon, 22 May 2023 11:12:53 +0800 Subject: [PATCH] [doc] add deprecated warning on doc Basics section (#3754) * Update colotensor_concept.md * Update configure_parallelization.md * Update define_your_config.md * Update engine_trainer.md * Update initialize_features.md * Update model_checkpoint.md * Update colotensor_concept.md * Update configure_parallelization.md * Update define_your_config.md * Update engine_trainer.md * Update initialize_features.md * Update model_checkpoint.md --- docs/source/en/basics/colotensor_concept.md | 2 ++ docs/source/en/basics/configure_parallelization.md | 2 ++ docs/source/en/basics/define_your_config.md | 3 +++ docs/source/en/basics/engine_trainer.md | 2 ++ docs/source/en/basics/initialize_features.md | 2 ++ docs/source/en/basics/model_checkpoint.md | 2 ++ docs/source/zh-Hans/basics/colotensor_concept.md | 2 ++ .../source/zh-Hans/basics/configure_parallelization.md | 2 ++ docs/source/zh-Hans/basics/define_your_config.md | 2 ++ docs/source/zh-Hans/basics/engine_trainer.md | 2 ++ docs/source/zh-Hans/basics/initialize_features.md | 2 ++ docs/source/zh-Hans/basics/model_checkpoint.md | 10 ++++++---- 12 files changed, 29 insertions(+), 4 deletions(-) diff --git a/docs/source/en/basics/colotensor_concept.md b/docs/source/en/basics/colotensor_concept.md index 909c5e4d3..050f2ef9f 100644 --- a/docs/source/en/basics/colotensor_concept.md +++ b/docs/source/en/basics/colotensor_concept.md @@ -2,6 +2,8 @@ Author: [Jiarui Fang](https://github.com/feifeibear), [Hongxin Liu](https://github.com/ver217) and [Haichen Huang](https://github.com/1SAA) +> ⚠️ The information on this page is outdated and will be deprecated. + **Prerequisite:** - [Colossal-AI Overview](../concepts/colossalai_overview.md) - [Distributed Training](../concepts/distributed_training.md) diff --git a/docs/source/en/basics/configure_parallelization.md b/docs/source/en/basics/configure_parallelization.md index 4ac0299ea..fd1e72ccd 100644 --- a/docs/source/en/basics/configure_parallelization.md +++ b/docs/source/en/basics/configure_parallelization.md @@ -2,6 +2,8 @@ Author: Shenggui Li, Siqi Mai +> ⚠️ The information on this page is outdated and will be deprecated. Please check [Booster Plugins](../basics/booster_plugins.md) for more information. + **Prerequisite:** - [Distributed Training](../concepts/distributed_training.md) - [Paradigms of Parallelism](../concepts/paradigms_of_parallelism.md) diff --git a/docs/source/en/basics/define_your_config.md b/docs/source/en/basics/define_your_config.md index d2569691b..048ffcacb 100644 --- a/docs/source/en/basics/define_your_config.md +++ b/docs/source/en/basics/define_your_config.md @@ -2,6 +2,9 @@ Author: Guangyang Lu, Shenggui Li, Siqi Mai +> ⚠️ The information on this page is outdated and will be deprecated. Please check [Booster API](../basics/booster_api.md) for more information. + + **Prerequisite:** - [Distributed Training](../concepts/distributed_training.md) - [Colossal-AI Overview](../concepts/colossalai_overview.md) diff --git a/docs/source/en/basics/engine_trainer.md b/docs/source/en/basics/engine_trainer.md index bbe32ed5a..d2f99563f 100644 --- a/docs/source/en/basics/engine_trainer.md +++ b/docs/source/en/basics/engine_trainer.md @@ -2,6 +2,8 @@ Author: Shenggui Li, Siqi Mai +> ⚠️ The information on this page is outdated and will be deprecated. Please check [Booster API](../basics/booster_api.md) for more information. + **Prerequisite:** - [Initialize Features](./initialize_features.md) diff --git a/docs/source/en/basics/initialize_features.md b/docs/source/en/basics/initialize_features.md index e768d2022..b89017427 100644 --- a/docs/source/en/basics/initialize_features.md +++ b/docs/source/en/basics/initialize_features.md @@ -2,6 +2,8 @@ Author: Shenggui Li, Siqi Mai +> ⚠️ The information on this page is outdated and will be deprecated. Please check [Booster API](../basics/booster_api.md) for more information. + **Prerequisite:** - [Distributed Training](../concepts/distributed_training.md) - [Colossal-AI Overview](../concepts/colossalai_overview.md) diff --git a/docs/source/en/basics/model_checkpoint.md b/docs/source/en/basics/model_checkpoint.md index 09d44e7c2..70334f1c4 100644 --- a/docs/source/en/basics/model_checkpoint.md +++ b/docs/source/en/basics/model_checkpoint.md @@ -2,6 +2,8 @@ Author : Guangyang Lu +> ⚠️ The information on this page is outdated and will be deprecated. Please check [Booster Checkpoint](../basics/booster_checkpoint.md) for more information. + **Prerequisite:** - [Launch Colossal-AI](./launch_colossalai.md) - [Initialize Colossal-AI](./initialize_features.md) diff --git a/docs/source/zh-Hans/basics/colotensor_concept.md b/docs/source/zh-Hans/basics/colotensor_concept.md index d6a332df2..b725e48a7 100644 --- a/docs/source/zh-Hans/basics/colotensor_concept.md +++ b/docs/source/zh-Hans/basics/colotensor_concept.md @@ -2,6 +2,8 @@ Author: [Jiarui Fang](https://github.com/feifeibear), [Hongxin Liu](https://github.com/ver217) and [Haichen Huang](https://github.com/1SAA) +> ⚠️ 此页面上的信息已经过时并将被废弃。 + **Prerequisite:** - [Colossal-AI Overview](../concepts/colossalai_overview.md) - [Distributed Training](../concepts/distributed_training.md) diff --git a/docs/source/zh-Hans/basics/configure_parallelization.md b/docs/source/zh-Hans/basics/configure_parallelization.md index eb4b38f48..0c2a66572 100644 --- a/docs/source/zh-Hans/basics/configure_parallelization.md +++ b/docs/source/zh-Hans/basics/configure_parallelization.md @@ -2,6 +2,8 @@ 作者: Shenggui Li, Siqi Mai +> ⚠️ 此页面上的信息已经过时并将被废弃。请在[Booster插件](../basics/booster_plugins.md)页面查阅更新。 + **预备知识:** - [分布式训练](../concepts/distributed_training.md) - [并行技术](../concepts/paradigms_of_parallelism.md) diff --git a/docs/source/zh-Hans/basics/define_your_config.md b/docs/source/zh-Hans/basics/define_your_config.md index d7e49cbf2..720e75805 100644 --- a/docs/source/zh-Hans/basics/define_your_config.md +++ b/docs/source/zh-Hans/basics/define_your_config.md @@ -2,6 +2,8 @@ 作者: Guangyang Lu, Shenggui Li, Siqi Mai +> ⚠️ 此页面上的信息已经过时并将被废弃。请在[Booster API](../basics/booster_api.md)页面查阅更新。 + **预备知识:** - [分布式训练](../concepts/distributed_training.md) - [Colossal-AI 总览](../concepts/colossalai_overview.md) diff --git a/docs/source/zh-Hans/basics/engine_trainer.md b/docs/source/zh-Hans/basics/engine_trainer.md index a7519bfca..a35bd87c4 100644 --- a/docs/source/zh-Hans/basics/engine_trainer.md +++ b/docs/source/zh-Hans/basics/engine_trainer.md @@ -2,6 +2,8 @@ 作者: Shenggui Li, Siqi Mai +> ⚠️ 此页面上的信息已经过时并将被废弃。请在[Booster API](../basics/booster_api.md)页面查阅更新。 + **预备知识:** - [初始化功能](./initialize_features.md) diff --git a/docs/source/zh-Hans/basics/initialize_features.md b/docs/source/zh-Hans/basics/initialize_features.md index 67ea114b4..1c28d658e 100644 --- a/docs/source/zh-Hans/basics/initialize_features.md +++ b/docs/source/zh-Hans/basics/initialize_features.md @@ -2,6 +2,8 @@ 作者: Shenggui Li, Siqi Mai +> ⚠️ 此页面上的信息已经过时并将被废弃。请在[Booster API](../basics/booster_api.md)页面查阅更新。 + **预备知识:** - [分布式训练](../concepts/distributed_training.md) - [Colossal-AI 总览](../concepts/colossalai_overview.md) diff --git a/docs/source/zh-Hans/basics/model_checkpoint.md b/docs/source/zh-Hans/basics/model_checkpoint.md index cec12d451..a5374b750 100644 --- a/docs/source/zh-Hans/basics/model_checkpoint.md +++ b/docs/source/zh-Hans/basics/model_checkpoint.md @@ -1,7 +1,9 @@ -# 模型检查点 +# 模型Checkpoint 作者 : Guangyang Lu +> ⚠️ 此页面上的信息已经过时并将被废弃。请在[Booster Checkpoint](../basics/booster_checkpoint.md)页面查阅更新。 + **预备知识:** - [Launch Colossal-AI](./launch_colossalai.md) - [Initialize Colossal-AI](./initialize_features.md) @@ -13,9 +15,9 @@ ## 简介 -本教程将介绍如何保存和加载模型检查点。 +本教程将介绍如何保存和加载模型Checkpoint。 -为了充分利用Colossal-AI的强大并行策略，我们需要修改模型和张量，可以直接使用 `torch.save` 或者 `torch.load` 保存或加载模型检查点。在Colossal-AI中，我们提供了应用程序接口实现上述同样的效果。 +为了充分利用Colossal-AI的强大并行策略，我们需要修改模型和张量，可以直接使用 `torch.save` 或者 `torch.load` 保存或加载模型Checkpoint。在Colossal-AI中，我们提供了应用程序接口实现上述同样的效果。 但是，在加载时，你不需要使用与存储相同的保存策略。 @@ -24,7 +26,7 @@ ### 保存 有两种方法可以使用Colossal-AI训练模型，即使用engine或使用trainer。 -**注意我们只保存 `state_dict`.** 因此，在加载检查点时，需要首先定义模型。 +**注意我们只保存 `state_dict`.** 因此，在加载Checkpoint时，需要首先定义模型。 #### 同 engine 保存