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

metaflow-stubs/cards.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.038869                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.403280                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/cli.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.053197                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.417420                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -22,8 +22,6 @@ from .user_configs.config_parameters import ConfigValue as ConfigValue
 from .cli_components.utils import cli as cli
 from .cli_components.utils import start as start
 
-DECOSPECS: str
-
 DEFAULT_DATASTORE: str
 
 DEFAULT_ENVIRONMENT: str
@@ -67,9 +65,6 @@ def echo_always(line, **kwargs):
 def logger(body = '', system_msg = False, head = '', bad = False, timestamp = True, nl = True):
     ...
 
-def config_merge_cb(ctx, param, value):
-    ...
-
 def print_metaflow_exception(ex):
     ...
 

metaflow-stubs/cli_components/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.051984                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.416245                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/cli_components/utils.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.077708                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.442643                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/client/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.042115                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.406528                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/client/core.pyi

@@ -1,19 +1,20 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.046400                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.411162                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import typing
 import metaflow
+import typing
 if typing.TYPE_CHECKING:
-    import metaflow.events
-    import metaflow.client.core
-    import datetime
     import tarfile
+    import tempfile
     import typing
+    import datetime
+    import metaflow.events
+    import metaflow.client.core
 
 from ..metaflow_current import current as current
 from ..events import Trigger as Trigger
@@ -464,6 +465,50 @@ class MetaflowCode(object, metaclass=type):
             TarFile for everything in this code package
         """
         ...
+    def extract(self) -> tempfile.TemporaryDirectory:
+        """
+        Extracts the code package to a temporary directory.
+        
+        This creates a temporary directory containing all user code
+        files from the code package. The temporary directory is
+        automatically deleted when the returned TemporaryDirectory
+        object is garbage collected or when its cleanup() is called.
+        
+        To preserve the contents to a permanent location, use
+        os.replace() which performs a zero-copy move on the same
+        filesystem:
+        
+        ```python
+        with task.code.extract() as tmp_dir:
+            # Move contents to permanent location
+            for item in os.listdir(tmp_dir):
+                src = os.path.join(tmp_dir, item)
+                dst = os.path.join('/path/to/permanent/dir', item)
+                os.makedirs(os.path.dirname(dst), exist_ok=True)
+                os.replace(src, dst)  # Atomic move operation
+        ```
+        Returns
+        -------
+        TemporaryDirectory
+            A temporary directory containing the extracted code files.
+            The directory and its contents are automatically deleted when
+            this object is garbage collected.
+        """
+        ...
+    @property
+    def script_name(self) -> str:
+        """
+        Returns the filename of the Python script containing the FlowSpec.
+        
+        This is the main Python file that was used to execute the flow. For example,
+        if your flow is defined in 'myflow.py', this property will return 'myflow.py'.
+        
+        Returns
+        -------
+        str
+            Name of the Python file containing the FlowSpec
+        """
+        ...
     def __str__(self):
         ...
     ...
@@ -631,6 +676,28 @@ class Task(MetaflowObject, metaclass=type):
     def __init__(self, *args, **kwargs):
         ...
     @property
+    def parent_tasks(self) -> typing.Iterator["Task"]:
+        """
+        Yields all parent tasks of the current task if one exists.
+        
+        Yields
+        ------
+        Task
+            Parent task of the current task
+        """
+        ...
+    @property
+    def child_tasks(self) -> typing.Iterator["Task"]:
+        """
+        Yield all child tasks of the current task if one exists.
+        
+        Yields
+        ------
+        Task
+            Child task of the current task
+        """
+        ...
+    @property
     def metadata(self) -> typing.List[Metadata]:
         """
         Metadata events produced by this task across all attempts of the task
