ob-metaflow-stubs 6.0.3.172__py2.py3-none-any.whl → 6.0.3.173__py2.py3-none-any.whl

metaflow-stubs/cards.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.519875                                                            #
+# Generated on 2025-05-29T17:52:46.095618                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/cli.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.535539                                                            #
+# Generated on 2025-05-29T17:52:46.111771                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/cli_components/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.534400                                                            #
+# Generated on 2025-05-29T17:52:46.110582                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/cli_components/utils.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.562177                                                            #
+# Generated on 2025-05-29T17:52:46.138451                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/client/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.523627                                                            #
+# Generated on 2025-05-29T17:52:46.099766                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/client/core.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.528015                                                            #
+# Generated on 2025-05-29T17:52:46.104149                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -10,11 +10,11 @@ import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.client.core
+    import metaflow.events
     import tempfile
     import datetime
-    import metaflow.events
-    import tarfile
     import typing
+    import tarfile
 
 from ..metaflow_current import current as current
 from ..events import Trigger as Trigger

metaflow-stubs/client/filecache.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.557195                                                            #
+# Generated on 2025-05-29T17:52:46.133550                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
 import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.datastore.content_addressed_store
     import metaflow.exception
+    import metaflow.datastore.content_addressed_store
 
 from ..exception import MetaflowException as MetaflowException
 

metaflow-stubs/events.pyi

@@ -1,15 +1,15 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.520459                                                            #
+# Generated on 2025-05-29T17:52:46.096231                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow
     import metaflow.events
+    import metaflow
 
 
 TYPE_CHECKING: bool

metaflow-stubs/exception.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.512122                                                            #
+# Generated on 2025-05-29T17:52:46.088092                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/flowspec.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.516798                                                            #
+# Generated on 2025-05-29T17:52:46.092656                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -10,10 +10,10 @@ import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.flowspec
-    import metaflow.unbounded_foreach
-    import metaflow.exception
     import metaflow.datastore.inputs
+    import metaflow.unbounded_foreach
     import typing
+    import metaflow.exception
 
 from . import parameters as parameters
 from .parameters import DelayedEvaluationParameter as DelayedEvaluationParameter

metaflow-stubs/generated_for.txt

@@ -1 +1 @@
-2.15.14.1+obcheckpoint(0.2.1);ob(v1) 2025-05-27T03:43:23.506700
+2.15.14.1+obcheckpoint(0.2.1);ob(v1) 2025-05-29T17:52:46.082566

metaflow-stubs/includefile.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.522959                                                            #
+# Generated on 2025-05-29T17:52:46.099082                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/info_file.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.511421                                                            #
+# Generated on 2025-05-29T17:52:46.087352                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.515706                                                            #
+# Generated on 2025-05-29T17:52:46.091573                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/heartbeat.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.540387                                                            #
+# Generated on 2025-05-29T17:52:46.117024                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/metadata.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.539880                                                            #
+# Generated on 2025-05-29T17:52:46.116493                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.540104                                                            #
+# Generated on 2025-05-29T17:52:46.116754                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_config.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.513266                                                            #
+# Generated on 2025-05-29T17:52:46.089187                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_current.pyi

@@ -1,20 +1,20 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.658595                                                            #
+# Generated on 2025-05-29T17:52:46.233747                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.plugins.cards.component_serializer
     import metaflow
-    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
-    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
     import metaflow.events
-    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
     import metaflow.metaflow_current
-    import metaflow.plugins.cards.component_serializer
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
     import typing
 
 
@@ -228,125 +228,32 @@ class Current(object, metaclass=type):
     def graph(self):
         ...
     @property
