ob-metaflow-stubs 6.0.3.110__py2.py3-none-any.whl → 6.0.3.111__py2.py3-none-any.whl

metaflow-stubs/cards.pyi

@@ -1,19 +1,19 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.850658                                        #
+# Generated on 2024-10-21T17:14:28.449301                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.cards.card_modules.basic
-    import metaflow.plugins.cards.card_modules.components
     import metaflow.plugins.cards.card_client
+    import metaflow.plugins.cards.card_modules.components
     import metaflow.plugins.cards.card_modules.card
-    import metaflow
     import typing
+    import metaflow
+    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.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.868811                                        #
+# Generated on 2024-10-21T17:14:28.465838                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.exception
     import metaflow.metaflow_current
+    import metaflow.exception
 
 def get_metadata() -> str:
     """

metaflow-stubs/client/__init__.pyi

@@ -1,17 +1,17 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.856829                                        #
+# Generated on 2024-10-21T17:14:28.456087                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import datetime
     import typing
-    import metaflow.client.core
     import metaflow.events
+    import metaflow.client.core
+    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.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.846575                                        #
+# Generated on 2024-10-21T17:14:28.445808                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.events
     import metaflow.exception
-    import metaflow.client.core
+    import typing
     import metaflow.metaflow_current
+    import metaflow
+    import metaflow.client.core
     import datetime
     import tarfile
-    import metaflow
-    import typing
-    import metaflow.events
 
 current: metaflow.metaflow_current.Current
 

metaflow-stubs/client/filecache.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.869683                                        #
+# Generated on 2024-10-21T17:14:28.466737                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.exception
     import metaflow.datastore.content_addressed_store
+    import metaflow.exception
 
 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.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.867260                                        #
+# Generated on 2024-10-21T17:14:28.464727                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/events.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.851300                                        #
+# Generated on 2024-10-21T17:14:28.449891                                        #
 ##################################################################################
 
 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.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.838642                                        #
+# Generated on 2024-10-21T17:14:28.438086                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/flowspec.pyi

@@ -1,19 +1,19 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.847965                                        #
+# Generated on 2024-10-21T17:14:28.447298                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.datastore.inputs
-    import metaflow.exception
     import metaflow.flowspec
     import metaflow.parameters
-    import metaflow.unbounded_foreach
+    import metaflow.exception
+    import metaflow.datastore.inputs
     import typing
+    import metaflow.unbounded_foreach
 
 class DelayedEvaluationParameter(object, metaclass=type):
     """

metaflow-stubs/generated_for.txt

@@ -1 +1 @@
-2.12.25.2+obcheckpoint(0.1.0);ob(v1) 2024-10-16T01:27:45.821883
+2.12.25.2+obcheckpoint(0.1.0);ob(v1) 2024-10-21T17:14:28.423007

metaflow-stubs/includefile.pyi

@@ -1,18 +1,18 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.854197                                        #
+# Generated on 2024-10-21T17:14:28.452700                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.datatools.s3.s3
     import metaflow.parameters
+    import metaflow._vendor.click.types
     import typing
+    import metaflow.plugins.datatools.s3.s3
     import io
-    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.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.837852                                        #
+# Generated on 2024-10-21T17:14:28.437405                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata/metadata.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.893379                                        #
+# Generated on 2024-10-21T17:14:28.491273                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata/util.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.929549                                        #
+# Generated on 2024-10-21T17:14:28.528150                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_config.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.839767                                        #
+# Generated on 2024-10-21T17:14:28.439248                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_current.pyi

@@ -1,21 +1,21 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.942071                                        #
+# Generated on 2024-10-21T17:14:28.545404                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
-    import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
-    import metaflow.plugins.cards.component_serializer
-    import metaflow.metaflow_current
-    import metaflow
+    import metaflow.events
     import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
     import typing
-    import metaflow.events
+    import metaflow.metaflow_current
+    import metaflow
+    import metaflow.plugins.cards.component_serializer
+    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,97 +227,31 @@ class Current(object, metaclass=type):
     def graph(_):
         ...
     @property
