ob-metaflow-stubs 6.0.3.137__py2.py3-none-any.whl → 6.0.3.139__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (192) hide show
  1. metaflow-stubs/__init__.pyi +189 -189
  2. metaflow-stubs/cards.pyi +2 -2
  3. metaflow-stubs/cli.pyi +2 -2
  4. metaflow-stubs/cli_components/__init__.pyi +2 -2
  5. metaflow-stubs/cli_components/utils.pyi +2 -2
  6. metaflow-stubs/client/__init__.pyi +2 -2
  7. metaflow-stubs/client/core.pyi +4 -4
  8. metaflow-stubs/client/filecache.pyi +3 -3
  9. metaflow-stubs/events.pyi +2 -2
  10. metaflow-stubs/exception.pyi +2 -2
  11. metaflow-stubs/flowspec.pyi +5 -5
  12. metaflow-stubs/generated_for.txt +1 -1
  13. metaflow-stubs/includefile.pyi +3 -3
  14. metaflow-stubs/info_file.pyi +2 -2
  15. metaflow-stubs/metadata_provider/__init__.pyi +2 -2
  16. metaflow-stubs/metadata_provider/heartbeat.pyi +2 -2
  17. metaflow-stubs/metadata_provider/metadata.pyi +2 -2
  18. metaflow-stubs/metadata_provider/util.pyi +2 -2
  19. metaflow-stubs/metaflow_config.pyi +2 -2
  20. metaflow-stubs/metaflow_current.pyi +97 -97
  21. metaflow-stubs/mf_extensions/__init__.pyi +2 -2
  22. metaflow-stubs/mf_extensions/obcheckpoint/__init__.pyi +2 -2
  23. metaflow-stubs/mf_extensions/obcheckpoint/plugins/__init__.pyi +2 -2
  24. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/__init__.pyi +2 -2
  25. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/__init__.pyi +2 -2
  26. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/async_cards.pyi +3 -3
  27. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/deco_injection_mixin.pyi +2 -2
  28. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/extra_components.pyi +3 -3
  29. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/__init__.pyi +2 -2
  30. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/__init__.pyi +2 -2
  31. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/checkpoint_lister.pyi +3 -3
  32. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/lineage_card.pyi +2 -2
  33. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/checkpoint_storage.pyi +6 -6
  34. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/constructors.pyi +2 -2
  35. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/core.pyi +6 -3
  36. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/decorator.pyi +54 -4
  37. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/exceptions.pyi +2 -2
  38. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/final_api.pyi +38 -13
  39. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/lineage.pyi +2 -2
  40. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/__init__.pyi +2 -2
  41. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/core.pyi +3 -3
  42. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/exceptions.pyi +2 -2
  43. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/task_utils.pyi +2 -2
  44. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/utils.pyi +2 -2
  45. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastructures.pyi +2 -2
  46. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/exceptions.pyi +2 -2
  47. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/hf_hub/__init__.pyi +2 -2
  48. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/hf_hub/decorator.pyi +3 -3
  49. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/__init__.pyi +2 -2
  50. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/core.pyi +3 -3
  51. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/exceptions.pyi +2 -2
  52. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/model_storage.pyi +3 -3
  53. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/__init__.pyi +2 -2
  54. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/flowspec_utils.pyi +2 -2
  55. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/general.pyi +2 -2
  56. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/identity_utils.pyi +2 -2
  57. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/serialization_handler/__init__.pyi +2 -2
  58. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/serialization_handler/base.pyi +2 -2
  59. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/serialization_handler/tar.pyi +2 -2
  60. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/tar_utils.pyi +2 -2
  61. metaflow-stubs/mf_extensions/outerbounds/__init__.pyi +2 -2
  62. metaflow-stubs/mf_extensions/outerbounds/plugins/__init__.pyi +2 -2
  63. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/__init__.pyi +2 -2
  64. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/snowflake.pyi +2 -2
  65. metaflow-stubs/mf_extensions/outerbounds/profilers/__init__.pyi +2 -2
  66. metaflow-stubs/mf_extensions/outerbounds/profilers/gpu.pyi +2 -2
  67. metaflow-stubs/mf_extensions/outerbounds/remote_config.pyi +2 -2
  68. metaflow-stubs/mf_extensions/outerbounds/toplevel/__init__.pyi +2 -2
  69. metaflow-stubs/mf_extensions/outerbounds/toplevel/global_aliases_for_metaflow_package.pyi +2 -2
  70. metaflow-stubs/multicore_utils.pyi +2 -2
  71. metaflow-stubs/parameters.pyi +3 -3
  72. metaflow-stubs/plugins/__init__.pyi +12 -12
  73. metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
  74. metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
  75. metaflow-stubs/plugins/airflow/exception.pyi +2 -2
  76. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
  77. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
  78. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +2 -2
  79. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +2 -2
  80. metaflow-stubs/plugins/argo/__init__.pyi +2 -2
  81. metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
  82. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  83. metaflow-stubs/plugins/argo/argo_workflows.pyi +2 -2
  84. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +3 -3
  85. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  86. metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +3 -3
  87. metaflow-stubs/plugins/aws/__init__.pyi +2 -2
  88. metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
  89. metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
  90. metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
  91. metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
  92. metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
  93. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +2 -2
  94. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
  95. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +3 -3
  96. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +2 -2
  97. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +2 -2
  98. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +2 -2
  99. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +2 -2
  100. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +2 -2
  101. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +3 -3
  102. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +3 -3
  103. metaflow-stubs/plugins/azure/__init__.pyi +2 -2
  104. metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
  105. metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
  106. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +3 -3
  107. metaflow-stubs/plugins/azure/azure_utils.pyi +2 -2
  108. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +2 -2
  109. metaflow-stubs/plugins/azure/includefile_support.pyi +2 -2
  110. metaflow-stubs/plugins/cards/__init__.pyi +6 -6
  111. metaflow-stubs/plugins/cards/card_client.pyi +2 -2
  112. metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
  113. metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
  114. metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
  115. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
  116. metaflow-stubs/plugins/cards/card_modules/basic.pyi +2 -2
  117. metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
  118. metaflow-stubs/plugins/cards/card_modules/components.pyi +3 -3
  119. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
  120. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
  121. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +2 -2
  122. metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
  123. metaflow-stubs/plugins/cards/component_serializer.pyi +2 -2
  124. metaflow-stubs/plugins/cards/exception.pyi +2 -2
  125. metaflow-stubs/plugins/catch_decorator.pyi +3 -3
  126. metaflow-stubs/plugins/datatools/__init__.pyi +2 -2
  127. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  128. metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
  129. metaflow-stubs/plugins/datatools/s3/s3.pyi +2 -2
  130. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
  131. metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
  132. metaflow-stubs/plugins/debug_logger.pyi +2 -2
  133. metaflow-stubs/plugins/debug_monitor.pyi +2 -2
  134. metaflow-stubs/plugins/environment_decorator.pyi +2 -2
  135. metaflow-stubs/plugins/events_decorator.pyi +2 -2
  136. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  137. metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
  138. metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
  139. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +3 -3
  140. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +2 -2
  141. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +2 -2
  142. metaflow-stubs/plugins/gcp/gs_utils.pyi +2 -2
  143. metaflow-stubs/plugins/gcp/includefile_support.pyi +2 -2
  144. metaflow-stubs/plugins/kubernetes/__init__.pyi +2 -2
  145. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +2 -2
  146. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +2 -2
  147. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  148. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +2 -2
  149. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
  150. metaflow-stubs/plugins/kubernetes/spot_monitor_sidecar.pyi +2 -2
  151. metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
  152. metaflow-stubs/plugins/perimeters.pyi +2 -2
  153. metaflow-stubs/plugins/project_decorator.pyi +2 -2
  154. metaflow-stubs/plugins/pypi/__init__.pyi +3 -3
  155. metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
  156. metaflow-stubs/plugins/pypi/conda_environment.pyi +2 -2
  157. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
  158. metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
  159. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  160. metaflow-stubs/plugins/resources_decorator.pyi +2 -2
  161. metaflow-stubs/plugins/retry_decorator.pyi +2 -2
  162. metaflow-stubs/plugins/secrets/__init__.pyi +2 -2
  163. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +2 -2
  164. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
  165. metaflow-stubs/plugins/snowflake/__init__.pyi +2 -2
  166. metaflow-stubs/plugins/storage_executor.pyi +2 -2
  167. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +3 -3
  168. metaflow-stubs/plugins/timeout_decorator.pyi +3 -3
  169. metaflow-stubs/profilers/__init__.pyi +2 -2
  170. metaflow-stubs/pylint_wrapper.pyi +2 -2
  171. metaflow-stubs/runner/__init__.pyi +2 -2
  172. metaflow-stubs/runner/deployer.pyi +28 -28
  173. metaflow-stubs/runner/deployer_impl.pyi +2 -2
  174. metaflow-stubs/runner/metaflow_runner.pyi +4 -4
  175. metaflow-stubs/runner/nbdeploy.pyi +2 -2
  176. metaflow-stubs/runner/nbrun.pyi +2 -2
  177. metaflow-stubs/runner/subprocess_manager.pyi +2 -2
  178. metaflow-stubs/runner/utils.pyi +3 -3
  179. metaflow-stubs/system/__init__.pyi +2 -2
  180. metaflow-stubs/system/system_logger.pyi +2 -2
  181. metaflow-stubs/system/system_monitor.pyi +2 -2
  182. metaflow-stubs/tagging_util.pyi +2 -2
  183. metaflow-stubs/tuple_util.pyi +2 -2
  184. metaflow-stubs/user_configs/__init__.pyi +2 -2
  185. metaflow-stubs/user_configs/config_decorators.pyi +6 -6
  186. metaflow-stubs/user_configs/config_options.pyi +2 -2
  187. metaflow-stubs/user_configs/config_parameters.pyi +6 -6
  188. {ob_metaflow_stubs-6.0.3.137.dist-info → ob_metaflow_stubs-6.0.3.139.dist-info}/METADATA +1 -1
  189. ob_metaflow_stubs-6.0.3.139.dist-info/RECORD +192 -0
  190. ob_metaflow_stubs-6.0.3.137.dist-info/RECORD +0 -192
  191. {ob_metaflow_stubs-6.0.3.137.dist-info → ob_metaflow_stubs-6.0.3.139.dist-info}/WHEEL +0 -0
  192. {ob_metaflow_stubs-6.0.3.137.dist-info → ob_metaflow_stubs-6.0.3.139.dist-info}/top_level.txt +0 -0
@@ -1,16 +1,16 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.565913 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.594781 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
12
11
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
13
12
  import metaflow
13
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
14
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.core
15
15
 
16
16
  from ......metaflow_current import current as current
@@ -94,6 +94,9 @@ class ReadResolver(object, metaclass=type):
94
94
  based on different context's.
95
95
  """
96
96
  @classmethod
97
+ def from_pathspec(cls, pathspec):
98
+ ...
99
+ @classmethod
97
100
  def from_key(cls, checkpoint_key):
98
101
  """
99
102
  """
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.541942 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.570244 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -11,8 +11,8 @@ import metaflow
11
11
  if typing.TYPE_CHECKING:
12
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
13
  import metaflow
14
- import os
15
14
  import metaflow.decorators
15
+ import os
16
16
 
17
17
  from .exceptions import CheckpointException as CheckpointException
18
18
  from ..utils import flowspec_utils as flowspec_utils
@@ -97,7 +97,57 @@ class CurrentCheckpointer(object, metaclass=type):
97
97
  If `files`, saves directory directly to the datastore.
98
98
  """
99
99
  ...
100
- 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):
100
+ def list(self, name: typing.Optional[str] = None, task: typing.Union["metaflow.Task", str, None] = None, attempt: typing.Optional[int] = None, full_namespace: bool = False) -> typing.List[typing.Dict]:
101
+ """
102
+ lists the checkpoints in the current task or the specified task.
103
+
104
+ When users call `list` without any arguments, it will list all the checkpoints in the currently executing
105
+ task (this includes all attempts). If the `list` method is called without any arguments outside a Metaflow Task execution context,
106
+ it will raise an exception. Users can also call `list` with `attempt` argument to list all checkpoints within a
107
+ the specific attempt of the currently executing task.
108
+
109
+ When a `task` argument is provided, the `list` method will return all the checkpoints
110
+ for a task's latest attempt unless a specific attempt number is set in the `attempt` argument.
111
+ If the `Task` object contains a `DataArtifact` with all the previous checkpoints, then the `list` method will return
112
+ all the checkpoints from the data artifact. If for some reason the DataArtifact is not written, then the `list` method will
113
+ return all checkpoints directly from the checkpoint's datastore.
114
+
115
+ Usage:
116
+ ------
117
+
118
+ ```python
119
+ current.checkpoint.list(name="best") # lists checkpoints in the current task with the name "best"
120
+ current.checkpoint.list( # Identical as the above one but lists checkpoints from the specified task with the name "best"
121
+ task="anotherflow/somerunid/somestep/sometask",
122
+ name="best"
123
+ )
124
+ current.checkpoint.list() # lists **all** the checkpoints in the current task (including the ones from all attempts)
125
+ ```
126
+
127
+ Parameters
128
+ ----------
129
+
130
+ name : Optional[str], default: None
131
+ Filter checkpoints by name.
132
+
133
+ task : Optional[Union["metaflow.Task", str]], default: None
134
+ The task to list checkpoints from. Can be either a `Task` object or a task pathspec string.
135
+ If None, lists checkpoints for the current task.
136
+ Raises an exception if task is not provided when called outside a Metaflow Task execution context.
137
+
138
+ attempt : Optional[Union[int, str]], default: None
139
+ Filter checkpoints by attempt.
140
+ If `task` is not None and `attempt` is None, then it will load the task's latest attempt
141
+
142
+ full_namespace : bool, default: False
143
+ If True, lists checkpoints from the full namespace.
144
+ Only allowed during a Metaflow Task execution context.
145
+ Raises an exception if `full_namespace` is set to True when called outside a Metaflow Task execution context.
146
+
147
+ Returns
148
+ -------
149
+ List[Dict]
150
+ """
101
151
  ...
