ob-metaflow-stubs 6.0.3.115__py2.py3-none-any.whl → 6.0.3.116__py2.py3-none-any.whl

metaflow-stubs/cards.pyi

@@ -1,19 +1,19 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.745053                                        #
+# Generated on 2024-11-04T20:32:12.987624                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import typing
-    import metaflow.plugins.cards.card_modules.basic
-    import metaflow.plugins.cards.card_client
     import metaflow
-    import metaflow.plugins.cards.card_modules.components
+    import typing
     import metaflow.plugins.cards.card_modules.card
+    import metaflow.plugins.cards.card_modules.components
+    import metaflow.plugins.cards.card_client
+    import metaflow.plugins.cards.card_modules.basic
 
 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,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.761596                                        #
+# Generated on 2024-11-04T20:32:13.007974                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.metaflow_current
     import metaflow.exception
+    import metaflow.metaflow_current
 
 def get_metadata() -> str:
     """

metaflow-stubs/client/__init__.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.751982                                        #
+# Generated on 2024-11-04T20:32:12.996576                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import typing
     import metaflow.events
+    import typing
     import datetime
     import metaflow.client.core
 

metaflow-stubs/client/core.pyi

@@ -1,21 +1,21 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.741608                                        #
+# Generated on 2024-11-04T20:32:12.982719                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow
     import typing
+    import metaflow.exception
     import metaflow.metaflow_current
     import datetime
-    import metaflow.events
-    import metaflow.exception
     import metaflow.client.core
+    import metaflow.events
     import tarfile
-    import metaflow
 
 TYPE_CHECKING: bool
 

metaflow-stubs/client/filecache.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.762456                                        #
+# Generated on 2024-11-04T20:32:13.008843                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/clone_util.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.760436                                        #
+# Generated on 2024-11-04T20:32:13.006832                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/events.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.745670                                        #
+# Generated on 2024-11-04T20:32:12.984969                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/exception.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.732561                                        #
+# Generated on 2024-11-04T20:32:12.974945                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/flowspec.pyi

@@ -1,19 +1,19 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.742986                                        #
+# Generated on 2024-11-04T20:32:12.984348                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.datastore.inputs
     import typing
+    import metaflow.flowspec
     import metaflow.unbounded_foreach
-    import metaflow.parameters
     import metaflow.exception
-    import metaflow.datastore.inputs
-    import metaflow.flowspec
+    import metaflow.parameters
 
 class DelayedEvaluationParameter(object, metaclass=type):
     """

metaflow-stubs/generated_for.txt

@@ -1 +1 @@
-2.12.27.1+obcheckpoint(0.1.1);ob(v1) 2024-10-25T21:39:54.716202
+2.12.27.1+obcheckpoint(0.1.1);ob(v1) 2024-11-04T20:32:12.959508

metaflow-stubs/includefile.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.748434                                        #
+# Generated on 2024-11-04T20:32:12.991681                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,10 +9,10 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import typing
-    import metaflow._vendor.click.types
-    import metaflow.parameters
     import metaflow.plugins.datatools.s3.s3
     import io
+    import metaflow.parameters
+    import metaflow._vendor.click.types
 
 class MetaflowException(Exception, metaclass=type):
     def __init__(self, msg = "", lineno = None):

metaflow-stubs/info_file.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.731461                                        #
+# Generated on 2024-11-04T20:32:12.974270                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata/metadata.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.786249                                        #
+# Generated on 2024-11-04T20:32:13.033616                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata/util.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.833493                                        #
+# Generated on 2024-11-04T20:32:13.079493                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_config.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.734509                                        #
+# Generated on 2024-11-04T20:32:12.975983                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_current.pyi

@@ -1,21 +1,21 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.836176                                        #
+# Generated on 2024-11-04T20:32:13.082093                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
+    import metaflow
     import typing
     import metaflow.metaflow_current
-    import metaflow.events
-    import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
     import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
+    import metaflow.events
     import metaflow.plugins.cards.component_serializer
-    import metaflow
-    import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
+    import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
 
 TYPE_CHECKING: bool
 
@@ -227,64 +227,21 @@ class Current(object, metaclass=type):
     def graph(_):
         ...
     @property
-    def checkpoint(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
+    def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
         """
-        (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.
+        (only in the presence of the @card decorator)
         
-        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
+        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].
         
-            model = create_model(self.parameters, checkpoint_path = checkpoint_path)
-            for i in range(self.epochs):
-                ...
-        ```
+        Methods available are `append` and `extend`
         
         Returns
         -------
-        CurrentCheckpointer
-            The object for handling checkpointing within a step.
+        CardComponentCollector
+            The or one of the cards attached to this step.
         """
         ...
     @property
@@ -349,24 +306,6 @@ class Current(object, metaclass=type):
         """
         ...
     @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
     def parallel(self) -> "metaflow.metaflow_current.Parallel":
         """
         (only in the presence of the @parallel decorator)
@@ -429,9 +368,70 @@ class Current(object, metaclass=type):
         """
         ...
     @property
+    def checkpoint(self) -> "metaflow_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
+        @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 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/mflog/mflog.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.786741                                        #
+# Generated on 2024-11-04T20:32:13.033941                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/multicore_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.735169                                        #
+# Generated on 2024-11-04T20:32:12.976392                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/parameters.pyi

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.736490                                        #
+# Generated on 2024-11-04T20:32:12.977607                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.exception
     import typing
     import metaflow.parameters
-    import metaflow.exception
     import metaflow._vendor.click.types
 
 class ParameterFieldFailed(metaflow.exception.MetaflowException, metaclass=type):

metaflow-stubs/plugins/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.753757                                        #
+# Generated on 2024-11-04T20:32:13.000091                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.780145                                        #
+# Generated on 2024-11-04T20:32:13.026808                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/airflow_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.823226                                        #
+# Generated on 2024-11-04T20:32:13.068862                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/exception.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.822259                                        #
+# Generated on 2024-11-04T20:32:13.067744                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.823525                                        #
+# Generated on 2024-11-04T20:32:13.069173                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.834025                                        #
+# Generated on 2024-11-04T20:32:13.080017                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.decorators
     import metaflow.exception
+    import metaflow.decorators
 
 class AirflowException(metaflow.exception.MetaflowException, metaclass=type):
     def __init__(self, msg):

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

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.834534                                        #
+# Generated on 2024-11-04T20:32:13.080436                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.decorators
-    import metaflow.exception
     import metaflow.plugins.airflow.sensors.base_sensor
+    import metaflow.exception
+    import metaflow.decorators
 
 class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
     """

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

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.834913                                        #
+# Generated on 2024-11-04T20:32:13.080813                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.decorators
-    import metaflow.exception
     import metaflow.plugins.airflow.sensors.base_sensor
+    import metaflow.exception
+    import metaflow.decorators
 
 class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
     """

metaflow-stubs/plugins/argo/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.779378                                        #
+# Generated on 2024-11-04T20:32:13.021990                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/argo/argo_client.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.812794                                        #
+# Generated on 2024-11-04T20:32:13.044250                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/argo/argo_events.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.810732                                        #
+# Generated on 2024-11-04T20:32:13.042301                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/argo/argo_workflows.pyi

@@ -1,18 +1,18 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1)                               #
-# Generated on 2024-10-25T21:39:54.817522                                        #
+# Generated on 2024-11-04T20:32:13.048932                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.metaflow_current
     import metaflow.graph
-    import metaflow._vendor.click.types
-    import metaflow.parameters
     import metaflow.exception
+    import metaflow.metaflow_current
+    import metaflow.parameters
+    import metaflow._vendor.click.types
 
 inf: float