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

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

metaflow-stubs/plugins/cards/component_serializer.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.387895                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.957670                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -83,6 +83,13 @@ class WarningComponent(metaflow.plugins.cards.card_modules.basic.ErrorComponent,
     ...
 
 class ComponentStore(object, metaclass=type):
+    """
+    The `ComponentStore` object helps store the components for a single card in memory.
+    This class has combination of a array/dictionary like interfaces to access/change the stored components.
+    
+    It exposes the `append` /`extend` methods (like an array) to add components.
+    It also exposes the `__getitem__`/`__setitem__` methods (like a dictionary) to access the components by their Ids.
+    """
     def __init__(self, logger, card_type = None, components = None, user_set_id = None):
         ...
     @property
@@ -118,6 +125,33 @@ class ComponentStore(object, metaclass=type):
     ...
 
 class CardComponentManager(object, metaclass=type):
+    """
+    This class manages the card's state for a single card.
+    - It uses the `ComponentStore` to manage the storage of the components
+    - It exposes methods to add, remove and access the components.
+    - It exposes a `refresh` method that will allow refreshing a card with new data
+    for realtime(ish) updates.
+    - The `CardComponentCollector` exposes convenience methods similar to this class for a default
+    editable card. These methods include :
+        - `append`
+        - `extend`
+        - `clear`
+        - `refresh`
+        - `components`
+        - `__iter__`
+    
+    ## Usage Patterns :
+    
+    ```python
+    current.card["mycardid"].append(component, id="comp123")
+    current.card["mycardid"].extend([component])
+    current.card["mycardid"].refresh(data) # refreshes the card with new data
+    current.card["mycardid"].components["comp123"] # returns the component with id "comp123"
+    current.card["mycardid"].components["comp123"].update()
+    current.card["mycardid"].components.clear() # Wipe all the components
+    del current.card["mycardid"].components["mycomponentid"] # Delete a component
+    ```
+    """
     def __init__(self, card_uuid, decorator_attributes, card_creator, components = None, logger = None, no_warnings = False, user_set_card_id = None, runtime_card = False, card_options = None, refresh_interval = 5):
         ...
     def append(self, component, id = None):
@@ -136,6 +170,25 @@ class CardComponentManager(object, metaclass=type):
     ...
 
 class CardComponentCollector(object, metaclass=type):
+    """
+    This class helps collect `MetaflowCardComponent`s during runtime execution
+    
+    ### Usage with `current`
+    `current.card` is of type `CardComponentCollector`
+    
+    ### Main Usage TLDR
+    - [x] `current.card.append` customizes the default editable card.
+    - [x] Only one card can be default editable in a step.
+    - [x] The card class must have `ALLOW_USER_COMPONENTS=True` to be considered default editable.
+        - [x] Classes with `ALLOW_USER_COMPONENTS=False` are never default editable.
+    - [x] The user can specify an `id` argument to a card, in which case the card is editable through `current.card[id].append`.
+        - [x] A card with an id can be also default editable, if there are no other cards that are eligible to be default editable.
+    - [x] If multiple default-editable cards exist but only one card doesn't have an id, the card without an id is considered to be default editable.
+    - [x] If we can't resolve a single default editable card through the above rules, `current.card`.append calls show a warning but the call doesn't fail.
+    - [x] A card that is not default editable can be still edited through:
+        - [x] its `current.card['myid']`
+        - [x] by looking it up by its type, e.g. `current.card.get(type='pytorch')`.
+    """
     def __init__(self, logger = None, card_creator = None):
         ...
     @staticmethod

metaflow-stubs/plugins/cards/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:46:07.382111                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.940837                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -20,6 +20,9 @@ class MetaflowException(Exception, metaclass=type):
 TYPE_CHECK_REGEX: str
 
 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):
         ...
     ...
@@ -30,6 +33,9 @@ class TypeRequiredException(metaflow.exception.MetaflowException, metaclass=type
     ...
 
 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):
         ...
     ...