102
152
  def cleanup(self):
103
153
  ...
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.540094 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.568341 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.517119 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.542765 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -14,6 +14,7 @@ if typing.TYPE_CHECKING:
14
14
  from ..datastructures import CheckpointArtifact as CheckpointArtifact
15
15
  from .constructors import load_checkpoint as load_checkpoint
16
16
  from .exceptions import CheckpointNotAvailableException as CheckpointNotAvailableException
17
+ from .exceptions import CheckpointException as CheckpointException
17
18
 
18
19
  TYPE_CHECKING: bool
19
20
 
@@ -31,7 +32,7 @@ class Checkpoint(object, metaclass=type):
31
32
  @property
32
33
  def directory(self):
33
34
  ...
34
- def save(self, path = None, metadata = None, latest = True, name = 'mfchckpt', storage_format = 'files'):
35
+ def save(self, path = None, metadata = None, latest = True, name = 'mfchckpt', storage_format = 'files') -> typing.Dict:
35
36
  """
36
37
  Saves the checkpoint to the datastore
37
38
 
@@ -66,10 +67,20 @@ class Checkpoint(object, metaclass=type):
66
67
  ...
67
68
  def __exit__(self, exc_type, exc_val, exc_tb):
68
69
  ...
69
- def list(self, name: typing.Optional[str] = None, task: typing.Union["metaflow.Task", str, None] = None, attempt: typing.Union[int, str, None] = None, as_dict: bool = True, within_task: bool = True) -> typing.Iterable[typing.Union[typing.Dict, metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.CheckpointArtifact]]:
70
+ def list(self, name: typing.Optional[str] = None, task: typing.Union["metaflow.Task", str, None] = None, attempt: typing.Union[int, str, None] = None, full_namespace: bool = False, as_dict: bool = True) -> typing.List[typing.Union[typing.Dict, metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.CheckpointArtifact]]:
70
71
  """
