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

metaflow-stubs/plugins/aws/batch/batch_decorator.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:46:07.421354                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.981250                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -15,12 +15,46 @@ if typing.TYPE_CHECKING:
 current: metaflow.metaflow_current.Current
 
 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):
     ...
 
 class MetaDatum(tuple, metaclass=type):
+    """
+    MetaDatum(field, value, type, tags)
+    """
     @staticmethod
     def __new__(_cls, field, value, type, tags):
         """
@@ -127,6 +161,72 @@ def get_ec2_instance_metadata():
     ...
 
 class BatchDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Specifies that this step should execute on [AWS Batch](https://aws.amazon.com/batch/).
+    
+    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.
+    gpu : int, default 0
+        Number of GPUs 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.
+    image : str, optional, default None
+        Docker image to use when launching on AWS Batch. If not specified, and
+        METAFLOW_BATCH_CONTAINER_IMAGE is specified, that image is used. If
+        not, a default Docker image mapping to the current version of Python is used.
+    queue : str, default METAFLOW_BATCH_JOB_QUEUE
+        AWS Batch Job Queue to submit the job to.
+    iam_role : str, default METAFLOW_ECS_S3_ACCESS_IAM_ROLE
+        AWS IAM role that AWS Batch container uses to access AWS cloud resources.
+    execution_role : str, default METAFLOW_ECS_FARGATE_EXECUTION_ROLE
+        AWS IAM role that AWS Batch can use [to trigger AWS Fargate tasks]
+        (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html).
+    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.
+    max_swap : int, optional, default None
+        The total amount of swap memory (in MiB) a container can use for this
+        step. This parameter is translated to the `--memory-swap` option in
+        Docker where the value is the sum of the container memory plus the
+        `max_swap` value.
+    swappiness : int, optional, default None
+        This allows you to tune memory swappiness behavior for this step.
+        A swappiness value of 0 causes swapping not to happen unless absolutely
+        necessary. A swappiness value of 100 causes pages to be swapped very
+        aggressively. Accepted values are whole numbers between 0 and 100.
+    use_tmpfs : bool, default False
+        This enables an explicit tmpfs mount for this step. Note that tmpfs is
+        not available on Fargate compute environments
+    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 None
+        Path to tmpfs mount for this step. Defaults to /metaflow_temp.
+    inferentia : int, default 0
+        Number of Inferentia chips required for this step.
+    trainium : int, default None
+        Alias for inferentia. Use only one of the two.
+    efa : int, default 0
+        Number of elastic fabric adapter network devices to attach to container
+    ephemeral_storage : int, default None
+        The total amount, in GiB, of ephemeral storage to set for the task, 21-200GiB.
+        This is only relevant for Fargate compute environments
+    log_driver: str, optional, default None
+        The log driver to use for the Amazon ECS container.
+    log_options: List[str], optional, default None
+        List of strings containing options for the chosen log driver. The configurable values
+        depend on the `log driver` chosen. Validation of these options is not supported yet.
+        Example: [`awslogs-group:aws/batch/job`]
+    """
     def __init__(self, attributes = None, statically_defined = False):
         ...
     def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):

metaflow-stubs/plugins/aws/secrets_manager/__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:46:07.405765                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.965688                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.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:46:07.421751                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.981678                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.plugins.secrets
-    import abc
     import metaflow.exception
+    import abc
 
 class MetaflowException(Exception, metaclass=type):
     def __init__(self, msg = "", lineno = None):
@@ -31,15 +31,27 @@ class SecretsProvider(abc.ABC, metaclass=abc.ABCMeta):
     ...
 
 class MetaflowAWSSecretsManagerBadResponse(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the response from AWS Secrets Manager is not valid in some way
+    """
     ...
 
 class MetaflowAWSSecretsManagerDuplicateKey(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the response from AWS Secrets Manager contains duplicate keys
+    """
     ...
 
 class MetaflowAWSSecretsManagerJSONParseError(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the SecretString response from AWS Secrets Manager is not valid JSON
+    """
     ...
 
 class MetaflowAWSSecretsManagerNotJSONObject(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the SecretString response from AWS Secrets Manager is not valid JSON object (dictionary)
+    """
     ...
 
 class AwsSecretsManagerSecretsProvider(metaflow.plugins.secrets.SecretsProvider, metaclass=abc.ABCMeta):

metaflow-stubs/plugins/aws/step_functions/__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:46:07.405344                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.965247                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/event_bridge_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:46:07.415022                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.974770                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/production_token.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:46:07.414593                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.973935                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/schedule_decorator.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:46:07.414761                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.974482                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -11,6 +11,25 @@ if typing.TYPE_CHECKING:
     import metaflow.decorators
 
 class ScheduleDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    """
+    Specifies the times when the flow should be run when running on a
+    production scheduler.
+    
+    Parameters
+    ----------
+    hourly : bool, default False
+        Run the workflow hourly.
+    daily : bool, default True
+        Run the workflow daily.
+    weekly : bool, default False
+        Run the workflow weekly.
+    cron : str, optional, default None
+        Run the workflow at [a custom Cron schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions)
+        specified by this expression.
+    timezone : str, optional, default None
+        Timezone on which the schedule runs (default: None). Currently supported only for Argo workflows,
+        which accepts timezones in [IANA format](https://nodatime.org/TimeZones).
+    """
     def flow_init(self, flow, graph, environment, flow_datastore, metadata, logger, echo, options):
         ...
     ...

metaflow-stubs/plugins/aws/step_functions/step_functions.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:46:07.417310                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.977062                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/step_functions_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:46:07.415338                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.975069                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.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:46:07.418498                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.978302                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,7 +9,6 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.runner.deployer
-    import metaflow.runner.subprocess_manager
 
 class StepFunctions(object, metaclass=type):
     def __init__(self, name, graph, flow, code_package_sha, code_package_url, production_token, metadata, flow_datastore, environment, event_logger, monitor, tags = None, namespace = None, username = None, max_workers = None, workflow_timeout = None, is_project = False, use_distributed_map = False):
@@ -43,6 +42,30 @@ class StepFunctions(object, metaclass=type):
     ...
 
 class DeployerImpl(object, metaclass=type):
+    """
+    Base class for deployer implementations. Each implementation should define a TYPE
+    class variable that matches the name of the CLI group.
+    
+    Parameters
+    ----------
+    flow_file : str
+        Path to the flow file to deploy.
+    show_output : bool, default True
+        Show the 'stdout' and 'stderr' to the console by default.
+    profile : Optional[str], default None
+        Metaflow profile to use for the deployment. If not specified, the default
+        profile is used.
+    env : Optional[Dict], default None
+        Additional environment variables to set for the deployment.
+    cwd : Optional[str], default None
+        The directory to run the subprocess in; if not specified, the current
+        directory is used.
+    file_read_timeout : int, default 3600
+        The timeout until which we try to read the deployer attribute file.
+    **kwargs : Any
+        Additional arguments that you would pass to `python myflow.py` before
+        the deployment command.
+    """
     def __init__(self, flow_file: str, show_output: bool = True, profile: typing.Optional[str] = None, env: typing.Optional[typing.Dict] = None, cwd: typing.Optional[str] = None, file_read_timeout: int = 3600, **kwargs):
         ...
     def __enter__(self) -> metaflow.runner.deployer.DeployerImpl:
@@ -81,11 +104,25 @@ class DeployerImpl(object, metaclass=type):
     ...
 
 class DeployedFlow(object, metaclass=type):
+    """
+    DeployedFlow class represents a flow that has been deployed.
+    
+    Parameters
+    ----------
+    deployer : DeployerImpl
+        Instance of the deployer implementation.
+    """
     def __init__(self, deployer: metaflow.runner.deployer.DeployerImpl):
         ...
     ...
 
 class TriggeredRun(object, metaclass=type):
+    """
+    TriggeredRun class represents a run that has been triggered on a production orchestrator.
+    
+    Only when the `start` task starts running, the `run` object corresponding to the run
+    becomes available.
+    """
     def __init__(self, deployer: metaflow.runner.deployer.DeployerImpl, content: str):
         ...
     def wait_for_run(self, timeout = None):
@@ -146,7 +183,7 @@ def get_lower_level_group(api, top_level_kwargs: typing.Dict, _type: typing.Opti
     """
     ...
 
-def handle_timeout(tfp_runner_attribute, command_obj: metaflow.runner.subprocess_manager.CommandManager, file_read_timeout: int):
+def handle_timeout(tfp_runner_attribute, command_obj: "CommandManager", file_read_timeout: int):
     """
     Handle the timeout for a running subprocess command that reads a file
     and raises an error with appropriate logs if a TimeoutError occurs.
@@ -261,6 +298,14 @@ def trigger(instance: metaflow.runner.deployer.DeployedFlow, **kwargs):
     ...
 
 class StepFunctionsDeployer(metaflow.runner.deployer.DeployerImpl, metaclass=type):
+    """
+    Deployer implementation for AWS Step Functions.
+    
+    Attributes
+    ----------
+    TYPE : ClassVar[Optional[str]]
+        The type of the deployer, which is "step-functions".
+    """
     def __init__(self, deployer_kwargs, **kwargs):
         """
         Initialize the StepFunctionsDeployer.

metaflow-stubs/plugins/azure/__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:46:07.374608                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.933175                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/azure/azure_credential.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:46:07.412562                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.972226                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/azure/azure_exceptions.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:46:07.412772                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.972438                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.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:46:07.413912                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.973618                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.plugins.secrets
-    import abc
     import metaflow.exception
+    import abc
 
 class SecretsProvider(abc.ABC, metaclass=abc.ABCMeta):
     def get_secret_as_dict(self, secret_id, options = {}, role = None) -> typing.Dict[str, str]:
@@ -34,21 +34,39 @@ def create_cacheable_azure_credential():
     ...
 
 class MetaflowAzureKeyVaultBadVault(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the secretid is fully qualified but does not have the right key vault domain
+    """
     ...
 
 class MetaflowAzureKeyVaultBadSecretType(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the secret type is anything except secrets
+    """
     ...
 
 class MetaflowAzureKeyVaultBadSecretPath(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the secret path does not match to expected length
+    """
     ...
 
 class MetaflowAzureKeyVaultBadSecretName(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the secret name does not match expected pattern
+    """
     ...
 
 class MetaflowAzureKeyVaultBadSecretVersion(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the secret version does not match expected pattern
+    """
     ...
 
 class MetaflowAzureKeyVaultBadSecret(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    Raised when the secret does not match supported patterns in Metaflow
+    """
     ...
 
 class AzureKeyVaultSecretsProvider(metaflow.plugins.secrets.SecretsProvider, metaclass=abc.ABCMeta):

metaflow-stubs/plugins/azure/azure_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:46:07.413161                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.972851                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/azure/blob_service_client_factory.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:46:07.413490                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.973166                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/azure/includefile_support.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:46:07.367969                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.926221                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/cards/__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:46:07.370904                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.929361                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/cards/card_cli.pyi

@@ -1,20 +1,69 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:46:07.391040                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.960989                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.client.core
-    import datetime
-    import typing
     import metaflow.parameters
     import metaflow.exception
+    import datetime
+    import typing
+    import metaflow.client.core
 
 class Task(metaflow.client.core.MetaflowObject, metaclass=type):
+    """
+    A `Task` represents an execution of a `Step`.
+    
+    It contains all `DataArtifact` objects produced by the task as
+    well as metadata related to execution.
+    
+    Note that the `@retry` decorator may cause multiple attempts of
+    the task to be present. Usually you want the latest attempt, which
+    is what instantiating a `Task` object returns by default. If
+    you need to e.g. retrieve logs from a failed attempt, you can
+    explicitly get information about a specific attempt by using the
+    following syntax when creating a task:
+    
+    `Task('flow/run/step/task', attempt=<attempt>)`
+    
+    where `attempt=0` corresponds to the first attempt etc.
+    
+    Attributes
+    ----------
+    metadata : List[Metadata]
+        List of all metadata events associated with the task.
+    metadata_dict : Dict[str, str]
+        A condensed version of `metadata`: A dictionary where keys
+        are names of metadata events and values the latest corresponding event.
+    data : MetaflowData
+        Container of all data artifacts produced by this task. Note that this
+        call downloads all data locally, so it can be slower than accessing
+        artifacts individually. See `MetaflowData` for more information.
+    artifacts : MetaflowArtifacts
+        Container of `DataArtifact` objects produced by this task.
+    successful : bool
+        True if the task completed successfully.
+    finished : bool
+        True if the task completed.
+    exception : object
+        Exception raised by this task if there was one.
+    finished_at : datetime
+        Time this task finished.
+    runtime_name : str
+        Runtime this task was executed on.
+    stdout : str
+        Standard output for the task execution.
+    stderr : str
+        Standard error output for the task execution.
+    code : MetaflowCode
+        Code package for this task (if present). See `MetaflowCode`.
+    environment_info : Dict[str, str]
+        Information about the execution environment.
+    """
     def __init__(self, *args, **kwargs):
         ...
     @property
@@ -409,6 +458,9 @@ class CardDatastore(object, metaclass=type):
 NUM_SHORT_HASH_CHARS: int
 
 class CardClassFoundException(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    This exception is raised with MetaflowCard class is not present for a particular card type.
+    """
     def __init__(self, card_name):
         ...
     ...
@@ -424,6 +476,9 @@ class UnrenderableCardException(metaflow.exception.MetaflowException, metaclass=
     ...
 
 class CardNotPresentException(metaflow.exception.MetaflowException, metaclass=type):
+    """
+    This exception is raised with a card is not present in the datastore.
+    """
     def __init__(self, pathspec, card_type = None, card_hash = None, card_id = None):
         ...
     ...
@@ -440,6 +495,9 @@ def resumed_info(task):
     ...
 
 class CardRenderInfo(tuple, metaclass=type):
+    """
+    CardRenderInfo(mode, is_implemented, data, timed_out, timeout_stack_trace)
+    """
     @staticmethod
     def __new__(_cls, mode, is_implemented, data, timed_out, timeout_stack_trace):
         """