Add docstring to _iteration_length (#3088)

mosaicml · Mar 29, 2024 · d05c40d · d05c40d
1 parent 541d12c
commit d05c40d
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/composer/core/state.py b/composer/core/state.py
@@ -615,6 +615,10 @@ def _iteration_length(self):
 
     @_iteration_length.setter
     def _iteration_length(self, iteration_length: Optional[Union[str, Time[int]]]):
+        """Sets the length of an iteration.
+
+        An iteration must be defined as multiple epochs. See composer/core/event.py.
+        """
         if iteration_length is None:
             self.__iteration_length = None
             return