metaflow-stubs/plugins/catch_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.371619                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.930084                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -44,6 +44,23 @@ class FailureHandledByCatch(metaflow.exception.MetaflowException, metaclass=type
     ...
 
 class CatchDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Specifies that the step will success under all circumstances.
+    
+    The decorator will create an optional artifact, specified by `var`, which
+    contains the exception raised. You can use it to detect the presence
+    of errors, indicating that all happy-path artifacts produced by the step
+    are missing.
+    
+    Parameters
+    ----------
+    var : str, optional, default None
+        Name of the artifact in which to store the caught exception.
+        If not specified, the exception is not stored.
+    print_exception : bool, default True
+        Determines whether or not the exception is printed to
+        stdout when caught.
+    """
     def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):
         ...
     def task_exception(self, exception, step, flow, graph, retry_count, max_user_code_retries):

metaflow-stubs/plugins/datatools/__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.370357                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.928799                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
-    import metaflow.plugins.datatools.s3.s3
     import io
+    import metaflow.plugins.datatools.s3.s3
 
 def read_in_chunks(dst, src, src_sz, max_chunk_size):
     ...
@@ -22,6 +22,13 @@ class MetaflowLocalURLException(metaflow.exception.MetaflowException, metaclass=
     ...
 
 class Local(object, metaclass=type):
+    """
+    This class allows you to access the local filesystem in a way similar to the S3 datatools
+    client. It is a stripped down version for now and only implements the functionality needed
+    for this use case.
+    
+    In the future, we may want to allow it to be used in a way similar to the S3() client.
+    """
     @classmethod
     def get_root_from_config(cls, echo, create_on_absent = True):
         ...
@@ -47,6 +54,59 @@ class MetaflowS3Exception(metaflow.exception.MetaflowException, metaclass=type):
     ...
 
 class S3(object, metaclass=type):
+    """
+    The Metaflow S3 client.
+    
+    This object manages the connection to S3 and a temporary diretory that is used
+    to download objects. Note that in most cases when the data fits in memory, no local
+    disk IO is needed as operations are cached by the operating system, which makes
+    operations fast as long as there is enough memory available.
+    
+    The easiest way is to use this object as a context manager:
+    ```
+    with S3() as s3:
+        data = [obj.blob for obj in s3.get_many(urls)]
+    print(data)
+    ```
+    The context manager takes care of creating and deleting a temporary directory
+    automatically. Without a context manager, you must call `.close()` to delete
+    the directory explicitly:
+    ```
+    s3 = S3()
+    data = [obj.blob for obj in s3.get_many(urls)]
+    s3.close()
+    ```
+    You can customize the location of the temporary directory with `tmproot`. It
+    defaults to the current working directory.
+    
+    To make it easier to deal with object locations, the client can be initialized
+    with an S3 path prefix. There are three ways to handle locations:
+    
+    1. Use a `metaflow.Run` object or `self`, e.g. `S3(run=self)` which
+       initializes the prefix with the global `DATATOOLS_S3ROOT` path, combined
+       with the current run ID. This mode makes it easy to version data based
+       on the run ID consistently. You can use the `bucket` and `prefix` to
+       override parts of `DATATOOLS_S3ROOT`.
+    
+    2. Specify an S3 prefix explicitly with `s3root`,
+       e.g. `S3(s3root='s3://mybucket/some/path')`.
+    
+    3. Specify nothing, i.e. `S3()`, in which case all operations require
+       a full S3 url prefixed with `s3://`.
+    
+    Parameters
+    ----------
+    tmproot : str, default: '.'
+        Where to store the temporary directory.
+    bucket : str, optional
+        Override the bucket from `DATATOOLS_S3ROOT` when `run` is specified.
+    prefix : str, optional
+        Override the path from `DATATOOLS_S3ROOT` when `run` is specified.
+    run : FlowSpec or Run, optional
+        Derive path prefix from the current or a past run ID, e.g. S3(run=self).
+    s3root : str, optional
+        If `run` is not specified, use this as the S3 prefix.
+    """
     @classmethod
     def get_root_from_config(cls, echo, create_on_absent = True):
         ...

metaflow-stubs/plugins/datatools/local.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.364370                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.922519                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -28,6 +28,13 @@ class MetaflowLocalNotFound(metaflow.exception.MetaflowException, metaclass=type
     ...
 
 class LocalObject(object, metaclass=type):
+    """
+    This object represents a local object. It is a very thin wrapper
+    to allow it to be used in the same way as the S3Object (only as needed
+    in the IncludeFile use case)
+    
+    Get or list calls return one or more of LocalObjects.
+    """
     def __init__(self, url, path):
         ...
     @property
@@ -59,6 +66,13 @@ class LocalObject(object, metaclass=type):
     ...
 
 class Local(object, metaclass=type):
+    """
+    This class allows you to access the local filesystem in a way similar to the S3 datatools
+    client. It is a stripped down version for now and only implements the functionality needed
+    for this use case.
+    
+    In the future, we may want to allow it to be used in a way similar to the S3() client.
+    """
     @classmethod
     def get_root_from_config(cls, echo, create_on_absent = True):
         ...

metaflow-stubs/plugins/datatools/s3/__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.385010                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.954629                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,10 +9,13 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
-    import metaflow.plugins.datatools.s3.s3
     import io
+    import metaflow.plugins.datatools.s3.s3
 
 class RangeInfo(tuple, metaclass=type):
+    """
+    RangeInfo(total_size, request_offset, request_length)
+    """
     @staticmethod
     def __new__(_cls, total_size: int, request_offset: int = 0, request_length: int = -1):
         """
@@ -34,6 +37,59 @@ class RangeInfo(tuple, metaclass=type):
     ...
 
 class S3(object, metaclass=type):
+    """
+    The Metaflow S3 client.
+    
+    This object manages the connection to S3 and a temporary diretory that is used
+    to download objects. Note that in most cases when the data fits in memory, no local
+    disk IO is needed as operations are cached by the operating system, which makes
+    operations fast as long as there is enough memory available.
+    
+    The easiest way is to use this object as a context manager:
+    ```
+    with S3() as s3:
+        data = [obj.blob for obj in s3.get_many(urls)]
+    print(data)
+    ```
+    The context manager takes care of creating and deleting a temporary directory
+    automatically. Without a context manager, you must call `.close()` to delete
+    the directory explicitly:
+    ```
+    s3 = S3()
+    data = [obj.blob for obj in s3.get_many(urls)]
+    s3.close()
+    ```
+    You can customize the location of the temporary directory with `tmproot`. It
+    defaults to the current working directory.
+    
+    To make it easier to deal with object locations, the client can be initialized
+    with an S3 path prefix. There are three ways to handle locations:
+    
+    1. Use a `metaflow.Run` object or `self`, e.g. `S3(run=self)` which
+       initializes the prefix with the global `DATATOOLS_S3ROOT` path, combined
+       with the current run ID. This mode makes it easy to version data based
+       on the run ID consistently. You can use the `bucket` and `prefix` to
+       override parts of `DATATOOLS_S3ROOT`.
+    
+    2. Specify an S3 prefix explicitly with `s3root`,
+       e.g. `S3(s3root='s3://mybucket/some/path')`.
+    
+    3. Specify nothing, i.e. `S3()`, in which case all operations require
+       a full S3 url prefixed with `s3://`.
+    
+    Parameters
+    ----------
+    tmproot : str, default: '.'
+        Where to store the temporary directory.
+    bucket : str, optional
+        Override the bucket from `DATATOOLS_S3ROOT` when `run` is specified.
+    prefix : str, optional
+        Override the path from `DATATOOLS_S3ROOT` when `run` is specified.
+    run : FlowSpec or Run, optional
+        Derive path prefix from the current or a past run ID, e.g. S3(run=self).
+    s3root : str, optional
+        If `run` is not specified, use this as the S3 prefix.
+    """
     @classmethod
     def get_root_from_config(cls, echo, create_on_absent = True):
         ...
@@ -325,6 +381,9 @@ class S3(object, metaclass=type):
     ...
 
 class S3GetObject(tuple, metaclass=type):
+    """
+    S3GetObject(key, offset, length)
+    """
     @staticmethod
     def __new__(_cls, key: str, offset: int, length: int):
         """
@@ -346,6 +405,13 @@ class S3GetObject(tuple, metaclass=type):
     ...
 
 class S3Object(object, metaclass=type):
+    """
+    This object represents a path or an object in S3,
+    with an optional local copy.
+    
+    `S3Object`s are not instantiated directly, but they are returned
+    by many methods of the `S3` client.
+    """
     def __init__(self, prefix: str, url: str, path: str, size: typing.Optional[int] = None, content_type: typing.Optional[str] = None, metadata: typing.Optional[typing.Dict[str, str]] = None, range_info: typing.Optional[metaflow.plugins.datatools.s3.s3.RangeInfo] = None, last_modified: typing.Optional[int] = None, encryption: typing.Optional[str] = None):
         ...
     @property
@@ -549,6 +615,9 @@ class S3Object(object, metaclass=type):
     ...
 
 class S3PutObject(tuple, metaclass=type):
+    """
+    S3PutObject(key, value, path, content_type, encryption, metadata)
+    """
     @staticmethod
     def __new__(_cls, key: str, value: typing.Union[io.RawIOBase, io.BufferedIOBase, str, bytes, None] = None, path: typing.Optional[str] = None, content_type: typing.Optional[str] = None, encryption: typing.Optional[str] = None, metadata: typing.Optional[typing.Dict[str, str]] = None):
         """

metaflow-stubs/plugins/datatools/s3/s3.pyi

@@ -1,24 +1,32 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:46:07.367443                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.925677                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.exception
     import metaflow.metaflow_current
-    import io
-    import metaflow.datastore.inputs
-    import metaflow.flowspec
     import typing
-    import metaflow.exception
     import metaflow.plugins.datatools.s3.s3
+    import metaflow.datastore.inputs
+    import metaflow.flowspec
+    import io
 
 TYPE_CHECKING: bool
 
 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
@@ -290,6 +298,9 @@ def ensure_unicode(x):
     ...
 
 class S3GetObject(tuple, metaclass=type):
+    """
+    S3GetObject(key, offset, length)
+    """
     @staticmethod
     def __new__(_cls, key: str, offset: int, length: int):
         """
@@ -311,6 +322,9 @@ class S3GetObject(tuple, metaclass=type):
     ...
 
 class S3PutObject(tuple, metaclass=type):
+    """
+    S3PutObject(key, value, path, content_type, encryption, metadata)
+    """
     @staticmethod
     def __new__(_cls, key: str, value: typing.Union[io.RawIOBase, io.BufferedIOBase, str, bytes, None] = None, path: typing.Optional[str] = None, content_type: typing.Optional[str] = None, encryption: typing.Optional[str] = None, metadata: typing.Optional[typing.Dict[str, str]] = None):
         """
@@ -332,6 +346,9 @@ class S3PutObject(tuple, metaclass=type):
     ...
 
 class RangeInfo(tuple, metaclass=type):
+    """
+    RangeInfo(total_size, request_offset, request_length)
+    """
     @staticmethod
     def __new__(_cls, total_size: int, request_offset: int = 0, request_length: int = -1):
         """
@@ -371,6 +388,13 @@ class MetaflowS3InvalidRange(metaflow.exception.MetaflowException, metaclass=typ
     ...
 
 class S3Object(object, metaclass=type):
+    """
+    This object represents a path or an object in S3,
+    with an optional local copy.
+    
+    `S3Object`s are not instantiated directly, but they are returned
+    by many methods of the `S3` client.
+    """
     def __init__(self, prefix: str, url: str, path: str, size: typing.Optional[int] = None, content_type: typing.Optional[str] = None, metadata: typing.Optional[typing.Dict[str, str]] = None, range_info: typing.Optional[RangeInfo] = None, last_modified: typing.Optional[int] = None, encryption: typing.Optional[str] = None):
         ...
     @property
@@ -587,6 +611,59 @@ class S3Client(object, metaclass=type):
     ...
 
 class S3(object, metaclass=type):
+    """
+    The Metaflow S3 client.
+    
+    This object manages the connection to S3 and a temporary diretory that is used
+    to download objects. Note that in most cases when the data fits in memory, no local
+    disk IO is needed as operations are cached by the operating system, which makes
+    operations fast as long as there is enough memory available.
+    
+    The easiest way is to use this object as a context manager:
+    ```
+    with S3() as s3:
+        data = [obj.blob for obj in s3.get_many(urls)]
+    print(data)
+    ```
+    The context manager takes care of creating and deleting a temporary directory
+    automatically. Without a context manager, you must call `.close()` to delete
+    the directory explicitly:
+    ```
+    s3 = S3()
+    data = [obj.blob for obj in s3.get_many(urls)]
+    s3.close()
+    ```
+    You can customize the location of the temporary directory with `tmproot`. It
+    defaults to the current working directory.
+    
+    To make it easier to deal with object locations, the client can be initialized
+    with an S3 path prefix. There are three ways to handle locations:
+    
+    1. Use a `metaflow.Run` object or `self`, e.g. `S3(run=self)` which
+       initializes the prefix with the global `DATATOOLS_S3ROOT` path, combined
+       with the current run ID. This mode makes it easy to version data based
+       on the run ID consistently. You can use the `bucket` and `prefix` to
+       override parts of `DATATOOLS_S3ROOT`.
+    
+    2. Specify an S3 prefix explicitly with `s3root`,
+       e.g. `S3(s3root='s3://mybucket/some/path')`.
+    
+    3. Specify nothing, i.e. `S3()`, in which case all operations require
+       a full S3 url prefixed with `s3://`.
+    
+    Parameters
+    ----------
+    tmproot : str, default: '.'
+        Where to store the temporary directory.
+    bucket : str, optional
+        Override the bucket from `DATATOOLS_S3ROOT` when `run` is specified.
+    prefix : str, optional
+        Override the path from `DATATOOLS_S3ROOT` when `run` is specified.
+    run : FlowSpec or Run, optional
+        Derive path prefix from the current or a past run ID, e.g. S3(run=self).
+    s3root : str, optional
+        If `run` is not specified, use this as the S3 prefix.
+    """
     @classmethod
     def get_root_from_config(cls, echo, create_on_absent = True):
         ...

metaflow-stubs/plugins/datatools/s3/s3tail.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.414319                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.974266                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/datatools/s3/s3util.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.383012                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.941772                                        #
 ##################################################################################
 
 from __future__ import annotations

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

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

metaflow-stubs/plugins/environment_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.372585                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T19:10:58.930468                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -11,6 +11,14 @@ if typing.TYPE_CHECKING:
     import metaflow.decorators
 
 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):
         ...
     ...