ob-metaflow-stubs 6.0.3.127__py2.py3-none-any.whl → 6.0.3.128__py2.py3-none-any.whl

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/extra_components.pyi

@@ -0,0 +1,69 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.105637                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+import metaflow
+if typing.TYPE_CHECKING:
+    import metaflow.plugins.cards.card_modules.card
+    import metaflow.plugins.cards.card_modules.components
+
+from ......plugins.cards.card_modules.components import VegaChart as VegaChart
+from ......plugins.cards.card_modules.card import MetaflowCardComponent as MetaflowCardComponent
+from ......plugins.cards.card_modules.components import Artifact as Artifact
+from ......plugins.cards.card_modules.components import Table as Table
+from ......plugins.cards.card_modules.components import with_default_component_id as with_default_component_id
+from ......plugins.cards.card_modules.convert_to_native_type import TaskToDict as TaskToDict
+from ......plugins.cards.card_modules.basic import ArtifactsComponent as ArtifactsComponent
+from ......plugins.cards.card_modules.components import UserComponent as UserComponent
+from ......plugins.cards.card_modules.basic import TableComponent as TableComponent
+from ......plugins.cards.card_modules.basic import SectionComponent as SectionComponent
+from ......plugins.cards.card_modules.renderer_tools import render_safely as render_safely
+from ......metaflow_current import current as current
+
+def update_spec_data(spec, data):
+    ...
+
+def update_data_object(data_object, data):
+    ...
+
+def line_chart_spec(title = None, x_name = 'u', y_name = 'v', xtitle = None, ytitle = None, width = 600, height = 400, with_params = True, x_axis_temporal = False):
+    ...
+
+class LineChart(metaflow.plugins.cards.card_modules.components.UserComponent, metaclass=type):
+    def __init__(self, title, xtitle, ytitle, x_name, y_name, with_params = False, x_axis_temporal = False, width = None, height = None):
+        ...
+    def update(self, data):
+        ...
+    def render(self, *args, **kwargs):
+        ...
+    ...
+
+class ArtifactTable(metaflow.plugins.cards.card_modules.components.Artifact, metaclass=type):
+    def __init__(self, data_dict):
+        ...
+    def render(self, *args, **kwargs):
+        ...
+    ...
+
+class UpadateableTable(metaflow.plugins.cards.card_modules.components.UserComponent, metaclass=type):
+    """
+    Parameters
+    ----------
+    data : List[List[str or MetaflowCardComponent]], optional
+        List (rows) of lists (columns). Each item can be a string or a `MetaflowCardComponent`.
+    headers : List[str], optional
+        Optional header row for the table.
+    """
+    def update(self, row: typing.List[typing.Union[str, metaflow.plugins.cards.card_modules.card.MetaflowCardComponent]]):
+        ...
+    def __init__(self, data: typing.Optional[typing.List[typing.List[typing.Union[str, metaflow.plugins.cards.card_modules.card.MetaflowCardComponent]]]] = None, headers: typing.Optional[typing.List[str]] = None, disable_updates: bool = False):
+        ...
+    def render(self, *args, **kwargs):
+        ...
+    ...
+

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.927066                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.014407                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/__init__.pyi

@@ -0,0 +1,6 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.066857                                                            #
+######################################################################################################
+

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/checkpoint_lister.pyi

@@ -0,0 +1,76 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.066910                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+import threading
+import metaflow
+if typing.TYPE_CHECKING:
+    import threading
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.card_utils.async_cards
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
+
+from ...card_utils.deco_injection_mixin import CardDecoratorInjector as CardDecoratorInjector
+from ...card_utils.async_cards import CardRefresher as CardRefresher
+from ...card_utils.async_cards import AsyncPeriodicRefresher as AsyncPeriodicRefresher
+from ...card_utils.extra_components import LineChart as LineChart
+from ...card_utils.extra_components import UpadateableTable as UpadateableTable
+from ...datastructures import CheckpointArtifact as CheckpointArtifact
+from .lineage_card import construct_lineage_table as construct_lineage_table
+from .lineage_card import create_checkpoint_card as create_checkpoint_card
+from .lineage_card import null_card as null_card
+from .lineage_card import format_datetime as format_datetime
+from ...utils.general import unit_convert as unit_convert
+from .......plugins.cards.card_modules.components import Markdown as Markdown
+from .......plugins.cards.card_modules.components import Table as Table
+from .......plugins.cards.card_modules.components import Artifact as Artifact
+from .......plugins.cards.card_modules.components import VegaChart as VegaChart
+
+def human_readable_date(date):
+    ...
+
+def determine_nice_value(time_range_seconds):
+    """
+    Function to determine the 'nice' value based on the time range in seconds.
+    """
+    ...
+
+def generate_vega_timeline(data_objects):
+    ...
+
+class CheckpointListRefresher(metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.card_utils.async_cards.CardRefresher, metaclass=type):
+    def __init__(self, loaded_checkpoint: typing.Optional[metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.CheckpointArtifact], lineage_stack: typing.Optional[typing.List[metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.CheckpointArtifact]], load_policy: str):
+        ...
+    def on_error(self, current_card, error_message):
+        ...
+    def on_startup(self, current_card):
+        ...
+    def first_time_render(self, current_card, data_object, force_refresh = False):
+        ...
+    def data_update(self, current_card, data_object):
+        ...
+    def on_update(self, current_card, data_object):
+        ...
+    def on_final(self, current_card, data_object):
+        ...
+    ...
+
+class CheckpointsCollector(threading.Thread, metaclass=type):
+    def __init__(self, refresher: metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.card_utils.async_cards.CardRefresher, interval = 1):
+        ...
+    def collect(self):
+        ...
+    def final_update(self):
+        ...
+    def run_update(self):
+        ...
+    def run(self):
+        ...
+    def stop(self):
+        ...
+    ...
+

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/lineage_card.pyi

@@ -0,0 +1,33 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.067273                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.plugins.cards.card_modules.card
+
+from .......plugins.cards.card_modules.components import Table as Table
+from .......plugins.cards.card_modules.components import Markdown as Markdown
+from .......plugins.cards.card_modules.card import MetaflowCardComponent as MetaflowCardComponent
+from .......plugins.cards.card_modules.components import Artifact as Artifact
+from .......plugins.cards.card_modules.basic import DagComponent as DagComponent
+from .......plugins.cards.card_modules.basic import SectionComponent as SectionComponent
+
+TYPE_CHECKING: bool
+
+def format_datetime(iso_str):
+    ...
+
+def null_card(load_policy):
+    ...
+
+def construct_lineage_table(lineage):
+    ...
+
+def create_checkpoint_card(loaded_checkpoint: "Checkpoint", checkpoint_lineage: typing.List["Checkpoint"], load_policy: str) -> typing.List[metaflow.plugins.cards.card_modules.card.MetaflowCardComponent]:
+    ...
+

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/checkpoint_storage.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:51.013938                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.104414                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -9,10 +9,10 @@ from __future__ import annotations
 import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
-    import metaflow.datastore.datastore_storage
     import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
     import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
+    import metaflow.datastore.datastore_storage
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
 
 from ..exceptions import KeyNotCompatibleWithObjectException as KeyNotCompatibleWithObjectException
 from ..utils.identity_utils import pathspec_hash as pathspec_hash

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/constructors.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.950387                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.037169                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/core.pyi

@@ -1,17 +1,17 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.974016                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.063291                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
-    import metaflow
     import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.core
     import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
+    import metaflow
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
 
 from ......metaflow_current import current as current
 from ......exception import MetaflowException as MetaflowException

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/decorator.pyi

