Skip to content

Commit b5ced80

Browse files
committed
update doc
1 parent 9e6628f commit b5ced80

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/sphinx_doc/source/tutorial/trinity_configs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ checkpoint_root_dir: ${oc.env:TRINITY_CHECKPOINT_ROOT_DIR,./checkpoints} # TRI
8282
- `explore`: Only launches the explorer.
8383
- `bench`: Used for benchmarking.
8484
- `checkpoint_root_dir`: Root directory where all checkpoints and logs will be saved. Checkpoints for this experiment will be stored in `<checkpoint_root_dir>/<project>/<name>/`.
85-
- `continue_from_checkpoint`: If set to `true`, the experiment will continue from the latest checkpoint in the checkpoint path (if any); otherwise, it will rename the current experiment to `<name>_<timestamp>` and start a new experiment.
85+
- `continue_from_checkpoint`: If set to `true`, the experiment will continue from the latest checkpoint in the checkpoint path (if any); otherwise, it will rename the current experiment to `<name>_<timestamp>` and start a new experiment. Due to our decoupled design, during recovery from a checkpoint, we can only guarantee that the Trainer's model parameters and its optional auxiliary buffers (`auxiliary_buffers`) are restored to their latest checkpointed states, while the Explorer and Experience Buffer cannot be guaranteed to be restored to the same point in time.
8686
- `ray_namespace`: Namespace for the modules launched in the current experiment. If not specified, it will be set to `<project>/<name>`.
8787

8888
---

docs/sphinx_doc/source_zh/tutorial/trinity_configs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ checkpoint_root_dir: ${oc.env:TRINITY_CHECKPOINT_ROOT_DIR,./checkpoints} # TRI
8282
- `explore`: 仅启动 explorer。
8383
- `bench`: 用于 benchmark 测试。
8484
- `checkpoint_root_dir`: 所有检查点和日志的根目录。该实验的检查点将存储在 `<checkpoint_root_dir>/<project>/<name>/` 路径下。
85-
- `continue_from_checkpoint`: 若设置为 `true`,实验将从检查点路径中的最新检查点继续;否则,会将当前实验重命名为 `<name>_<timestamp>` 并启动新实验。
85+
- `continue_from_checkpoint`: 若设置为 `true`,实验将从检查点路径中的最新检查点继续;否则,会将当前实验重命名为 `<name>_<timestamp>` 并启动新实验。由于我们的分离式设计,从检查点恢复的时候,我们只能保证Trainer的模型参数以及其使用的可选缓冲区(`auxiliary_buffers`)可以恢复到最新检查点的状态,而Explorer和Experience Buffer不能保证恢复到同一时点。
8686
- `ray_namespace`: 当前实验中启动模块的命名空间。若未指定,则默认为 `<project>/<name>`。
8787

8888
---

0 commit comments

Comments
 (0)