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

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-04T10:13:10.712557                                        #
 ##################################################################################
 
 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-04T10:13:10.712890                                        #
 ##################################################################################
 
 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-04T10:13:10.666268                                        #
 ##################################################################################
 
 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-04T10:13:10.667675                                        #
 ##################################################################################
 
 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-04T10:13:10.689214                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.client.core
-    import datetime
     import typing
+    import datetime
     import metaflow.parameters
+    import metaflow.client.core
     import metaflow.exception
 
 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):
         """

metaflow-stubs/plugins/cards/card_client.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:46:07.358272                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T10:13:10.656061                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.exception
     import metaflow.plugins.cards.card_client
+    import metaflow.exception
     import metaflow
 
 TYPE_CHECKING: bool
@@ -86,6 +86,14 @@ class IncorrectPathspecException(metaflow.exception.MetaflowException, metaclass
     ...
 
 class Card(object, metaclass=type):
+    """
+    `Card` represents an individual Metaflow Card, a single HTML file, produced by
+    the card `@card` decorator. `Card`s are contained by `CardContainer`, returned by
+    `get_cards`.
+    
+    Note that the contents of the card, an HTML file, is retrieved lazily when you call
+    `Card.get` for the first time or when the card is rendered in a notebook.
+    """
     def __init__(self, card_ds, type, path, hash, id = None, html = None, created_on = None, from_resumed = False, origin_pathspec = None):
         ...
     def get_data(self) -> typing.Optional[dict]:
@@ -137,6 +145,29 @@ class Card(object, metaclass=type):
     ...
 
 class CardContainer(object, metaclass=type):
+    """
+    `CardContainer` is an immutable list-like object, returned by `get_cards`,
+    which contains individual `Card`s.
+    
+    Notably, `CardContainer` contains a special
+    `_repr_html_` function which renders cards automatically in an output
+    cell of a notebook.
+    
+    The following operations are supported:
+    ```
+    cards = get_cards(MyTask)
+    
+    # retrieve by index
+    first_card = cards[0]
+    
+    # check length
+    if len(cards) > 1:
+        print('many cards present!')
+    
+    # iteration
+    list_of_cards = list(cards)
+    ```
+    """
     def __init__(self, card_paths, card_ds, origin_pathspec = None):
         ...
     def __len__(self):

metaflow-stubs/plugins/cards/card_creator.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.388138                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T10:13:10.686204                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -15,6 +15,9 @@ current: metaflow.metaflow_current.Current
 ASYNC_TIMEOUT: int
 
 class CardProcessManager(object, metaclass=type):
+    """
+    This class is responsible for managing the card creation processes.
+    """
     ...
 
 class CardCreator(object, metaclass=type):

metaflow-stubs/plugins/cards/card_datastore.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.381570                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T10:13:10.680210                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -25,6 +25,9 @@ CARD_GSROOT: None
 SKIP_CARD_DUALWRITE: bool
 
 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):
         ...
     ...
@@ -34,6 +37,9 @@ TEMP_DIR_NAME: str
 NUM_SHORT_HASH_CHARS: int
 
 class CardInfo(tuple, metaclass=type):
+    """
+    CardInfo(type, hash, id, filename)
+    """
     @staticmethod
     def __new__(_cls, type, hash, id, filename):
         """

metaflow-stubs/plugins/cards/card_decorator.pyi

@@ -1,19 +1,38 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:46:07.388843                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T10:13:10.686948                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.decorators
     import metaflow.metaflow_current
+    import metaflow.decorators
 
 current: metaflow.metaflow_current.Current
 
 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
@@ -121,6 +140,37 @@ def warning_message(message, logger = None, ts = False):
     ...
 
 class CardDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Creates a human-readable report, a Metaflow Card, after this step completes.