@@ -0,0 +1,249 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.039290                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+import metaflow
+if typing.TYPE_CHECKING:
+    import metaflow.decorators
+    import os
+    import metaflow
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
+
+from .exceptions import CheckpointException as CheckpointException
+from ..utils import flowspec_utils as flowspec_utils
+from ..card_utils.deco_injection_mixin import CardDecoratorInjector as CardDecoratorInjector
+from ..card_utils.async_cards import AsyncPeriodicRefresher as AsyncPeriodicRefresher
+from .cards.checkpoint_lister import CheckpointListRefresher as CheckpointListRefresher
+from .cards.checkpoint_lister import CheckpointsCollector as CheckpointsCollector
+from .cards.lineage_card import create_checkpoint_card as create_checkpoint_card
+from .cards.lineage_card import null_card as null_card
+from .lineage import checkpoint_load_related_metadata as checkpoint_load_related_metadata
+from .lineage import trace_lineage as trace_lineage
+from .constructors import load_checkpoint as load_checkpoint
+from .core import ScopeResolver as ScopeResolver
+from .core import CheckpointLoadPolicy as CheckpointLoadPolicy
+from ..datastructures import CheckpointArtifact as CheckpointArtifact
+from .final_api import Checkpoint as Checkpoint
+
+DEFAULT_NAME: str
+
+CHECKPOINT_TAG_PREFIX: str
+
+CHECKPOINT_TASK_IDENTIFIER_ENV_VAR_NAME: str
+
+CHECKPOINT_UID_ENV_VAR_NAME: str
+
+TASK_CHECKPOINTS_ARTIFACT_NAME: str
+
+TASK_LATEST_CHECKPOINT_ARTIFACT_NAME: str
+
+DEFAULT_STORAGE_FORMAT: str
+
+INTERNAL_ARTIFACTS_SET: set
+
+TYPE_CHECKING: bool
+
+def warning_message(message, logger = None, ts = False, prefix = '[@checkpoint]'):
+    ...
+
+class CurrentCheckpointer(object, metaclass=type):
+    @property
+    def task_identifier(self):
+        ...
+    @property
+    def directory(self):
+        ...
+    @property
+    def is_loaded(self):
+        ...
+    @property
+    def info(self):
+        ...
+    def __init__(self, flow, task_identifier, resolved_scope, logger, gang_scheduled_task = False, temp_dir_root = None):
+        ...
+    def save(self, path: typing.Union[str, os.PathLike, None] = None, name: typing.Optional[str] = 'mfchckpt', metadata: typing.Optional[typing.Dict] = {}, latest: bool = True, storage_format: str = 'files'):
+        """
+        Saves the checkpoint to the datastore.
+        
+        Parameters
+        ----------
+        path : Optional[Union[str, os.PathLike]], default: None
+            The path to save the checkpoint. Accepts a file path or a directory path.
+                - If a directory path is provided, all the contents within that directory will be saved.
+                When a checkpoint is reloaded during task retries, `the current.checkpoint.directory` will
+                contain the contents of this directory.
+                - If a file path is provided, the file will be directly saved to the datastore (with the same filename).
+                When the checkpoint is reloaded during task retries, the file with the same name will be available in the
+                `current.checkpoint.directory`.
+                - If no path is provided then the `current.checkpoint.directory` will be saved as the checkpoint.
+        
+        name : Optional[str], default: "mfchckpt"
+            The name of the checkpoint.
+        
+        metadata : Optional[Dict], default: {}
+            Any metadata that needs to be saved with the checkpoint.
+        
+        latest : bool, default: True
+            If True, the checkpoint will be marked as the latest checkpoint.
+            This helps determine if the checkpoint gets loaded when the task restarts.
+        
+        storage_format : str, default: files
+            If `tar`, the contents of the directory will be tarred before saving to the datastore.
+            If `files`, saves directory directly to the datastore.
+        """
+        ...
+    def list(self, name: typing.Optional[str] = None, task: typing.Union["metaflow.Task", str, None] = None, attempt: typing.Optional[int] = None, within_task: bool = True):
+        ...
+    def cleanup(self):
+        ...
+    def refresh_directory(self):
+        ...
+    def load(self, reference: typing.Union[str, typing.Dict, metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.CheckpointArtifact], path: typing.Optional[str] = None):
+        """
+        loads a checkpoint reference from the datastore. (resembles a read op)
+        
+        This can have two meanings:
+            - If the path is provided, it will load the checkpoint in the provided path
+            - If no path is provided, it will load the checkpoint in the default directory
+        
+        Parameters
+        ----------
+        
+        `reference` :
+            - can be a string, dict or a CheckpointArtifact object:
+                - string: a string reference to the checkpoint
+                - dict: a dictionary form of the CheckpointArtifact
+                - CheckpointArtifact: a CheckpointArtifact object reference to the checkpoint
+        """
+        ...
+    ...
+
+def merge_dicts_with_precedence(*args: dict) -> dict:
+    """
+    Merges multiple dictionaries, respecting the order of precedence.
+    
+    This function takes any number of dictionary arguments and merges them into a single dictionary.
+    If the same key exists in multiple dictionaries, the value from the dictionary that appears
+    last in the argument list takes precedence, except where the value is None, in which case
+    the search continues in the earlier dictionaries for a non-None value.
+    
+    The operation is not recursive and will only consider top-level keys.
+    
+    Parameters:
+    - args: A variable number of dictionary arguments. Each argument must be a dictionary.
+    
+    Returns:
+    - dict: A single dictionary that results from merging the input dictionaries according to their order of precedence.
+    
+    Examples:
+    - merge_dicts_with_precedence(defaults, attrs)
+      Here, `defaults` is a dictionary of default values, and `attrs` contains override values.
+      Any None values in `attrs` will result in values from `defaults` being used.
+    
+    - merge_dicts_with_precedence(defaults, global_config, attrs)
+      In this scenario, `global_config` can override `defaults`, and `attrs` can override both
+      `defaults` and `global_config`. The order of arguments defines the precedence.
+    
+    Note:
+    The function behaves differently if the order of the arguments changes, reflecting the
+    precedence of the values set based on their position in the argument list.
+    """
+    ...
+
+class CheckpointDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Enables checkpointing for a step.
+    
+    
+    Parameters
+    ----------
+    load_policy : str, default: "fresh"
+        The policy for loading the checkpoint. The following policies are supported:
+            - "eager": Loads the the latest available checkpoint within the namespace.
+            With this mode, the latest checkpoint written by any previous task (can be even a different run) of the step
+            will be loaded at the start of the task.
+            - "none": Do not load any checkpoint
+            - "fresh": Loads the lastest checkpoint created within the running Task.
+            This mode helps loading checkpoints across various retry attempts of the same task.
+            With this mode, no checkpoint will be loaded at the start of a task but any checkpoints
+            created within the task will be loaded when the task is retries execution on failure.
+    
+    temp_dir_root : str, default: None
+        The root directory under which `current.checkpoint.directory` will be created.
+    
+    
+    MF Add To Current
+    -----------------
+    checkpoint -> metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer
+        The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
+        The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
+    
+        You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
+        by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
+        where the checkpoint maybe loaded or saved.
+    
+        Usage (Saving Checkpoints):
+        -------
+        ```
+        @checkpoint
+        @step
+        def train(self):
+            model = create_model(self.parameters, checkpoint_path = None)
+            for i in range(self.epochs):
+                # some training logic
+                loss = model.train(self.dataset)
+                if i % 10 == 0:
+                    model.save(
+                        current.checkpoint.directory,
+                    )
+                    # saves the contents of the `current.checkpoint.directory` as a checkpoint
+                    # and returns a reference dictionary to the checkpoint saved in the datastore
+                    self.latest_checkpoint = current.checkpoint.save(
+                        name="epoch_checkpoint",
+                        metadata={
+                            "epoch": i,
+                            "loss": loss,
+                        }
+                    )
+        ```
+        Usage (Using Loaded Checkpoints):
+        -------
+        ```
+        @retry(times=3)
+        @checkpoint
+        @step
+        def train(self):
+            # Assume that the task has restarted and the previous attempt of the task
+            # saved a checkpoint
+            checkpoint_path = None
+            if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
+                print("Loaded checkpoint from the previous attempt")
+                checkpoint_path = current.checkpoint.directory
+    
+            model = create_model(self.parameters, checkpoint_path = checkpoint_path)
+            for i in range(self.epochs):
+                ...
+        ```
+    
+        @@ Returns
+        -------
+        CurrentCheckpointer
+            The object for handling checkpointing within a step.
+    """
+    def step_init(self, flow, graph, step_name, decorators, environment, flow_datastore, logger):
+        ...
+    def task_exception(self, exception, step_name, flow, graph, retry_count, max_user_code_retries):
+        ...
+    def task_pre_step(self, step_name, task_datastore, metadata, run_id, task_id, flow, graph, retry_count, max_user_code_retries, ubf_context, inputs):
+        ...
+    def task_decorate(self, step_func, flow, graph, retry_count, max_user_code_retries, ubf_context):
+        ...
+    def task_post_step(self, step_name, flow, graph, retry_count, max_user_code_retries):
+        ...
+    ...
+

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/exceptions.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.950605                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.037392                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/final_api.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.927112                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.014456                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/lineage.pyi

@@ -0,0 +1,27 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.067535                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
+
+from ......metadata_provider.metadata import MetaDatum as MetaDatum
+from ..datastructures import CheckpointArtifact as CheckpointArtifact
+from .core import CheckpointReferenceResolver as CheckpointReferenceResolver
+
+TYPE_CHECKING: bool
+
+def checkpoint_load_related_metadata(checkpoint: metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.CheckpointArtifact, current_attempt):
+    ...
+
+def trace_lineage(flow, checkpoint: metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.CheckpointArtifact):
+    """
+    Trace the lineage of the checkpoint by tracing the previous paths.
+    """
+    ...
+

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.951215                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.037997                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/core.pyi

@@ -1,15 +1,15 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.975275                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.064530                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.datastore.datastore_storage
     import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
+    import metaflow.datastore.datastore_storage
 
 from ......exception import MetaflowException as MetaflowException
 from ..utils.tar_utils import create_tarball_on_disk as create_tarball_on_disk

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/exceptions.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:51.030083                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.120179                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/task_utils.pyi

@@ -1,13 +1,13 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.951266                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.038055                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import metaflow
 import typing
+import metaflow
 if typing.TYPE_CHECKING:
     import metaflow.exception
     import metaflow

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/utils.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:51.030276                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.068638                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastructures.pyi

@@ -1,13 +1,13 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.928096                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.015510                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import metaflow
 import typing
+import metaflow
 if typing.TYPE_CHECKING:
     import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures