ob-metaflow-stubs 5.9.1__py2.py3-none-any.whl → 6.0.3.102rc0__py2.py3-none-any.whl

metaflow-stubs/cards.pyi

@@ -1,19 +1,19 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.240437                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.814034                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.cards.card_client
-    import metaflow.plugins.cards.card_modules.components
+    import metaflow.plugins.cards.card_modules.card
+    import typing
     import metaflow
+    import metaflow.plugins.cards.card_modules.components
     import metaflow.plugins.cards.card_modules.basic
-    import typing
-    import metaflow.plugins.cards.card_modules.card
+    import metaflow.plugins.cards.card_client
 
 def get_cards(task: typing.Union[str, "metaflow.Task"], id: typing.Optional[str] = None, type: typing.Optional[str] = None, follow_resumed: bool = True) -> metaflow.plugins.cards.card_client.CardContainer:
     """

metaflow-stubs/cli.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.251393                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.830364                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/client/__init__.pyi

@@ -1,17 +1,17 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.243031                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.821018                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import datetime
-    import metaflow.events
     import metaflow.client.core
     import typing
+    import metaflow.events
+    import datetime
 
 def namespace(ns: typing.Optional[str]) -> typing.Optional[str]:
     """

metaflow-stubs/client/core.pyi

@@ -1,21 +1,21 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.232036                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.810174                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.client.core
-    import metaflow
     import metaflow.events
-    import datetime
+    import tarfile
+    import metaflow.exception
     import metaflow.metaflow_current
+    import metaflow
     import typing
-    import metaflow.exception
-    import tarfile
+    import metaflow.client.core
+    import datetime
 
 current: metaflow.metaflow_current.Current
 

metaflow-stubs/client/filecache.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.252267                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.831234                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.datastore.content_addressed_store
     import metaflow.exception
+    import metaflow.datastore.content_addressed_store
 
 class MetaflowException(Exception, metaclass=type):
     def __init__(self, msg = "", lineno = None):

metaflow-stubs/clone_util.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.250241                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.829253                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/events.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.233982                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.812063                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/exception.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.224297                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.802477                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/flowspec.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.233410                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.811484                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,11 +9,11 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
+    import metaflow.datastore.inputs
     import typing
     import metaflow.flowspec
-    import metaflow.parameters
     import metaflow.unbounded_foreach
-    import metaflow.datastore.inputs
+    import metaflow.parameters
 
 class DelayedEvaluationParameter(object, metaclass=type):
     def __init__(self, name, field, fun):

metaflow-stubs/generated_for.txt

@@ -1 +1 @@
-2.12.20.1+ob(v1) 2024-09-16T18:41:26.209390
+2.12.22.1+obcheckpoint(0.0.10);ob(v1) 2024-09-20T18:35:21.787332

metaflow-stubs/includefile.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.236851                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.816884                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -10,9 +10,9 @@ import typing
 if typing.TYPE_CHECKING:
     import metaflow._vendor.click.types
     import typing
+    import io
     import metaflow.parameters
     import metaflow.plugins.datatools.s3.s3
-    import io
 
 class MetaflowException(Exception, metaclass=type):
     def __init__(self, msg = "", lineno = None):

metaflow-stubs/info_file.pyi

@@ -0,0 +1,16 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.801656                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+CURRENT_DIRECTORY: str
+
+INFO_FILE: str
+
+def read_info_file():
+    ...
+

metaflow-stubs/metadata/metadata.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.275973                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.855144                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata/util.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.318064                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.906209                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_config.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.225367                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.803586                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_current.pyi

@@ -1,18 +1,20 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.320760                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.908720                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow
     import metaflow.plugins.cards.component_serializer
     import metaflow.events
     import metaflow.metaflow_current
     import typing
+    import metaflow
+    import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
+    import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
 
 TYPE_CHECKING: bool
 
@@ -221,6 +223,34 @@ class Current(object, metaclass=type):
     def graph(_):
         ...
     @property
+    def parallel(self) -> "metaflow.metaflow_current.Parallel":
+        """
+        (only in the presence of the @parallel decorator)
+        
+        
+        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)
@@ -239,31 +269,138 @@ class Current(object, metaclass=type):
         """
         ...
     @property
-    def parallel(self) -> "metaflow.metaflow_current.Parallel":
+    def checkpoint(self) -> "metaflow_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)
         
+        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
         -------
-        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.
+        CurrentCheckpointer
+            The object for handling checkpointing within a step.
         """
         ...
     @property
-    def is_parallel(self) -> bool:
+    def model(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
         """
-        (only in the presence of the @parallel decorator)
+        (only in the presence of the @model decorator)
         
-        True if the current step is a @parallel step.
+        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)
+        ```
+        
+        
+        Returns
+        -------
+        ModelSerializer
+            The object used for loading / saving models.
+        """
+        ...
+    @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
         """
         ...
     @property
@@ -333,19 +470,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_on_finish, or @trigger decorators)
-        
-        Returns `Trigger` if the current run is triggered by an event
-        
-        Returns
-        -------
-        Trigger
-            `Trigger` if triggered by an event
-        """
-        ...
     ...
 
 current: Current

metaflow-stubs/mflog/mflog.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.276300                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.855672                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/multicore_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.225811                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.804020                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/parameters.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.227032                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.805160                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,9 +9,9 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import typing
-    import metaflow._vendor.click.types
     import metaflow.parameters
     import metaflow.exception
+    import metaflow._vendor.click.types
 
 class ParameterFieldFailed(metaflow.exception.MetaflowException, metaclass=type):
     def __init__(self, name, field):

metaflow-stubs/plugins/__init__.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.238708                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.818535                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.unbounded_foreach
     import metaflow.plugins.cards.card_modules.card
+    import metaflow.unbounded_foreach
 
 CLIS_DESC: list
 

metaflow-stubs/plugins/airflow/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.262521                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.848374                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/airflow_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.304698                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.895665                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/exception.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.303763                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.894682                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/sensors/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.304946                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.895936                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.318611                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.906693                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.319002                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.907084                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.airflow.sensors.base_sensor
     import metaflow.decorators
     import metaflow.exception
+    import metaflow.plugins.airflow.sensors.base_sensor
 
 class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
     def __init__(self, *args, **kwargs):

metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.20.1+ob(v1)                                                   #
-# Generated on 2024-09-16T18:41:26.319342                                        #
+# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1)                              #
+# Generated on 2024-09-20T18:35:21.907429                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.airflow.sensors.base_sensor
     import metaflow.decorators
     import metaflow.exception
+    import metaflow.plugins.airflow.sensors.base_sensor
 
 class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
     def __init__(self, *args, **kwargs):