ob-metaflow-stubs 6.0.3.103rc3__py2.py3-none-any.whl → 6.0.3.104__py2.py3-none-any.whl

metaflow-stubs/cards.pyi

@@ -1,19 +1,19 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.546102                                        #
+# Generated on 2024-09-20T21:46:07.339893                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.plugins.cards.card_modules.components
     import metaflow.plugins.cards.card_modules.basic
     import metaflow
-    import typing
-    import metaflow.plugins.cards.card_modules.components
-    import metaflow.plugins.cards.card_modules.card
     import metaflow.plugins.cards.card_client
+    import metaflow.plugins.cards.card_modules.card
+    import typing
 
 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.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.562759                                        #
+# Generated on 2024-09-20T21:46:07.356313                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.metaflow_current
     import metaflow.exception
+    import metaflow.metaflow_current
 
 def namespace(ns: typing.Optional[str]) -> typing.Optional[str]:
     """

metaflow-stubs/client/__init__.pyi

@@ -1,17 +1,17 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.553361                                        #
+# Generated on 2024-09-20T21:46:07.347487                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.events
     import typing
-    import datetime
     import metaflow.client.core
+    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.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.542179                                        #
+# Generated on 2024-09-20T21:46:07.336460                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.client.core
+    import metaflow.events
+    import metaflow.metaflow_current
+    import datetime
     import metaflow
     import tarfile
     import typing
     import metaflow.exception
-    import datetime
-    import metaflow.events
-    import metaflow.metaflow_current
-    import metaflow.client.core
 
 current: metaflow.metaflow_current.Current
 

metaflow-stubs/client/filecache.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.563647                                        #
+# Generated on 2024-09-20T21:46:07.357160                                        #
 ##################################################################################
 
 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.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.561647                                        #
+# Generated on 2024-09-20T21:46:07.355144                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/events.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.544134                                        #
+# Generated on 2024-09-20T21:46:07.340483                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/exception.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.534351                                        #
+# Generated on 2024-09-20T21:46:07.328884                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/flowspec.pyi

@@ -1,19 +1,19 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.543540                                        #
+# Generated on 2024-09-20T21:46:07.337832                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.flowspec
     import metaflow.parameters
+    import metaflow.unbounded_foreach
+    import metaflow.datastore.inputs
+    import metaflow.flowspec
     import typing
     import metaflow.exception
-    import metaflow.datastore.inputs
-    import metaflow.unbounded_foreach
 
 class DelayedEvaluationParameter(object, metaclass=type):
     def __init__(self, name, field, fun):

metaflow-stubs/generated_for.txt

@@ -1 +1 @@
-2.12.22.1+obcheckpoint(0.0.11);ob(v1) 2024-09-20T21:42:44.518895
+2.12.22.1+obcheckpoint(0.0.11);ob(v1) 2024-09-20T21:46:07.313848

metaflow-stubs/includefile.pyi

@@ -1,17 +1,17 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.549056                                        #
+# Generated on 2024-09-20T21:46:07.343342                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.parameters
-    import typing
     import metaflow._vendor.click.types
+    import metaflow.parameters
     import io
+    import typing
     import metaflow.plugins.datatools.s3.s3
 
 class MetaflowException(Exception, metaclass=type):

metaflow-stubs/info_file.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.533552                                        #
+# Generated on 2024-09-20T21:46:07.328193                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata/metadata.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.586663                                        #
+# Generated on 2024-09-20T21:46:07.379898                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.metadata.metadata
     import metaflow.exception
+    import metaflow.metadata.metadata
 
 class MetaflowInternalError(metaflow.exception.MetaflowException, metaclass=type):
     ...

metaflow-stubs/metadata/util.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.629510                                        #
+# Generated on 2024-09-20T21:46:07.421987                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_config.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.535475                                        #
+# Generated on 2024-09-20T21:46:07.329970                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_current.pyi

@@ -1,20 +1,20 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.632097                                        #
+# Generated on 2024-09-20T21:46:07.424519                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
-    import metaflow
-    import typing
     import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
-    import metaflow.plugins.cards.component_serializer
     import metaflow.events
     import metaflow.metaflow_current
+    import metaflow
+    import metaflow.plugins.cards.component_serializer
+    import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
+    import typing
 
 TYPE_CHECKING: bool
 
@@ -223,31 +223,82 @@ class Current(object, metaclass=type):
     def graph(_):
         ...
     @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 card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
         """
-        (only in the presence of the @parallel decorator)
+        (only in the presence of the @card decorator)
         
-        True if the current step is a @parallel step.
+        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
@@ -312,82 +363,31 @@ class Current(object, metaclass=type):
         """
         ...
     @property
-    def model(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
+    def parallel(self) -> "metaflow.metaflow_current.Parallel":
         """
-        (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.
+        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 card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
+    def is_parallel(self) -> bool:
         """
-        (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`
+        (only in the presence of the @parallel decorator)
         
-        Returns
-        -------
-        CardComponentCollector
-            The or one of the cards attached to this step.
+        True if the current step is a @parallel step.
         """
         ...
     @property

metaflow-stubs/mflog/mflog.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.586973                                        #
+# Generated on 2024-09-20T21:46:07.380198                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/multicore_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.535890                                        #
+# Generated on 2024-09-20T21:46:07.330476                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/parameters.pyi

@@ -1,17 +1,17 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.537065                                        #
+# Generated on 2024-09-20T21:46:07.331622                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow._vendor.click.types
+    import typing
     import metaflow.exception
+    import metaflow._vendor.click.types
     import metaflow.parameters
-    import typing
 
 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.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.550855                                        #
+# Generated on 2024-09-20T21:46:07.345014                                        #
 ##################################################################################
 
 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.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.580547                                        #
+# Generated on 2024-09-20T21:46:07.373842                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/airflow_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.619334                                        #
+# Generated on 2024-09-20T21:46:07.412087                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/airflow/exception.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.618374                                        #
+# Generated on 2024-09-20T21:46:07.411119                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.619582                                        #
+# Generated on 2024-09-20T21:46:07.412352                                        #
 ##################################################################################
 
 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.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.630007                                        #
+# Generated on 2024-09-20T21:46:07.422492                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.exception
     import metaflow.decorators
+    import metaflow.exception
 
 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.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.630419                                        #
+# Generated on 2024-09-20T21:46:07.422869                                        #
 ##################################################################################
 
 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.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.630768                                        #
+# Generated on 2024-09-20T21:46:07.423219                                        #
 ##################################################################################
 
 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/argo/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.576652                                        #
+# Generated on 2024-09-20T21:46:07.371939                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/argo/argo_client.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
 # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:42:44.592136                                        #
+# Generated on 2024-09-20T21:46:07.396477                                        #
 ##################################################################################
 
 from __future__ import annotations