github/ColossalAI
1
0
Fork 0
mirror of https://github.com/hpcaitech/ColossalAI.git synced 2025-09-04 18:40:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

[doc] add booster docstring and fix autodoc (#3789)

Browse Source 
* [doc] add docstr for booster methods

* [doc] fix autodoc
This commit is contained in:
Hongxin Liu
2023-05-22 10:56:47 +08:00
committed by GitHub
parent 3c07a2846e
commit 72688adb2f
5 changed files with 16 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/source/en/basics/booster_api.md
View File

@@ -25,24 +25,6 @@ Plugin is an important component that manages parallel configuration (eg: The ge
{{ autodoc:colossalai.booster.Booster }}
{{ autodoc:colossalai.booster.Booster.boost }}
{{ autodoc:colossalai.booster.Booster.backward }}
{{ autodoc:colossalai.booster.Booster.no_sync }}
{{ autodoc:colossalai.booster.Booster.save_model }}
{{ autodoc:colossalai.booster.Booster.load_model }}
{{ autodoc:colossalai.booster.Booster.save_optimizer }}
{{ autodoc:colossalai.booster.Booster.load_optimizer }}
{{ autodoc:colossalai.booster.Booster.save_lr_scheduler }}
{{ autodoc:colossalai.booster.Booster.load_lr_scheduler }}
## Usage
In a typical workflow, you should launch distributed environment at the beginning of training script and create objects needed (such as models, optimizers, loss function, data loaders etc.) firstly, then call `colossalai.booster` to inject features into these objects, After that, you can use our booster APIs and these returned objects to continue the rest of your training processes.

18
docs/source/en/features/cluster_utils.md
View File

@@ -13,20 +13,4 @@ We provide a utility class `colossalai.cluster.DistCoordinator` to coordinate di
{{ autodoc:colossalai.cluster.DistCoordinator }}
{{ autodoc:colossalai.cluster.DistCoordinator.is_master }}
{{ autodoc:colossalai.cluster.DistCoordinator.is_node_master }}
{{ autodoc:colossalai.cluster.DistCoordinator.is_last_process }}
{{ autodoc:colossalai.cluster.DistCoordinator.print_on_master }}
{{ autodoc:colossalai.cluster.DistCoordinator.print_on_node_master }}
{{ autodoc:colossalai.cluster.DistCoordinator.priority_execution }}
{{ autodoc:colossalai.cluster.DistCoordinator.destroy }}
{{ autodoc:colossalai.cluster.DistCoordinator.block_all }}
{{ autodoc:colossalai.cluster.DistCoordinator.on_master_only }}
<!-- doc-test-command: echo -->

18
docs/source/zh-Hans/basics/booster_api.md
View File

@@ -25,24 +25,6 @@ Booster插件是管理并行配置的重要组件（eg：gemini插件封装了ge
{{ autodoc:colossalai.booster.Booster }}
{{ autodoc:colossalai.booster.Booster.boost }}
{{ autodoc:colossalai.booster.Booster.backward }}
{{ autodoc:colossalai.booster.Booster.no_sync }}
{{ autodoc:colossalai.booster.Booster.save_model }}
{{ autodoc:colossalai.booster.Booster.load_model }}
{{ autodoc:colossalai.booster.Booster.save_optimizer }}
{{ autodoc:colossalai.booster.Booster.load_optimizer }}
{{ autodoc:colossalai.booster.Booster.save_lr_scheduler }}
{{ autodoc:colossalai.booster.Booster.load_lr_scheduler }}
## 使用方法及示例
在使用colossalai训练时，首先需要在训练脚本的开头启动分布式环境，并创建需要使用的模型、优化器、损失函数、数据加载器等对象。之后，调用`colossalai.booster` 将特征注入到这些对象中，您就可以使用我们的booster API去进行您接下来的训练流程。

18
docs/source/zh-Hans/features/cluster_utils.md
View File

@@ -13,20 +13,4 @@
{{ autodoc:colossalai.cluster.DistCoordinator }}
{{ autodoc:colossalai.cluster.DistCoordinator.is_master }}
{{ autodoc:colossalai.cluster.DistCoordinator.is_node_master }}
{{ autodoc:colossalai.cluster.DistCoordinator.is_last_process }}
{{ autodoc:colossalai.cluster.DistCoordinator.print_on_master }}
{{ autodoc:colossalai.cluster.DistCoordinator.print_on_node_master }}
{{ autodoc:colossalai.cluster.DistCoordinator.priority_execution }}
{{ autodoc:colossalai.cluster.DistCoordinator.destroy }}
{{ autodoc:colossalai.cluster.DistCoordinator.block_all }}
{{ autodoc:colossalai.cluster.DistCoordinator.on_master_only }}
<!-- doc-test-command: echo -->