metaflow-stubs 2.12.21__py2.py3-none-any.whl → 2.12.23__py2.py3-none-any.whl

metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.942503                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.061757                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.secrets
-    import metaflow.exception
     import abc
+    import metaflow.exception
+    import metaflow.plugins.secrets
 
 class MetaflowException(Exception, metaclass=type):
     def __init__(self, msg = "", lineno = None):
@@ -34,15 +34,27 @@ def get_credentials(scopes, *args, **kwargs):
 GCP_SECRET_MANAGER_PREFIX: None
 
 class MetaflowGcpSecretsManagerBadResponse(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the response from GCP Secrets Manager is not valid in some way
+    """
     ...
 
 class MetaflowGcpSecretsManagerDuplicateKey(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the response from GCP Secrets Manager contains duplicate keys
+    """
     ...
 
 class MetaflowGcpSecretsManagerJSONParseError(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the SecretString response from GCP Secrets Manager is not valid JSON
+    """
     ...
 
 class MetaflowGcpSecretsManagerNotJSONObject(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the SecretString response from GCP Secrets Manager is not valid JSON dictionary
+    """
     ...
 
 class GcpSecretManagerSecretsProvider(metaflow.plugins.secrets.SecretsProvider, metaclass=abc.ABCMeta):

metaflow-stubs/plugins/gcp/gs_exceptions.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.941630                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.060845                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.941412                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.060634                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/gcp/gs_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.941975                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.061224                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/gcp/includefile_support.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.866341                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:39.990780                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/kubernetes/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.873926                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:39.994613                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/kubernetes/kube_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.937758                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.027960                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/kubernetes/kubernetes.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.936378                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.026286                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.exception
     import metaflow.metaflow_current
+    import metaflow.exception
 
 current: metaflow.metaflow_current.Current
 

metaflow-stubs/plugins/kubernetes/kubernetes_cli.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.939138                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.029412                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
-    import metaflow.decorators
     import metaflow._vendor.click.types
+    import metaflow.decorators
 
 def parse_cli_options(flow_name, run_id, user, my_runs, echo):
     ...
@@ -86,6 +86,69 @@ def parse_kube_keyvalue_list(items: typing.List[str], requires_both: bool = True
     ...
 
 class KubernetesDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Specifies that this step should execute on Kubernetes.
+    
+    Parameters
+    ----------
+    cpu : int, default 1
+        Number of CPUs required for this step. If `@resources` is
+        also present, the maximum value from all decorators is used.
+    memory : int, default 4096
+        Memory size (in MB) required for this step. If
+        `@resources` is also present, the maximum value from all decorators is
+        used.
+    disk : int, default 10240
+        Disk size (in MB) required for this step. If
+        `@resources` is also present, the maximum value from all decorators is
+        used.
+    image : str, optional, default None
+        Docker image to use when launching on Kubernetes. If not specified, and
+        METAFLOW_KUBERNETES_CONTAINER_IMAGE is specified, that image is used. If
+        not, a default Docker image mapping to the current version of Python is used.
+    image_pull_policy: str, default KUBERNETES_IMAGE_PULL_POLICY
+        If given, the imagePullPolicy to be applied to the Docker image of the step.
+    service_account : str, default METAFLOW_KUBERNETES_SERVICE_ACCOUNT
+        Kubernetes service account to use when launching pod in Kubernetes.
+    secrets : List[str], optional, default None
+        Kubernetes secrets to use when launching pod in Kubernetes. These
+        secrets are in addition to the ones defined in `METAFLOW_KUBERNETES_SECRETS`
+        in Metaflow configuration.
+    node_selector: Union[Dict[str,str], str], optional, default None
+        Kubernetes node selector(s) to apply to the pod running the task.
+        Can be passed in as a comma separated string of values e.g. "kubernetes.io/os=linux,kubernetes.io/arch=amd64"
+        or as a dictionary {"kubernetes.io/os": "linux", "kubernetes.io/arch": "amd64"}
+    namespace : str, default METAFLOW_KUBERNETES_NAMESPACE
+        Kubernetes namespace to use when launching pod in Kubernetes.
+    gpu : int, optional, default None
+        Number of GPUs required for this step. A value of zero implies that
+        the scheduled node should not have GPUs.
+    gpu_vendor : str, default KUBERNETES_GPU_VENDOR
+        The vendor of the GPUs to be used for this step.
+    tolerations : List[str], default []
+        The default is extracted from METAFLOW_KUBERNETES_TOLERATIONS.
+        Kubernetes tolerations to use when launching pod in Kubernetes.
+    use_tmpfs : bool, default False
+        This enables an explicit tmpfs mount for this step.
+    tmpfs_tempdir : bool, default True
+        sets METAFLOW_TEMPDIR to tmpfs_path if set for this step.
+    tmpfs_size : int, optional, default: None
+        The value for the size (in MiB) of the tmpfs mount for this step.
+        This parameter maps to the `--tmpfs` option in Docker. Defaults to 50% of the
+        memory allocated for this step.
+    tmpfs_path : str, optional, default /metaflow_temp
+        Path to tmpfs mount for this step.
+    persistent_volume_claims : Dict[str, str], optional, default None
+        A map (dictionary) of persistent volumes to be mounted to the pod for this step. The map is from persistent
+        volumes to the path to which the volume is to be mounted, e.g., `{'pvc-name': '/path/to/mount/on'}`.
+    shared_memory: int, optional
+        Shared memory size (in MiB) required for this step
+    port: int, optional
+        Port number to specify in the Kubernetes job object
+    compute_pool : str, optional, default None
+        Compute pool to be used for for this step.
+        If not specified, any accessible compute pool within the perimeter is used.
+    """
     def __init__(self, attributes = None, statically_defined = False):
         ...
     def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):

metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.934983                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.024858                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.937538                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.027734                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.metaflow_current
     import metaflow.exception
     import metaflow.decorators
-    import metaflow.metaflow_current
 
 current: metaflow.metaflow_current.Current
 
@@ -22,6 +22,9 @@ class MetaflowException(Exception, metaclass=type):
     ...
 
 class MetaDatum(tuple, metaclass=type):
+    """
+    MetaDatum(field, value, type, tags)
+    """
     @staticmethod
     def __new__(_cls, field, value, type, tags):
         """
@@ -76,6 +79,37 @@ KUBERNETES_SHARED_MEMORY: None
 KUBERNETES_TOLERATIONS: str
 
 class ResourcesDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Specifies the resources needed when executing this step.
+    
+    Use `@resources` to specify the resource requirements
+    independently of the specific compute layer (`@batch`, `@kubernetes`).
+    
+    You can choose the compute layer on the command line by executing e.g.
+    ```
+    python myflow.py run --with batch
+    ```
+    or
+    ```
+    python myflow.py run --with kubernetes
+    ```
+    which executes the flow on the desired system using the
+    requirements specified in `@resources`.
+    
+    Parameters
+    ----------
+    cpu : int, default 1
+        Number of CPUs required for this step.
+    gpu : int, default 0
+        Number of GPUs required for this step.
+    disk : int, optional, default None
+        Disk size (in MB) required for this step. Only applies on Kubernetes.
+    memory : int, default 4096
+        Memory size (in MB) required for this step.
+    shared_memory : int, optional, default None
+        The value for the size (in MiB) of the /dev/shm volume for this step.
+        This parameter maps to the `--shm-size` option in Docker.
+    """
     ...
 
 def get_run_time_limit_for_task(step_decos):
@@ -147,6 +181,69 @@ def parse_kube_keyvalue_list(items: typing.List[str], requires_both: bool = True
     ...
 
 class KubernetesDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Specifies that this step should execute on Kubernetes.
+    
+    Parameters
+    ----------
+    cpu : int, default 1
+        Number of CPUs required for this step. If `@resources` is
+        also present, the maximum value from all decorators is used.
+    memory : int, default 4096
+        Memory size (in MB) required for this step. If
+        `@resources` is also present, the maximum value from all decorators is
+        used.
+    disk : int, default 10240
+        Disk size (in MB) required for this step. If
+        `@resources` is also present, the maximum value from all decorators is
+        used.
+    image : str, optional, default None
+        Docker image to use when launching on Kubernetes. If not specified, and
+        METAFLOW_KUBERNETES_CONTAINER_IMAGE is specified, that image is used. If
+        not, a default Docker image mapping to the current version of Python is used.
+    image_pull_policy: str, default KUBERNETES_IMAGE_PULL_POLICY
+        If given, the imagePullPolicy to be applied to the Docker image of the step.
+    service_account : str, default METAFLOW_KUBERNETES_SERVICE_ACCOUNT
+        Kubernetes service account to use when launching pod in Kubernetes.
+    secrets : List[str], optional, default None
+        Kubernetes secrets to use when launching pod in Kubernetes. These
+        secrets are in addition to the ones defined in `METAFLOW_KUBERNETES_SECRETS`
+        in Metaflow configuration.
+    node_selector: Union[Dict[str,str], str], optional, default None
+        Kubernetes node selector(s) to apply to the pod running the task.
+        Can be passed in as a comma separated string of values e.g. "kubernetes.io/os=linux,kubernetes.io/arch=amd64"
+        or as a dictionary {"kubernetes.io/os": "linux", "kubernetes.io/arch": "amd64"}
+    namespace : str, default METAFLOW_KUBERNETES_NAMESPACE
+        Kubernetes namespace to use when launching pod in Kubernetes.
+    gpu : int, optional, default None
+        Number of GPUs required for this step. A value of zero implies that
+        the scheduled node should not have GPUs.
+    gpu_vendor : str, default KUBERNETES_GPU_VENDOR
+        The vendor of the GPUs to be used for this step.
+    tolerations : List[str], default []
+        The default is extracted from METAFLOW_KUBERNETES_TOLERATIONS.
+        Kubernetes tolerations to use when launching pod in Kubernetes.
+    use_tmpfs : bool, default False
+        This enables an explicit tmpfs mount for this step.
+    tmpfs_tempdir : bool, default True
+        sets METAFLOW_TEMPDIR to tmpfs_path if set for this step.
+    tmpfs_size : int, optional, default: None
+        The value for the size (in MiB) of the tmpfs mount for this step.
+        This parameter maps to the `--tmpfs` option in Docker. Defaults to 50% of the
+        memory allocated for this step.
+    tmpfs_path : str, optional, default /metaflow_temp
+        Path to tmpfs mount for this step.
+    persistent_volume_claims : Dict[str, str], optional, default None
+        A map (dictionary) of persistent volumes to be mounted to the pod for this step. The map is from persistent
+        volumes to the path to which the volume is to be mounted, e.g., `{'pvc-name': '/path/to/mount/on'}`.
+    shared_memory: int, optional
+        Shared memory size (in MiB) required for this step
+    port: int, optional
+        Port number to specify in the Kubernetes job object
+    compute_pool : str, optional, default None
+        Compute pool to be used for for this step.
+        If not specified, any accessible compute pool within the perimeter is used.
+    """
     def __init__(self, attributes = None, statically_defined = False):
         ...
     def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):

metaflow-stubs/plugins/kubernetes/kubernetes_job.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.933853                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.023876                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.932647                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.022691                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -30,6 +30,9 @@ def k8s_retry(deadline_seconds = 60, max_backoff = 32):
     ...
 
 class JobsetStatus(tuple, metaclass=type):
+    """
+    JobsetStatus(control_pod_failed, control_exit_code, control_pod_status, control_started, control_completed, worker_pods_failed, workers_are_suspended, workers_have_started, all_jobs_are_suspended, jobset_finished, jobset_failed, status_unknown, jobset_was_terminated, some_jobs_are_running)
+    """
     @staticmethod
     def __new__(_cls, control_pod_failed, control_exit_code, control_pod_status, control_started, control_completed, worker_pods_failed, workers_are_suspended, workers_have_started, all_jobs_are_suspended, jobset_finished, jobset_failed, status_unknown, jobset_was_terminated, some_jobs_are_running):
         """

metaflow-stubs/plugins/logs_cli.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.880324                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.005484                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/package_cli.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.880526                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.005673                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/parallel_decorator.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.870521                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:39.995599                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.decorators
     import metaflow.metaflow_current
+    import metaflow.decorators
 
 UBF_CONTROL: str
 
@@ -23,6 +23,9 @@ class MetaflowException(Exception, metaclass=type):
     ...
 
 class MetaDatum(tuple, metaclass=type):
+    """
+    MetaDatum(field, value, type, tags)
+    """
     @staticmethod
     def __new__(_cls, field, value, type, tags):
         """
@@ -44,6 +47,9 @@ class MetaDatum(tuple, metaclass=type):
 current: metaflow.metaflow_current.Current
 
 class Parallel(tuple, metaclass=type):
+    """
+    Parallel(main_ip, num_nodes, node_index, control_task_id)
+    """
     @staticmethod
     def __new__(_cls, main_ip, num_nodes, node_index, control_task_id):
         """
@@ -63,6 +69,27 @@ class Parallel(tuple, metaclass=type):
     ...
 
 class ParallelDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    MF Add To Current
+    -----------------
+    parallel -> metaflow.metaflow_current.Parallel
+    
+        @@ 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.
+    
+    is_parallel -> bool
+        True if the current step is a @parallel step.
+    """
     def __init__(self, attributes = None, statically_defined = False):
         ...
     def runtime_step_cli(self, cli_args, retry_count, max_user_code_retries, ubf_context):

metaflow-stubs/plugins/project_decorator.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.874725                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:39.998007                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.decorators
     import metaflow.metaflow_current
+    import metaflow.decorators
 
 class MetaflowException(Exception, metaclass=type):
     def __init__(self, msg = "", lineno = None):
@@ -25,6 +25,63 @@ VALID_NAME_RE: str
 VALID_NAME_LEN: int
 
 class ProjectDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    """
+    Specifies what flows belong to the same project.
+    
+    A project-specific namespace is created for all flows that
+    use the same `@project(name)`.
+    
+    Parameters
+    ----------
+    name : str
+        Project name. Make sure that the name is unique amongst all
+        projects that use the same production scheduler. The name may
+        contain only lowercase alphanumeric characters and underscores.
+    
+    MF Add To Current
+    -----------------
+    project_name -> str
+        The name of the project assigned to this flow, i.e. `X` in `@project(name=X)`.
+    
+        @@ Returns
+        -------
+        str
+            Project name.
+    
+    project_flow_name -> str
+        The flow name prefixed with the current project and branch. This name identifies
+        the deployment on a production scheduler.
+    
+        @@ Returns
+        -------
+        str
+            Flow name prefixed with project information.
+    
+    branch_name -> str
+        The current branch, i.e. `X` in `--branch=X` set during deployment or run.
+    
+        @@ Returns
+        -------
+        str
+            Branch name.
+    
+    is_user_branch -> bool
+        True if the flow is deployed without a specific `--branch` or a `--production`
+        flag.
+    
+        @@ Returns
+        -------
+        bool
+            True if the deployment does not correspond to a specific branch.
+    
+    is_production -> bool
+        True if the flow is deployed with the `--production` flag
+    
+        @@ Returns
+        -------
+        bool
+            True if the flow is deployed with `--production`.
+    """
     def flow_init(self, flow, graph, environment, flow_datastore, metadata, logger, echo, options):
         ...
     def get_top_level_options(self):

metaflow-stubs/plugins/pypi/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.873684                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:39.994290                                        #
 ##################################################################################
 
 from __future__ import annotations