+    
+    Note that you may add multiple `@card` decorators in a step with different parameters.
+    
+    Parameters
+    ----------
+    type : str, default 'default'
+        Card type.
+    id : str, optional, default None
+        If multiple cards are present, use this id to identify this card.
+    options : Dict[str, Any], default {}
+        Options passed to the card. The contents depend on the card type.
+    timeout : int, default 45
+        Interrupt reporting if it takes more than this many seconds.
+    
+    MF Add To Current
+    -----------------
+    card -> metaflow.plugins.cards.component_serializer.CardComponentCollector
+        The `@card` decorator makes the cards available through the `current.card`
+        object. If multiple `@card` decorators are present, you can add an `ID` to
+        distinguish between them using `@card(id=ID)` as the decorator. You will then
+        be able to access that specific card using `current.card[ID].
+    
+        Methods available are `append` and `extend`
+    
+        @@ Returns
+        -------
+        CardComponentCollector
+            The or one of the cards attached to this step.
+    """
     def __init__(self, *args, **kwargs):
         ...
     def step_init(self, flow, graph, step_name, decorators, environment, flow_datastore, logger):

metaflow-stubs/plugins/cards/card_modules/__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.386605                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T10:13:10.684589                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -11,6 +11,32 @@ if typing.TYPE_CHECKING:
     import metaflow
 
 class MetaflowCard(object, metaclass=type):
+    """
+    Metaflow cards derive from this base class.
+    
+    Subclasses of this class are called *card types*. The desired card
+    type `T` is defined in the `@card` decorator as `@card(type=T)`.
+    
+    After a task with `@card(type=T, options=S)` finishes executing, Metaflow instantiates
+    a subclass `C` of `MetaflowCard` that has its `type` attribute set to `T`, i.e. `C.type=T`.
+    The constructor is given the options dictionary `S` that contains arbitrary
+    JSON-encodable data that is passed to the instance, parametrizing the card. The subclass
+    may override the constructor to capture and process the options.
+    
+    The subclass needs to implement a `render(task)` method that produces the card
+    contents in HTML, given the finished task that is represented by a `Task` object.
+    
+    Attributes
+    ----------
+    type : str
+        Card type string. Note that this should be a globally unique name, similar to a
+        Python package name, to avoid name clashes between different custom cards.
+    
+    Parameters
+    ----------
+    options : Dict
+        JSON-encodable dictionary containing user-definable options for the class.
+    """
     def __init__(self, options = {}, components = [], graph = None):
         ...
     def render(self, task: "metaflow.Task") -> str:

metaflow-stubs/plugins/cards/card_modules/basic.pyi

@@ -1,18 +1,44 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1)                              #
-# Generated on 2024-09-20T21:46:07.362546                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T10:13:10.660568                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.cards.card_modules.card
     import metaflow.plugins.cards.card_modules.basic
     import metaflow
+    import metaflow.plugins.cards.card_modules.card
 
 class MetaflowCard(object, metaclass=type):
+    """
+    Metaflow cards derive from this base class.
+    
+    Subclasses of this class are called *card types*. The desired card
+    type `T` is defined in the `@card` decorator as `@card(type=T)`.
+    
+    After a task with `@card(type=T, options=S)` finishes executing, Metaflow instantiates
+    a subclass `C` of `MetaflowCard` that has its `type` attribute set to `T`, i.e. `C.type=T`.
+    The constructor is given the options dictionary `S` that contains arbitrary
+    JSON-encodable data that is passed to the instance, parametrizing the card. The subclass
+    may override the constructor to capture and process the options.
+    
+    The subclass needs to implement a `render(task)` method that produces the card
+    contents in HTML, given the finished task that is represented by a `Task` object.
+    
+    Attributes
+    ----------
+    type : str
+        Card type string. Note that this should be a globally unique name, similar to a
+        Python package name, to avoid name clashes between different custom cards.
+    
+    Parameters
+    ----------
+    options : Dict
+        JSON-encodable dictionary containing user-definable options for the class.
+    """
     def __init__(self, options = {}, components = [], graph = None):
         ...
     def render(self, task: "metaflow.Task") -> str:
@@ -88,6 +114,14 @@ def read_file(path):
     ...
 
 class DefaultComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    """
+    The `DefaultCard` and the `BlankCard` use a JS framework that build the HTML dynamically from JSON.
+    The `DefaultComponent` is the base component that helps build the JSON when `render` is called.
+    
+    The underlying JS framework consists of various types of objects.
+    These can be found in: "metaflow/plugins/cards/ui/types.ts".
+    The `type` attribute in a `DefaultComponent` corresponds to the type of component in the Javascript framework.
+    """
     def __init__(self, title = None, subtitle = None):
         ...
     def render(self):
@@ -197,6 +231,11 @@ class MarkdownComponent(DefaultComponent, metaclass=type):
     ...
 
 class TaskInfoComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    """
+    Properties
+        page_content : a list of MetaflowCardComponents going as task info
+        final_component: the dictionary returned by the `render` function of this class.
+    """
     def __init__(self, task, page_title = "Task Info", only_repr = True, graph = None, components = [], runtime = False):
         ...
     def render(self):

metaflow-stubs/plugins/cards/card_modules/card.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.358693                                        #
+# MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1)                              #
+# Generated on 2024-10-04T10:13:10.656503                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -13,6 +13,32 @@ if typing.TYPE_CHECKING:
 TYPE_CHECKING: bool
 
 class MetaflowCard(object, metaclass=type):
+    """
+    Metaflow cards derive from this base class.
+    
+    Subclasses of this class are called *card types*. The desired card
+    type `T` is defined in the `@card` decorator as `@card(type=T)`.
+    
+    After a task with `@card(type=T, options=S)` finishes executing, Metaflow instantiates
+    a subclass `C` of `MetaflowCard` that has its `type` attribute set to `T`, i.e. `C.type=T`.
+    The constructor is given the options dictionary `S` that contains arbitrary
+    JSON-encodable data that is passed to the instance, parametrizing the card. The subclass
+    may override the constructor to capture and process the options.
+    
+    The subclass needs to implement a `render(task)` method that produces the card
+    contents in HTML, given the finished task that is represented by a `Task` object.
+    
+    Attributes
+    ----------
+    type : str
+        Card type string. Note that this should be a globally unique name, similar to a
+        Python package name, to avoid name clashes between different custom cards.
+    
+    Parameters
+    ----------
+    options : Dict
+        JSON-encodable dictionary containing user-definable options for the class.
+    """
     def __init__(self, options = {}, components = [], graph = None):
         ...
     def render(self, task: "metaflow.Task") -> str: