fixed docstrings

mosaicml · Feb 7, 2024 · 7d01495 · 7d01495
1 parent 4dd8524
commit 7d01495
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/llmfoundry/callbacks/curriculum_learning_callback.py b/llmfoundry/callbacks/curriculum_learning_callback.py
@@ -3,7 +3,8 @@
 
 """Enable curriculum learning by resuming with a different dataset.
 
-This callback is currently experimental. The API may change in the future.
+This callback is currently experimental. The API may change without warning in
+the future.
 """
 
 import logging
@@ -20,7 +21,7 @@
 class CurriculumLearning(Callback):
     """Starts an epoch with a different dataset when resuming from a checkpoint.
 
-    This callback is currently experimental. The API may change in the future.
+    This callback is currently experimental. The API may change without warning in the future.
 
     Args:
         dataset_index (int): The index of the dataset currently being used.

diff --git a/scripts/train/train.py b/scripts/train/train.py
@@ -475,6 +475,8 @@ def main(cfg: DictConfig) -> Trainer:
     )
 
     # Callbacks
+    # This has been moved below dataloader instantiation since some callbacks
+    # (e.g. CurriculumLearning) require access to the dataloader.
     callbacks: List[Callback] = [
         build_callback(str(name), callback_cfg, om.to_container(logged_cfg),
                        train_loader.dataloader)