71
- lists the checkpoints in the datastore based on the Task.
72
- It will always be task scoped.
72
+ lists the checkpoints in the current task or the specified task.
73
+
74
+ When users call `list` without any arguments, it will list all the checkpoints in the currently executing
75
+ task (this includes all attempts). If the `list` method is called without any arguments outside a Metaflow Task execution context,
76
+ it will raise an exception. Users can also call `list` with `attempt` argument to list all checkpoints within a
77
+ the specific attempt of the currently executing task.
78
+
79
+ When a `task` argument is provided, the `list` method will return all the checkpoints
80
+ for a task's latest attempt unless a specific attempt number is set in the `attempt` argument.
81
+ If the `Task` object contains a `DataArtifact` with all the previous checkpoints, then the `list` method will return
82
+ all the checkpoints from the data artifact. If for some reason the DataArtifact is not written, then the `list` method will
83
+ return all checkpoints directly from the checkpoint's datastore.
73
84
 
74
85
  Usage:
75
86
  ------
@@ -78,19 +89,33 @@ class Checkpoint(object, metaclass=type):
78
89
 
79
90
  Checkpoint().list(name="best") # lists checkpoints in the current task with the name "best"
80
91
  Checkpoint().list(task="anotherflow/somerunid/somestep/sometask", name="best") # Identical as the above one but