-    def model(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
+    def parallel(self) -> "metaflow.metaflow_current.Parallel":
         """
-        (only in the presence of the @model decorator)
-        
-        The object used for loading / saving models.
-        `current.model` exposes a `save` method to save models and a `load` method to load models.
-        `current.model.loaded` exposes the paths to the models loaded via the `load` argument in the @model decorator
-        or models loaded via `current.model.load`.
-        
-        Usage (Saving a model):
-        -------
-        
-        ```
-        @model
-        @step
-        def train(self):
-            # current.model.save returns a dictionary reference to the model saved
-            self.my_model = current.model.save(
-                path_to_my_model,
-                label="my_model",
-                metadata={
-                    "epochs": 10,
-                    "batch-size": 32,
-                    "learning-rate": 0.001,
-                }
-            )
-            self.next(self.test)
-        
-        @model(load="my_model")
-        @step
-        def test(self):
-            # `current.model.loaded` returns a dictionary of the loaded models
-            # where the key is the name of the artifact and the value is the path to the model
-            print(os.listdir(current.model.loaded["my_model"]))
-            self.next(self.end)
-        ```
-        
-        Usage (Loading models):
-        -------
-        
-        ```
-        @step
-        def train(self):
-            # current.model.load returns the path to the model loaded
-            checkpoint_path = current.model.load(
-                self.checkpoint_key,
-            )
-            model_path = current.model.load(
-                self.model,
-            )
-            self.next(self.test)
-        ```
+        (only in the presence of the @parallel decorator)
         
+        Returns a namedtuple with relevant information about the parallel task.
         
         Returns
         -------
-        ModelSerializer
-            The object used for loading / saving models.
+        Parallel
+            `namedtuple` with the following fields:
+                - main_ip (`str`)
+                    The IP address of the control task.
+                - num_nodes (`int`)
+                    The total number of tasks created by @parallel
+                - node_index (`int`)
+                    The index of the current task in all the @parallel tasks.
+                - control_task_id (`Optional[str]`)
+                    The task ID of the control task. Available to all tasks.
         """
         ...
     @property
-    def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
+    def is_parallel(self) -> bool:
         """
-        (only in the presence of the @checkpoint decorator)
-        
-        The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
-        The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
-        
-        You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
-        by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
-        where the checkpoint maybe loaded or saved.
-        
-        Usage (Saving Checkpoints):
-        -------
-        ```
-        @checkpoint
-        @step
-        def train(self):
-            model = create_model(self.parameters, checkpoint_path = None)
-            for i in range(self.epochs):
-                # some training logic
-                loss = model.train(self.dataset)
-                if i % 10 == 0:
-                    model.save(
-                        current.checkpoint.directory,
-                    )
-                    # saves the contents of the `current.checkpoint.directory` as a checkpoint
-                    # and returns a reference dictionary to the checkpoint saved in the datastore
-                    self.latest_checkpoint = current.checkpoint.save(
-                        name="epoch_checkpoint",
-                        metadata={
-                            "epoch": i,
-                            "loss": loss,
-                        }
-                    )
-        ```
-        Usage (Using Loaded Checkpoints):
-        -------
-        ```
-        @retry(times=3)
-        @checkpoint
-        @step
-        def train(self):
-            # Assume that the task has restarted and the previous attempt of the task
-            # saved a checkpoint
-            checkpoint_path = None
-            if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
-                print("Loaded checkpoint from the previous attempt")
-                checkpoint_path = current.checkpoint.directory
-        
-            model = create_model(self.parameters, checkpoint_path = checkpoint_path)
-            for i in range(self.epochs):
-                ...
-        ```
+        (only in the presence of the @parallel decorator)
         
-        Returns
-        -------
-        CurrentCheckpointer
-            The object for handling checkpointing within a step.
+        True if the current step is a @parallel step.
         """
         ...
     @property
@@ -419,50 +326,143 @@ class Current(object, metaclass=type):
         """
         ...
     @property
-    def parallel(self) -> "metaflow.metaflow_current.Parallel":
+    def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
         """
-        (only in the presence of the @parallel decorator)
+        (only in the presence of the @card decorator)
         
-        Returns a namedtuple with relevant information about the parallel task.
+        The `@card` decorator makes the cards available through the `current.card`
+        object. If multiple `@card` decorators are present, you can add an `ID` to
+        distinguish between them using `@card(id=ID)` as the decorator. You will then
+        be able to access that specific card using `current.card[ID].
+        
+        Methods available are `append` and `extend`
         
         Returns
         -------
-        Parallel
-            `namedtuple` with the following fields:
-                - main_ip (`str`)
-                    The IP address of the control task.
-                - num_nodes (`int`)
-                    The total number of tasks created by @parallel
-                - node_index (`int`)
-                    The index of the current task in all the @parallel tasks.
-                - control_task_id (`Optional[str]`)
-                    The task ID of the control task. Available to all tasks.
+        CardComponentCollector
+            The or one of the cards attached to this step.
         """
         ...
     @property
-    def is_parallel(self) -> bool:
+    def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
         """
-        (only in the presence of the @parallel decorator)
+        (only in the presence of the @checkpoint decorator)
         
-        True if the current step is a @parallel step.
+        The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
+        The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
+        
+        You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
+        by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
+        where the checkpoint maybe loaded or saved.
+        
+        Usage (Saving Checkpoints):
+        -------
+        ```
+        @checkpoint
+        @step
+        def train(self):
+            model = create_model(self.parameters, checkpoint_path = None)
+            for i in range(self.epochs):
+                # some training logic
+                loss = model.train(self.dataset)
+                if i % 10 == 0:
+                    model.save(
+                        current.checkpoint.directory,
+                    )
+                    # saves the contents of the `current.checkpoint.directory` as a checkpoint
+                    # and returns a reference dictionary to the checkpoint saved in the datastore
+                    self.latest_checkpoint = current.checkpoint.save(
+                        name="epoch_checkpoint",
+                        metadata={
+                            "epoch": i,
+                            "loss": loss,
+                        }
+                    )
+        ```
+        Usage (Using Loaded Checkpoints):
+        -------
+        ```
+        @retry(times=3)
+        @checkpoint
+        @step
+        def train(self):
+            # Assume that the task has restarted and the previous attempt of the task
+            # saved a checkpoint
+            checkpoint_path = None
+            if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
+                print("Loaded checkpoint from the previous attempt")
+                checkpoint_path = current.checkpoint.directory
+        
+            model = create_model(self.parameters, checkpoint_path = checkpoint_path)
+            for i in range(self.epochs):
+                ...
+        ```
+        
+        Returns
+        -------
+        CurrentCheckpointer
+            The object for handling checkpointing within a step.
         """
         ...
     @property
-    def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
+    def model(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
         """
-        (only in the presence of the @card decorator)
+        (only in the presence of the @model decorator)
         
-        The `@card` decorator makes the cards available through the `current.card`
-        object. If multiple `@card` decorators are present, you can add an `ID` to
-        distinguish between them using `@card(id=ID)` as the decorator. You will then
-        be able to access that specific card using `current.card[ID].
+        The object used for loading / saving models.
+        `current.model` exposes a `save` method to save models and a `load` method to load models.
+        `current.model.loaded` exposes the paths to the models loaded via the `load` argument in the @model decorator
+        or models loaded via `current.model.load`.
+        
+        Usage (Saving a model):
+        -------
+        
+        ```
+        @model
+        @step
+        def train(self):
+            # current.model.save returns a dictionary reference to the model saved
+            self.my_model = current.model.save(
+                path_to_my_model,
+                label="my_model",
+                metadata={
+                    "epochs": 10,
+                    "batch-size": 32,
+                    "learning-rate": 0.001,
+                }
+            )
+            self.next(self.test)
+        
+        @model(load="my_model")
+        @step
+        def test(self):
+            # `current.model.loaded` returns a dictionary of the loaded models
+            # where the key is the name of the artifact and the value is the path to the model
+            print(os.listdir(current.model.loaded["my_model"]))
+            self.next(self.end)
+        ```
+        
+        Usage (Loading models):
+        -------
+        
+        ```
+        @step
+        def train(self):
+            # current.model.load returns the path to the model loaded
+            checkpoint_path = current.model.load(
+                self.checkpoint_key,
+            )
+            model_path = current.model.load(
+                self.model,
+            )
+            self.next(self.test)
+        ```
         
-        Methods available are `append` and `extend`
         
         Returns
         -------
-        CardComponentCollector
-            The or one of the cards attached to this step.
+        ModelSerializer
+            The object used for loading / saving models.
         """
         ...
     @property
@@ -535,7 +535,7 @@ class Current(object, metaclass=type):
     @property
     def trigger(self) -> "metaflow.events.Trigger":
         """
-        (only in the presence of the @trigger_on_finish, or @trigger decorators)
+        (only in the presence of the @trigger, or @trigger_on_finish decorators)
         
         Returns `Trigger` if the current run is triggered by an event
         

metaflow-stubs/metaflow_git.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.519491                                                            #
+# Generated on 2025-05-29T17:52:46.096527                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/mf_extensions/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.521818                                                            #
+# Generated on 2025-05-29T17:52:46.097847                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.530885                                                            #
+# Generated on 2025-05-29T17:52:46.107080                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/plugins/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.530958                                                            #
+# Generated on 2025-05-29T17:52:46.107141                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.531014                                                            #
+# Generated on 2025-05-29T17:52:46.107196                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1)                                                   #
-# Generated on 2025-05-27T03:43:23.586296                                                            #
+# Generated on 2025-05-29T17:52:46.161288                                                            #
 ######################################################################################################