ob-metaflow-stubs 6.0.3.141__py2.py3-none-any.whl → 6.0.3.143__py2.py3-none-any.whl

metaflow-stubs/cards.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.926897                                                            #
+# Generated on 2025-02-17T23:51:59.711142                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/cli.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.941918                                                            #
+# Generated on 2025-02-17T23:51:59.725144                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/cli_components/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.940692                                                            #
+# Generated on 2025-02-17T23:51:59.723892                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/cli_components/utils.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.966007                                                            #
+# Generated on 2025-02-17T23:51:59.750071                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/client/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.930023                                                            #
+# Generated on 2025-02-17T23:51:59.714637                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/client/core.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.935574                                                            #
+# Generated on 2025-02-17T23:51:59.718906                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -9,11 +9,11 @@ from __future__ import annotations
 import typing
 import metaflow
 if typing.TYPE_CHECKING:
-    import tarfile
-    import datetime
     import metaflow.events
-    import typing
+    import datetime
+    import tarfile
     import metaflow.client.core
+    import typing
 
 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.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.961165                                                            #
+# Generated on 2025-02-17T23:51:59.745081                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/events.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.926503                                                            #
+# Generated on 2025-02-17T23:51:59.711920                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/exception.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.918682                                                            #
+# Generated on 2025-02-17T23:51:59.702899                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/flowspec.pyi

@@ -1,19 +1,19 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.923338                                                            #
+# Generated on 2025-02-17T23:51:59.707587                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import typing
 import metaflow
+import typing
 if typing.TYPE_CHECKING:
-    import metaflow.unbounded_foreach
     import metaflow.flowspec
+    import metaflow.unbounded_foreach
+    import metaflow.exception
     import metaflow.datastore.inputs
     import typing
-    import metaflow.exception
 
 from . import parameters as parameters
 from .parameters import DelayedEvaluationParameter as DelayedEvaluationParameter

metaflow-stubs/generated_for.txt

@@ -1 +1 @@
-2.14.0.1+obcheckpoint(0.1.8);ob(v1) 2025-02-13T16:37:06.915460
+2.14.0.1+obcheckpoint(0.1.8);ob(v1) 2025-02-17T23:51:59.699271

metaflow-stubs/includefile.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.929582                                                            #
+# Generated on 2025-02-17T23:51:59.714327                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -9,9 +9,9 @@ from __future__ import annotations
 import typing
 import metaflow
 if typing.TYPE_CHECKING:
-    import metaflow._vendor.click.types
-    import metaflow.parameters
     import typing
+    import metaflow.parameters
+    import metaflow._vendor.click.types
 
 from ._vendor import click as click
 from .exception import MetaflowException as MetaflowException

metaflow-stubs/info_file.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.917796                                                            #
+# Generated on 2025-02-17T23:51:59.702126                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.922222                                                            #
+# Generated on 2025-02-17T23:51:59.706455                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/heartbeat.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.945528                                                            #
+# Generated on 2025-02-17T23:51:59.729463                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/metadata.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.945044                                                            #
+# Generated on 2025-02-17T23:51:59.728982                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.945266                                                            #
+# Generated on 2025-02-17T23:51:59.729207                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_config.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.919801                                                            #
+# Generated on 2025-02-17T23:51:59.704015                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_current.pyi

@@ -1,21 +1,21 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:07.059876                                                            #
+# Generated on 2025-02-17T23:51:59.843480                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
-    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
-    import metaflow.events
-    import metaflow.plugins.cards.component_serializer
+    import metaflow
     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
     import typing
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
+    import metaflow.plugins.cards.component_serializer
 
 
 TYPE_CHECKING: bool
@@ -228,82 +228,111 @@ class Current(object, metaclass=type):
     def graph(self):
         ...
     @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)
-        
-        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].
+        (only in the presence of the @model decorator)
         
-        Methods available are `append` and `extend`
+        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`.
         
-        Returns
+        Usage (Saving a model):
         -------
-        CardComponentCollector
-            The or one of the cards attached to this step.
-        """
-        ...
-    @property
-    def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
-        """
-        (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
+        @model
         @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,
-                        }
-                    )
+            # 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 (Using Loaded Checkpoints):
+        
+        Usage (Loading models):
         -------
+        
         ```
-        @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):
-                ...
+            # 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)
         ```
         
+        
         Returns
         -------
-        CurrentCheckpointer
-            The object for handling checkpointing within a step.
+        ModelSerializer
+            The object used for loading / saving models.
+        """
+        ...
+    @property
+    def parallel(self) -> "metaflow.metaflow_current.Parallel":
+        """
+        (only in the presence of the @parallel decorator)
+        
+        Returns a namedtuple with relevant information about the parallel task.
+        
+        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.
+        """
+        ...
+    @property
+    def is_parallel(self) -> bool:
+        """
+        (only in the presence of the @parallel decorator)
+        
+        True if the current step is a @parallel step.
+        """
+        ...
+    @property
+    def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
+        """
+        (only in the presence of the @card 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].
+        
+        Methods available are `append` and `extend`
+        
+        Returns
+        -------
+        CardComponentCollector
+            The or one of the cards attached to this step.
         """
         ...
     @property
@@ -376,93 +405,77 @@ class Current(object, metaclass=type):
         """
         ...
     @property
-    def parallel(self) -> "metaflow.metaflow_current.Parallel":
-        """
-        (only in the presence of the @parallel decorator)
-        
-        Returns a namedtuple with relevant information about the parallel task.
-        
-        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.
-        """
-        ...
-    @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.
-        """
-        ...
-    @property
-    def model(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
-        """
-        (only in the presence of the @model decorator)
+        The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
+        The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
         
-        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`.
+        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 a model):
+        Usage (Saving Checkpoints):
         -------
-        
         ```
-        @model
+        @checkpoint
         @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)
+            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 (Loading models):
+        Usage (Using Loaded Checkpoints):
         -------
-        
         ```
+        @retry(times=3)
+        @checkpoint
         @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)
+            # 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 trigger(self) -> "metaflow.events.Trigger":
+        """
+        (only in the presence of the @trigger, or @trigger_on_finish decorators)
+        
+        Returns `Trigger` if the current run is triggered by an event
         
         Returns
         -------
-        ModelSerializer
-            The object used for loading / saving models.
+        Trigger
+            `Trigger` if triggered by an event
         """
         ...
     @property
@@ -532,19 +545,6 @@ class Current(object, metaclass=type):
             True if the flow is deployed with `--production`.
         """
         ...
-    @property
-    def trigger(self) -> "metaflow.events.Trigger":
-        """
-        (only in the presence of the @trigger, or @trigger_on_finish decorators)
-        
-        Returns `Trigger` if the current run is triggered by an event
-        
-        Returns
-        -------
-        Trigger
-            `Trigger` if triggered by an event
-        """
-        ...
     ...
 
 current: Current

metaflow-stubs/mf_extensions/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.928133                                                            #
+# Generated on 2025-02-17T23:51:59.713210                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.938464                                                            #
+# Generated on 2025-02-17T23:51:59.721751                                                            #
 ######################################################################################################
 

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

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.938524                                                            #
+# Generated on 2025-02-17T23:51:59.721811                                                            #
 ######################################################################################################
 

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

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
 # MF version: 2.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.938577                                                            #
+# Generated on 2025-02-17T23:51:59.721866                                                            #
 ######################################################################################################
 

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.14.0.1+obcheckpoint(0.1.8);ob(v1)                                                    #
-# Generated on 2025-02-13T16:37:06.990062                                                            #
+# Generated on 2025-02-17T23:51:59.774255                                                            #
 ######################################################################################################