81
- Checkpoint().list() # lists all the checkpoints in the current task
92
+ Checkpoint().list() # lists **all** the checkpoints in the current task (including the ones from all attempts)
82
93
 
83
94
  ```
84
95
 
85
96
  Parameters
86
97
  ----------
87
98
 
88
- - `name`:
89
- - name of the checkpoint to filter for
90
- - `task`:
91
- - Task object outside the one that is currently set in the `Checkpoint` object; Can be a pathspec string.
92
- - `attempt`:
93
- - attempt number of the task (optional filter. If none, then lists all checkpoints from all attempts)
99
+ name : Optional[str], default: None
100
+ Filter checkpoints by name.
101
+
102
+ task : Optional[Union["metaflow.Task", str]], default: None
103
+ The task to list checkpoints from. Can be either a `Task` object or a task pathspec string.
104
+ If None, lists checkpoints for the current task.
105
+ Raises an exception if task is not provided when called outside a Metaflow Task execution context.
106
+
107
+ attempt : Optional[Union[int, str]], default: None
108
+ Filter checkpoints by attempt.
109
+ If `task` is not None and `attempt` is None, then it will load the task's latest attempt
110
+
111
+ full_namespace : bool, default: False
112
+ If True, lists checkpoints from the full namespace.
113
+ Only allowed during a Metaflow Task execution context.
114
+ Raises an exception if `full_namespace` is set to True when called outside a Metaflow Task execution context.
115
+
116
+ Returns
117
+ -------
118
+ List[Dict]
94
119
  """
95
120
  ...
96
121
  def load(self, reference: typing.Union[str, typing.Dict, metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.CheckpointArtifact], path: typing.Optional[str] = None):
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.570228 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.599084 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.540703 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.568943 #
5
5
  ######################################################################################################
6
6
 
@@ -1,15 +1,15 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.567138 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.596036 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
12
11
  import metaflow.datastore.datastore_storage
12
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
13
13
 
14
14
  from ......exception import MetaflowException as MetaflowException
15
15
  from ..utils.tar_utils import create_tarball_on_disk as create_tarball_on_disk
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.624202 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.655307 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.540749 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.568988 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.571305 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.600252 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.518168 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.543828 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.540418 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.568655 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.542756 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.571059 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.542804 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.571106 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
9
9
  import metaflow
10
10
  import typing
11
11
  if typing.TYPE_CHECKING:
12
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
13
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
13
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
14
14
 
15
15
  from ..checkpoints.decorator import CheckpointDecorator as CheckpointDecorator
16
16
  from ..checkpoints.decorator import CurrentCheckpointer as CurrentCheckpointer
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.543739 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.572019 #
5
5
  ######################################################################################################
6
6
 
@@ -1,16 +1,16 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.543787 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.572066 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
11
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
12
13
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.model_storage
13
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
14
14
 
15
15
  from ..datastore.core import STORAGE_FORMATS as STORAGE_FORMATS
16
16
  from ..exceptions import KeyNotFoundError as KeyNotFoundError
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.571135 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.600059 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.570922 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.599821 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -10,8 +10,8 @@ import typing
10
10
  import metaflow
11
11
  if typing.TYPE_CHECKING:
12
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
14
13
  import metaflow.datastore.datastore_storage
14
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
15
15
 
16
16
  from ..datastore.core import ObjectStorage as ObjectStorage
17
17
  from ..datastore.core import DatastoreInterface as DatastoreInterface
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.567773 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.596622 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.567824 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.596672 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.571682 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.600632 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.572144 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.601113 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.572484 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.601465 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.610306 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.640534 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.572544 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.601512 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.609097 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.639338 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.508515 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.533942 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.518852 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.544531 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.518911 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.544589 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.518953 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.544631 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.521308 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.548523 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.521370 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.548599 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.544113 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.572431 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.508567 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.533996 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.13.9.1+obcheckpoint(0.1.7);ob(v1) #
4
- # Generated on 2025-02-03T17:09:26.508606 #
3
+ # MF version: 2.13.9.2+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-07T01:44:39.534037 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations