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

metaflow-stubs/plugins/airflow/airflow_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.924272                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.046178                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -11,6 +11,9 @@ if typing.TYPE_CHECKING:
     import metaflow.decorators
 
 class MetaDatum(tuple, metaclass=type):
+    """
+    MetaDatum(field, value, type, tags)
+    """
     @staticmethod
     def __new__(_cls, field, value, type, tags):
         """

metaflow-stubs/plugins/airflow/airflow_utils.pyi

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

metaflow-stubs/plugins/airflow/exception.pyi

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

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.925488                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.046803                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -11,6 +11,45 @@ if typing.TYPE_CHECKING:
     import metaflow.plugins.airflow.sensors.base_sensor
 
 class ExternalTaskSensorDecorator(metaflow.plugins.airflow.sensors.base_sensor.AirflowSensorDecorator, metaclass=type):
+    """
+    The `@airflow_external_task_sensor` decorator attaches a Airflow [ExternalTaskSensor](https://airflow.apache.org/docs/apache-airflow/stable/_api/airflow/sensors/external_task/index.html#airflow.sensors.external_task.ExternalTaskSensor) before the start step of the flow.
+    This decorator only works when a flow is scheduled on Airflow and is compiled using `airflow create`. More than one `@airflow_external_task_sensor` can be added as a flow decorators. Adding more than one decorator will ensure that `start` step starts only after all sensors finish.
+    
+    Parameters
+    ----------
+    timeout : int
+        Time, in seconds before the task times out and fails. (Default: 3600)
+    poke_interval : int
+        Time in seconds that the job should wait in between each try. (Default: 60)
+    mode : str
+        How the sensor operates. Options are: { poke | reschedule }. (Default: "poke")
+    exponential_backoff : bool
+        allow progressive longer waits between pokes by using exponential backoff algorithm. (Default: True)
+    pool : str
+        the slot pool this task should run in,
+        slot pools are a way to limit concurrency for certain tasks. (Default:None)
+    soft_fail : bool
+        Set to true to mark the task as SKIPPED on failure. (Default: False)
+    name : str
+        Name of the sensor on Airflow
+    description : str
+        Description of sensor in the Airflow UI
+    external_dag_id : str
+        The dag_id that contains the task you want to wait for.
+    external_task_ids : List[str]
+        The list of task_ids that you want to wait for.
+        If None (default value) the sensor waits for the DAG. (Default: None)
+    allowed_states : List[str]
+        Iterable of allowed states, (Default: ['success'])
+    failed_states : List[str]
+        Iterable of failed or dis-allowed states. (Default: None)
+    execution_delta : datetime.timedelta
+        time difference with the previous execution to look at,
+        the default is the same logical date as the current task or DAG. (Default: None)
+    check_existence: bool
+        Set to True to check if the external task exists or check if
+        the DAG to wait for exists. (Default: True)
+    """
     def serialize_operator_args(self):
         ...
     def validate(self, flow):
@@ -18,6 +57,45 @@ class ExternalTaskSensorDecorator(metaflow.plugins.airflow.sensors.base_sensor.A
     ...
 
 class S3KeySensorDecorator(metaflow.plugins.airflow.sensors.base_sensor.AirflowSensorDecorator, metaclass=type):
+    """
+    The `@airflow_s3_key_sensor` decorator attaches a Airflow [S3KeySensor](https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/_api/airflow/providers/amazon/aws/sensors/s3/index.html#airflow.providers.amazon.aws.sensors.s3.S3KeySensor)
+    before the start step of the flow. This decorator only works when a flow is scheduled on Airflow
+    and is compiled using `airflow create`. More than one `@airflow_s3_key_sensor` can be
+    added as a flow decorators. Adding more than one decorator will ensure that `start` step
+    starts only after all sensors finish.
+    
+    Parameters
+    ----------
+    timeout : int
+        Time, in seconds before the task times out and fails. (Default: 3600)
+    poke_interval : int
+        Time in seconds that the job should wait in between each try. (Default: 60)
+    mode : str
+        How the sensor operates. Options are: { poke | reschedule }. (Default: "poke")
+    exponential_backoff : bool
+        allow progressive longer waits between pokes by using exponential backoff algorithm. (Default: True)
+    pool : str
+        the slot pool this task should run in,
+        slot pools are a way to limit concurrency for certain tasks. (Default:None)
+    soft_fail : bool
+        Set to true to mark the task as SKIPPED on failure. (Default: False)
+    name : str
+        Name of the sensor on Airflow
+    description : str
+        Description of sensor in the Airflow UI
+    bucket_key : Union[str, List[str]]
+        The key(s) being waited on. Supports full s3:// style url or relative path from root level.
+        When it's specified as a full s3:// url, please leave `bucket_name` as None
+    bucket_name : str
+        Name of the S3 bucket. Only needed when bucket_key is not provided as a full s3:// url.
+        When specified, all the keys passed to bucket_key refers to this bucket. (Default:None)
+    wildcard_match : bool
+        whether the bucket_key should be interpreted as a Unix wildcard pattern. (Default: False)
+    aws_conn_id : str
+        a reference to the s3 connection on Airflow. (Default: None)
+    verify : bool
+        Whether or not to verify SSL certificates for S3 connection. (Default: None)
+    """
     def validate(self, flow):
         ...
     ...

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.957084                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.081317                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -39,6 +39,9 @@ def id_creator(val, hash_len):
 TASK_ID_HASH_LEN: int
 
 class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    """
+    Base class for all Airflow sensor decorators.
+    """
     def __init__(self, *args, **kwargs):
         ...
     def serialize_operator_args(self):

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.957567                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.081835                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,10 +9,13 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
-    import metaflow.decorators
     import metaflow.plugins.airflow.sensors.base_sensor
+    import metaflow.decorators
 
 class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    """
+    Base class for all Airflow sensor decorators.
+    """
     def __init__(self, *args, **kwargs):
         ...
     def serialize_operator_args(self):
@@ -46,6 +49,45 @@ class AirflowException(metaflow.exception.MetaflowException, metaclass=type):
 AIRFLOW_STATES: dict
 
 class ExternalTaskSensorDecorator(metaflow.plugins.airflow.sensors.base_sensor.AirflowSensorDecorator, metaclass=type):
+    """
+    The `@airflow_external_task_sensor` decorator attaches a Airflow [ExternalTaskSensor](https://airflow.apache.org/docs/apache-airflow/stable/_api/airflow/sensors/external_task/index.html#airflow.sensors.external_task.ExternalTaskSensor) before the start step of the flow.
+    This decorator only works when a flow is scheduled on Airflow and is compiled using `airflow create`. More than one `@airflow_external_task_sensor` can be added as a flow decorators. Adding more than one decorator will ensure that `start` step starts only after all sensors finish.
+    
+    Parameters
+    ----------
+    timeout : int
+        Time, in seconds before the task times out and fails. (Default: 3600)
+    poke_interval : int
+        Time in seconds that the job should wait in between each try. (Default: 60)
+    mode : str
+        How the sensor operates. Options are: { poke | reschedule }. (Default: "poke")
+    exponential_backoff : bool
+        allow progressive longer waits between pokes by using exponential backoff algorithm. (Default: True)
+    pool : str
+        the slot pool this task should run in,
+        slot pools are a way to limit concurrency for certain tasks. (Default:None)
+    soft_fail : bool
+        Set to true to mark the task as SKIPPED on failure. (Default: False)
+    name : str
+        Name of the sensor on Airflow
+    description : str
+        Description of sensor in the Airflow UI
+    external_dag_id : str
+        The dag_id that contains the task you want to wait for.
+    external_task_ids : List[str]
+        The list of task_ids that you want to wait for.
+        If None (default value) the sensor waits for the DAG. (Default: None)
+    allowed_states : List[str]
+        Iterable of allowed states, (Default: ['success'])
+    failed_states : List[str]
+        Iterable of failed or dis-allowed states. (Default: None)
+    execution_delta : datetime.timedelta
+        time difference with the previous execution to look at,
+        the default is the same logical date as the current task or DAG. (Default: None)
+    check_existence: bool
+        Set to True to check if the external task exists or check if
+        the DAG to wait for exists. (Default: True)
+    """
     def serialize_operator_args(self):
         ...
     def validate(self, flow):

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.957992                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.082315                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,10 +9,13 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
-    import metaflow.decorators
     import metaflow.plugins.airflow.sensors.base_sensor
+    import metaflow.decorators
 
 class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    """
+    Base class for all Airflow sensor decorators.
+    """
     def __init__(self, *args, **kwargs):
         ...
     def serialize_operator_args(self):
@@ -44,6 +47,45 @@ class AirflowException(metaflow.exception.MetaflowException, metaclass=type):
     ...
 
 class S3KeySensorDecorator(metaflow.plugins.airflow.sensors.base_sensor.AirflowSensorDecorator, metaclass=type):
+    """
+    The `@airflow_s3_key_sensor` decorator attaches a Airflow [S3KeySensor](https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/_api/airflow/providers/amazon/aws/sensors/s3/index.html#airflow.providers.amazon.aws.sensors.s3.S3KeySensor)
+    before the start step of the flow. This decorator only works when a flow is scheduled on Airflow
+    and is compiled using `airflow create`. More than one `@airflow_s3_key_sensor` can be
+    added as a flow decorators. Adding more than one decorator will ensure that `start` step
+    starts only after all sensors finish.
+    
+    Parameters
+    ----------
+    timeout : int
+        Time, in seconds before the task times out and fails. (Default: 3600)
+    poke_interval : int
+        Time in seconds that the job should wait in between each try. (Default: 60)
+    mode : str
+        How the sensor operates. Options are: { poke | reschedule }. (Default: "poke")
+    exponential_backoff : bool
+        allow progressive longer waits between pokes by using exponential backoff algorithm. (Default: True)
+    pool : str
+        the slot pool this task should run in,
+        slot pools are a way to limit concurrency for certain tasks. (Default:None)
+    soft_fail : bool
+        Set to true to mark the task as SKIPPED on failure. (Default: False)
+    name : str
+        Name of the sensor on Airflow
+    description : str
+        Description of sensor in the Airflow UI
+    bucket_key : Union[str, List[str]]
+        The key(s) being waited on. Supports full s3:// style url or relative path from root level.
+        When it's specified as a full s3:// url, please leave `bucket_name` as None
+    bucket_name : str
+        Name of the S3 bucket. Only needed when bucket_key is not provided as a full s3:// url.
+        When specified, all the keys passed to bucket_key refers to this bucket. (Default:None)
+    wildcard_match : bool
+        whether the bucket_key should be interpreted as a Unix wildcard pattern. (Default: False)
+    aws_conn_id : str
+        a reference to the s3 connection on Airflow. (Default: None)
+    verify : bool
+        Whether or not to verify SSL certificates for S3 connection. (Default: None)
+    """
     def validate(self, flow):
         ...
     ...

metaflow-stubs/plugins/argo/__init__.pyi

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

metaflow-stubs/plugins/argo/argo_client.pyi

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

metaflow-stubs/plugins/argo/argo_events.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.891095                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.029890                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -27,6 +27,20 @@ class ArgoEventException(metaflow.exception.MetaflowException, metaclass=type):
     ...
 
 class ArgoEvent(object, metaclass=type):
+    """
+    ArgoEvent is a small event, a message, that can be published to Argo Workflows. The
+    event will eventually start all flows which have been previously deployed with `@trigger`
+    to wait for this particular named event.
+    
+    Parameters
+    ----------
+    name : str,
+        Name of the event
+    url : str, optional
+        Override the event endpoint from `ARGO_EVENTS_WEBHOOK_URL`.
+    payload : Dict, optional
+        A set of key-value pairs delivered in this event. Used to set parameters of triggered flows.
+    """
     def __init__(self, name, url = None, payload = None, access_token = None):
         ...
     def add_to_payload(self, key, value):

metaflow-stubs/plugins/argo/argo_workflows.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.899426                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.038486                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,9 +9,9 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
-    import metaflow.metaflow_current
-    import metaflow.parameters
     import metaflow._vendor.click.types
+    import metaflow.parameters
+    import metaflow.metaflow_current
     import metaflow.graph
 
 inf: float
@@ -362,6 +362,8 @@ class DaemonTemplate(object, metaclass=type):
         ...
     def container(self, container):
         ...
+    def service_account_name(self, service_account_name):
+        ...
     def to_json(self):
         ...
     def __str__(self):

metaflow-stubs/plugins/argo/argo_workflows_cli.pyi

@@ -1,25 +1,45 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.903970                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.043375                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.exception
+    import metaflow.events
+    import metaflow.graph
     import datetime
-    import metaflow.decorators
+    import metaflow.parameters
     import metaflow.client.core
-    import metaflow.events
     import metaflow.metaflow_current
-    import metaflow.exception
-    import metaflow.parameters
-    import metaflow.graph
+    import metaflow.decorators
 
 JSONType: metaflow.parameters.JSONTypeClass
 
 class Run(metaflow.client.core.MetaflowObject, metaclass=type):
+    """
+    A `Run` represents an execution of a `Flow`. It is a container of `Step`s.
+    
+    Attributes
+    ----------
+    data : MetaflowData
+        a shortcut to run['end'].task.data, i.e. data produced by this run.
+    successful : bool
+        True if the run completed successfully.
+    finished : bool
+        True if the run completed.
+    finished_at : datetime
+        Time this run finished.
+    code : MetaflowCode
+        Code package for this run (if present). See `MetaflowCode`.
+    trigger : MetaflowTrigger
+        Information about event(s) that triggered this run (if present). See `MetaflowTrigger`.
+    end_task : Task
+        `Task` for the end step (if it is present already).
+    """
     def steps(self, *tags: str) -> typing.Iterator[metaflow.client.core.Step]:
         """
         [Legacy function - do not use]
@@ -304,11 +324,82 @@ def store_token(token_prefix, token):
     ...
 
 class EnvironmentDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Specifies environment variables to be set prior to the execution of a step.
+    
+    Parameters
+    ----------
+    vars : Dict[str, str], default {}
+        Dictionary of environment variables to set.
+    """
     def runtime_step_cli(self, cli_args, retry_count, max_user_code_retries, ubf_context):
         ...
     ...
 
 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/argo/argo_workflows_decorator.pyi

@@ -1,25 +1,28 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.21                                                            #
-# Generated on 2024-09-19T17:04:54.892761                                        #
+# MF version: 2.12.23                                                            #
+# Generated on 2024-10-01T14:32:40.031488                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.datastore.inputs
-    import metaflow.decorators
-    import metaflow
     import metaflow.events
+    import metaflow
+    import metaflow.datastore.inputs
     import metaflow.metaflow_current
     import metaflow.flowspec
-    import typing
     import metaflow.graph
+    import metaflow.decorators
+    import typing
 
 current: metaflow.metaflow_current.Current
 
 class Trigger(object, metaclass=type):
+    """
+    Defines a container of event triggers' metadata.
+    """
     def __init__(self, _meta = None):
         ...
     @classmethod
@@ -93,6 +96,9 @@ class Trigger(object, metaclass=type):
     ...
 
 class MetaDatum(tuple, metaclass=type):
+    """
+    MetaDatum(field, value, type, tags)
+    """
     @staticmethod
     def __new__(_cls, field, value, type, tags):
         """
@@ -114,6 +120,14 @@ class MetaDatum(tuple, metaclass=type):
 ARGO_EVENTS_WEBHOOK_URL: None
 
 class FlowSpec(object, metaclass=metaflow.flowspec._FlowSpecMeta):
+    """
+    Main class from which all Flows should inherit.
+    
+    Attributes
+    ----------
+    index
+    input
+    """
     def __init__(self, use_cli = True):
         """
         Construct a FlowSpec
@@ -335,6 +349,20 @@ class FlowSpec(object, metaclass=metaflow.flowspec._FlowSpecMeta):
     ...
 
 class ArgoEvent(object, metaclass=type):
+    """
+    ArgoEvent is a small event, a message, that can be published to Argo Workflows. The
+    event will eventually start all flows which have been previously deployed with `@trigger`
+    to wait for this particular named event.
+    
+    Parameters
+    ----------
+    name : str,
+        Name of the event
+    url : str, optional
+        Override the event endpoint from `ARGO_EVENTS_WEBHOOK_URL`.
+    payload : Dict, optional
+        A set of key-value pairs delivered in this event. Used to set parameters of triggered flows.
+    """
     def __init__(self, name, url = None, payload = None, access_token = None):
         ...
     def add_to_payload(self, key, value):