@@ -1090,6 +1157,28 @@ class Step(MetaflowObject, metaclass=type):
             Dictionary describing the environment
         """
         ...
+    @property
+    def parent_steps(self) -> typing.Iterator["Step"]:
+        """
+        Yields parent steps for the current step.
+        
+        Yields
+        ------
+        Step
+            Parent step
+        """
+        ...
+    @property
+    def child_steps(self) -> typing.Iterator["Step"]:
+        """
+        Yields child steps for the current step.
+        
+        Yields
+        ------
+        Step
+            Child step
+        """
+        ...
     ...
 
 class Run(MetaflowObject, metaclass=type):

metaflow-stubs/client/filecache.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.072816                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.437616                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/events.pyi

@@ -1,15 +1,15 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.039466                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.403865                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.events
     import metaflow
+    import metaflow.events
 
 
 TYPE_CHECKING: bool

metaflow-stubs/exception.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.031118                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.395375                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/flowspec.pyi

@@ -1,19 +1,19 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.035821                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.400133                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import typing
 import metaflow
+import typing
 if typing.TYPE_CHECKING:
-    import metaflow.exception
     import metaflow.flowspec
-    import metaflow.unbounded_foreach
     import metaflow.datastore.inputs
+    import metaflow.unbounded_foreach
     import typing
+    import metaflow.exception
 
 from . import parameters as parameters
 from .parameters import DelayedEvaluationParameter as DelayedEvaluationParameter

metaflow-stubs/generated_for.txt

@@ -1 +1 @@
-2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) 2025-02-17T19:27:36.027826
+2.14.2.1+obcheckpoint(0.1.8);ob(v1) 2025-02-21T20:43:13.391809

metaflow-stubs/includefile.pyi

@@ -1,13 +1,13 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.041828                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.406239                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import typing
 import metaflow
+import typing
 if typing.TYPE_CHECKING:
     import metaflow.parameters
     import metaflow._vendor.click.types

metaflow-stubs/info_file.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.030377                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.394603                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.034705                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.398978                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/heartbeat.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.057009                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.421874                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/metadata.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.056529                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.421380                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -368,6 +368,30 @@ class MetadataProvider(object, metaclass=MetadataProviderMeta):
         Run tags after mutation operations
         """
         ...
+    @classmethod
+    def filter_tasks_by_metadata(cls, flow_name: str, run_id: str, step_name: str, field_name: str, pattern: str) -> typing.List[str]:
+        """
+        Filter tasks by metadata field and pattern, returning task pathspecs that match criteria.
+        
+        Parameters
+        ----------
+        flow_name : str
+            Flow name, that the run belongs to.
+        run_id: str
+            Run id, together with flow_id, that identifies the specific Run whose tasks to query
+        step_name: str
+            Step name to query tasks from
+        field_name: str
+            Metadata field name to query
+        pattern: str
+            Pattern to match in metadata field value
+        
+        Returns
+        -------
+        List[str]
+            List of task pathspecs that satisfy the query
+        """
+        ...
     def __init__(self, environment, flow, event_logger, monitor):
         ...
     ...

metaflow-stubs/metadata_provider/util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.056751                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.421611                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_config.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.032215                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.396544                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -143,7 +143,7 @@ ARGO_WORKFLOWS_CAPTURE_ERROR_SCRIPT: None
 
 CONTACT_INFO: dict
 
-DECOSPECS: str
+DEFAULT_DECOSPECS: str
 
 ECS_S3_ACCESS_IAM_ROLE: None
 
@@ -249,8 +249,6 @@ CONDA_PACKAGE_GSROOT: None
 
 CONDA_DEPENDENCY_RESOLVER: str
 
-CONDA_USE_FAST_INIT: bool
-
 ESCAPE_HATCH_WARNING: bool
 
 DEBUG_OPTIONS: list

metaflow-stubs/metaflow_current.pyi

@@ -1,21 +1,21 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.180644                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.536250                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import typing
+    import metaflow.plugins.cards.component_serializer
     import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
     import metaflow
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
     import metaflow.events
     import metaflow.metaflow_current
-    import typing
     import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
-    import metaflow.plugins.cards.component_serializer
-    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
 
 
 TYPE_CHECKING: bool
@@ -228,6 +228,67 @@ class Current(object, metaclass=type):
     def graph(self):
         ...
     @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 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 huggingface_hub(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
         """
         (only in the presence of the @huggingface_hub decorator)
@@ -297,6 +358,24 @@ 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)
@@ -326,67 +405,6 @@ class Current(object, metaclass=type):
         """
         ...
     @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 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 checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
         """
         (only in the presence of the @checkpoint decorator)
@@ -448,27 +466,9 @@ 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 trigger(self) -> "metaflow.events.Trigger":
         """
-        (only in the presence of the @trigger, or @trigger_on_finish decorators)
+        (only in the presence of the @trigger_on_finish, or @trigger decorators)
         
         Returns `Trigger` if the current run is triggered by an event
         

metaflow-stubs/mf_extensions/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.040681                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.405126                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1)                                            #
-# Generated on 2025-02-17T19:27:36.049268                                                            #
+# MF version: 2.14.2.1+obcheckpoint(0.1.8);ob(v1)                                                    #
+# Generated on 2025-02-21T20:43:13.414061                                                            #
 ######################################################################################################