Skip to content

Commit 7a9253c

Browse files
foreverlmsclaude
authored andcommitted
docs: fix stale dataloader-state callback references in custom_datase… (#40)
Update document for custom dataset. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 499835d commit 7a9253c

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/custom_dataset.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -249,11 +249,11 @@ Override from the CLI like any Hydra node, e.g.
249249

250250
## 5. Checkpoint / resume
251251

252-
Resume is handled by the existing `DataLoaderStateCallback`:
252+
Resume is handled by `CosmosDataLoaderStateCallback`:
253253

254254
```python
255-
from cosmos_framework.callbacks.dataloader_state import DataLoaderStateCallback
256-
cb = DataLoaderStateCallback(distributor_type="cosmos_dataloader")
255+
from cosmos_framework.callbacks.cosmos_dataloader_state import CosmosDataLoaderStateCallback
256+
cb = CosmosDataLoaderStateCallback()
257257
```
258258

259259
- Use a **`MapDistributor`** source. On save, the callback records each worker's
@@ -266,8 +266,8 @@ cb = DataLoaderStateCallback(distributor_type="cosmos_dataloader")
266266
- For multiple loaders sharing a process (e.g. inside `JointCosmosDataLoader`),
267267
give each a distinct `name=` so resume env vars are namespaced
268268
(`COSMOS_DL_STATE_{name}_WORKER_{id}_{EPOCH,INDEX}`), and use a single
269-
`JointDataLoaderStateCallback(outer_loader=joint_loader, distributor_type="cosmos_dataloader")`
270-
instead of one `DataLoaderStateCallback` per inner loader.
269+
`JointCosmosDataLoaderStateCallback(outer_loader=joint_loader)`
270+
instead of one `CosmosDataLoaderStateCallback` per inner loader.
271271
- Use `ckpt_type=dcp` (the default) — not `ckpt_type=dummy`, which disables all
272272
checkpointing. The on-disk checkpoint format is unchanged.
273273

@@ -423,7 +423,7 @@ collator: VFMListCollator # media kept as p
423423
- [ ] Pick a **collator**: `DefaultBatchCollator`, `VFMListCollator`, or your own
424424
(must match the structure the model consumes).
425425
- [ ] For real resume: use a `MapDistributor`, add
426-
`DataLoaderStateCallback(distributor_type="cosmos_dataloader")`, and
426+
`CosmosDataLoaderStateCallback()`, and
427427
`ckpt_type=dcp` (not `dummy`).
428428
- [ ] For FSDP+TP/PP, pass `parallel_dims=` so the correct DP rank is used.
429429
- [ ] Register the experiment in the Hydra ConfigStore
@@ -437,8 +437,8 @@ collator: VFMListCollator # media kept as p
437437
`name=` matching its key in `dataloaders` (namespaces resume env vars).
438438
- [ ] Set each dataset's `ratio` (controls how often it is visited, per batch).
439439
- [ ] Use a single
440-
`JointDataLoaderStateCallback(outer_loader=joint_loader, distributor_type="cosmos_dataloader")`
441-
— do **not** also register a standalone `DataLoaderStateCallback` per inner
440+
`JointCosmosDataLoaderStateCallback(outer_loader=joint_loader)`
441+
— do **not** also register a standalone `CosmosDataLoaderStateCallback` per inner
442442
loader.
443443
- [ ] Avoid `"global_id"` as a dataset name (reserved by the checkpoint state).
444444
- [ ] Use `ckpt_type=dcp` for real checkpoint/resume.

0 commit comments

Comments
 (0)