-    def huggingface_hub(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
+    def parallel(self) -> "metaflow.metaflow_current.Parallel":
         """
-        (only in the presence of the @huggingface_hub decorator)
-        
-        The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
-        over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
-        [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
-        The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
-        `<repo_type>/<repo_id>` name. The `repo_type` is by default `model` and can be overriden by passing the `repo_type` parameter to the `snapshot_download` function.
-        
+        (only in the presence of the @parallel decorator)
         
-        Usage:
-        ------
-        ```python
-            @huggingface_hub
-            @step
-            def pull_model_from_huggingface(self):
-                # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
-                # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
-                # with the same `repo_id` in the backend storage, it will not download the model again. The return
-                # value of the function is a reference to the model in the backend storage.
-                # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
         
-                self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
-                self.llama_model = current.huggingface_hub.snapshot_download(
-                    repo_id=self.model_id,
-                    allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
-                )
-                self.next(self.train)
-        ```
+        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 model(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
+    def is_parallel(self) -> bool:
         """
-        (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
-        -------
-        ModelSerializer
-            The object used for loading / saving models.
+        True if the current step is a @parallel step.
         """
         ...
     @property
@@ -382,31 +316,97 @@ class Current(object, metaclass=type):
         """
         ...
     @property
-    def parallel(self) -> "metaflow.metaflow_current.Parallel":
+    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)
+        
+        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
         -------
-        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.
+        ModelSerializer
+            The object used for loading / saving models.
         """
         ...
     @property
-    def is_parallel(self) -> bool:
+    def huggingface_hub(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
         """
-        (only in the presence of the @parallel decorator)
+        (only in the presence of the @huggingface_hub decorator)
         
-        True if the current step is a @parallel step.
+        The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
+        over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
+        [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
+        The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
+        `<repo_type>/<repo_id>` name. The `repo_type` is by default `model` and can be overriden by passing the `repo_type` parameter to the `snapshot_download` function.
+        
+        
+        Usage:
+        ------
+        ```python
+            @huggingface_hub
+            @step
+            def pull_model_from_huggingface(self):
+                # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
+                # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
+                # with the same `repo_id` in the backend storage, it will not download the model again. The return
+                # value of the function is a reference to the model in the backend storage.
+                # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
+        
+                self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
+                self.llama_model = current.huggingface_hub.snapshot_download(
+                    repo_id=self.model_id,
+                    allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
+                )
+                self.next(self.train)
+        ```
         """
         ...
     @property
@@ -428,19 +428,6 @@ class Current(object, metaclass=type):
         """
         ...
     @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
     def project_name(self) -> str:
         """
         (only in the presence of the @project decorator)
@@ -507,6 +494,19 @@ 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.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.893692                                        #
+# Generated on 2024-10-21T17:14:28.491593                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/multicore_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.840173                                        #
+# Generated on 2024-10-21T17:14:28.439665                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/parameters.pyi

@@ -1,17 +1,17 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.841524                                        #
+# Generated on 2024-10-21T17:14:28.440849                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.parameters
     import typing
-    import metaflow.exception
     import metaflow._vendor.click.types
+    import metaflow.exception
+    import metaflow.parameters
 
 class ParameterFieldFailed(metaflow.exception.MetaflowException, metaclass=type):
     def __init__(self, name, field):

metaflow-stubs/plugins/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.858448                                        #
+# Generated on 2024-10-21T17:14:28.457818                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.887762                                        #
+# Generated on 2024-10-21T17:14:28.485048                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/airflow_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.926945                                        #
+# Generated on 2024-10-21T17:14:28.525350                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/exception.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.925995                                        #
+# Generated on 2024-10-21T17:14:28.524395                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.927287                                        #
+# Generated on 2024-10-21T17:14:28.525639                                        #
 ##################################################################################
 
 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.25.2+obcheckpoint(0.1.0);ob(v1)                               #
-# Generated on 2024-10-16T01:27:45.940016                                        #
+# Generated on 2024-10-21T17:14:28.542649                                        #
 ##################################################################################
 
 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):