ob-metaflow-stubs 6.0.3.143rc0__py2.py3-none-any.whl → 6.0.3.145__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (199) hide show
  1. metaflow-stubs/__init__.pyi +525 -523
  2. metaflow-stubs/cards.pyi +2 -2
  3. metaflow-stubs/cli.pyi +2 -7
  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 +93 -4
  8. metaflow-stubs/client/filecache.pyi +2 -2
  9. metaflow-stubs/events.pyi +3 -3
  10. metaflow-stubs/exception.pyi +2 -2
  11. metaflow-stubs/flowspec.pyi +4 -4
  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 +27 -3
  18. metaflow-stubs/metadata_provider/util.pyi +2 -2
  19. metaflow-stubs/metaflow_config.pyi +3 -3
  20. metaflow-stubs/metaflow_current.pyi +115 -115
  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 +2 -2
  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 +4 -4
  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 +3 -5
  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 +4 -7
  36. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/decorator.pyi +3 -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 +2 -4
  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 +8 -4
  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 +4 -11
  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 +3 -3
  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/card_utilities/__init__.pyi +6 -0
  64. metaflow-stubs/mf_extensions/outerbounds/plugins/card_utilities/injector.pyi +23 -0
  65. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/__init__.pyi +6 -0
  66. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/ollama.pyi +29 -0
  67. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/__init__.pyi +2 -2
  68. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/snowflake.pyi +2 -2
  69. metaflow-stubs/mf_extensions/outerbounds/profilers/__init__.pyi +2 -2
  70. metaflow-stubs/mf_extensions/outerbounds/profilers/gpu.pyi +2 -2
  71. metaflow-stubs/mf_extensions/outerbounds/remote_config.pyi +2 -2
  72. metaflow-stubs/mf_extensions/outerbounds/toplevel/__init__.pyi +2 -2
  73. metaflow-stubs/mf_extensions/outerbounds/toplevel/global_aliases_for_metaflow_package.pyi +2 -2
  74. metaflow-stubs/multicore_utils.pyi +2 -2
  75. metaflow-stubs/parameters.pyi +3 -3
  76. metaflow-stubs/plugins/__init__.pyi +13 -12
  77. metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
  78. metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
  79. metaflow-stubs/plugins/airflow/exception.pyi +2 -2
  80. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
  81. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
  82. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +2 -2
  83. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +2 -2
  84. metaflow-stubs/plugins/argo/__init__.pyi +2 -2
  85. metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
  86. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  87. metaflow-stubs/plugins/argo/argo_workflows.pyi +3 -3
  88. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +3 -3
  89. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  90. metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +2 -2
  91. metaflow-stubs/plugins/aws/__init__.pyi +2 -2
  92. metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
  93. metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
  94. metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
  95. metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
  96. metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
  97. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +2 -2
  98. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
  99. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +3 -3
  100. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +2 -2
  101. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +2 -2
  102. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +2 -2
  103. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +2 -2
  104. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +2 -2
  105. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +3 -3
  106. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +2 -2
  107. metaflow-stubs/plugins/azure/__init__.pyi +2 -2
  108. metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
  109. metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
  110. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +3 -3
  111. metaflow-stubs/plugins/azure/azure_utils.pyi +2 -2
  112. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +2 -2
  113. metaflow-stubs/plugins/azure/includefile_support.pyi +2 -2
  114. metaflow-stubs/plugins/cards/__init__.pyi +6 -6
  115. metaflow-stubs/plugins/cards/card_client.pyi +3 -3
  116. metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
  117. metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
  118. metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
  119. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
  120. metaflow-stubs/plugins/cards/card_modules/basic.pyi +3 -3
  121. metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
  122. metaflow-stubs/plugins/cards/card_modules/components.pyi +3 -3
  123. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
  124. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
  125. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +2 -2
  126. metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
  127. metaflow-stubs/plugins/cards/component_serializer.pyi +2 -2
  128. metaflow-stubs/plugins/cards/exception.pyi +2 -2
  129. metaflow-stubs/plugins/catch_decorator.pyi +3 -3
  130. metaflow-stubs/plugins/datatools/__init__.pyi +2 -2
  131. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  132. metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
  133. metaflow-stubs/plugins/datatools/s3/s3.pyi +3 -3
  134. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
  135. metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
  136. metaflow-stubs/plugins/debug_logger.pyi +2 -2
  137. metaflow-stubs/plugins/debug_monitor.pyi +2 -2
  138. metaflow-stubs/plugins/environment_decorator.pyi +2 -2
  139. metaflow-stubs/plugins/events_decorator.pyi +2 -2
  140. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  141. metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
  142. metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
  143. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +3 -3
  144. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +2 -2
  145. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +2 -2
  146. metaflow-stubs/plugins/gcp/gs_utils.pyi +2 -2
  147. metaflow-stubs/plugins/gcp/includefile_support.pyi +2 -2
  148. metaflow-stubs/plugins/kubernetes/__init__.pyi +2 -2
  149. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +2 -2
  150. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +4 -4
  151. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  152. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +2 -5
  153. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
  154. metaflow-stubs/plugins/kubernetes/spot_monitor_sidecar.pyi +2 -2
  155. metaflow-stubs/plugins/ollama/__init__.pyi +53 -0
  156. metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
  157. metaflow-stubs/plugins/perimeters.pyi +2 -2
  158. metaflow-stubs/plugins/project_decorator.pyi +2 -2
  159. metaflow-stubs/plugins/pypi/__init__.pyi +2 -2
  160. metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
  161. metaflow-stubs/plugins/pypi/conda_environment.pyi +4 -4
  162. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
  163. metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
  164. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  165. metaflow-stubs/plugins/resources_decorator.pyi +2 -2
  166. metaflow-stubs/plugins/retry_decorator.pyi +2 -2
  167. metaflow-stubs/plugins/secrets/__init__.pyi +3 -3
  168. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +2 -2
  169. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
  170. metaflow-stubs/plugins/snowflake/__init__.pyi +2 -2
  171. metaflow-stubs/plugins/storage_executor.pyi +2 -2
  172. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +2 -2
  173. metaflow-stubs/plugins/timeout_decorator.pyi +3 -3
  174. metaflow-stubs/profilers/__init__.pyi +2 -2
  175. metaflow-stubs/pylint_wrapper.pyi +2 -2
  176. metaflow-stubs/runner/__init__.pyi +2 -2
  177. metaflow-stubs/runner/deployer.pyi +6 -6
  178. metaflow-stubs/runner/deployer_impl.pyi +2 -2
  179. metaflow-stubs/runner/metaflow_runner.pyi +2 -2
  180. metaflow-stubs/runner/nbdeploy.pyi +2 -2
  181. metaflow-stubs/runner/nbrun.pyi +2 -2
  182. metaflow-stubs/runner/subprocess_manager.pyi +2 -2
  183. metaflow-stubs/runner/utils.pyi +4 -4
  184. metaflow-stubs/system/__init__.pyi +2 -2
  185. metaflow-stubs/system/system_logger.pyi +3 -3
  186. metaflow-stubs/system/system_monitor.pyi +2 -2
  187. metaflow-stubs/tagging_util.pyi +2 -2
  188. metaflow-stubs/tuple_util.pyi +2 -2
  189. metaflow-stubs/user_configs/__init__.pyi +2 -2
  190. metaflow-stubs/user_configs/config_decorators.pyi +6 -6
  191. metaflow-stubs/user_configs/config_options.pyi +3 -3
  192. metaflow-stubs/user_configs/config_parameters.pyi +6 -6
  193. {ob_metaflow_stubs-6.0.3.143rc0.dist-info → ob_metaflow_stubs-6.0.3.145.dist-info}/METADATA +1 -1
  194. ob_metaflow_stubs-6.0.3.145.dist-info/RECORD +197 -0
  195. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/context.pyi +0 -79
  196. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/decorator.pyi +0 -46
  197. ob_metaflow_stubs-6.0.3.143rc0.dist-info/RECORD +0 -194
  198. {ob_metaflow_stubs-6.0.3.143rc0.dist-info → ob_metaflow_stubs-6.0.3.145.dist-info}/WHEEL +0 -0
  199. {ob_metaflow_stubs-6.0.3.143rc0.dist-info → ob_metaflow_stubs-6.0.3.145.dist-info}/top_level.txt +0 -0
@@ -1,21 +1,21 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.180644 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.249947 #
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.hf_hub.decorator
12
- import metaflow
11
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
13
12
  import metaflow.events
14
- import metaflow.metaflow_current
13
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
15
14
  import typing
16
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
15
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
16
+ import metaflow
17
17
  import metaflow.plugins.cards.component_serializer
18
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
18
+ import metaflow.metaflow_current
19
19
 
20
20
 
21
21
  TYPE_CHECKING: bool
@@ -228,6 +228,114 @@ class Current(object, metaclass=type):
228
228
  def graph(self):
229
229
  ...
230
230
  @property
231
+ def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
232
+ """
233
+ (only in the presence of the @card decorator)
234
+
235
+ The `@card` decorator makes the cards available through the `current.card`
236
+ object. If multiple `@card` decorators are present, you can add an `ID` to
237
+ distinguish between them using `@card(id=ID)` as the decorator. You will then
238
+ be able to access that specific card using `current.card[ID].
239
+
240
+ Methods available are `append` and `extend`
241
+
242
+ Returns
243
+ -------
244
+ CardComponentCollector
245
+ The or one of the cards attached to this step.
246
+ """
247
+ ...
248
+ @property
249
+ def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
250
+ """
251
+ (only in the presence of the @checkpoint decorator)
252
+
253
+ The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
254
+ The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
255
+
256
+ You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
257
+ by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
258
+ where the checkpoint maybe loaded or saved.
259
+
260
+ Usage (Saving Checkpoints):
261
+ -------
262
+ ```
263
+ @checkpoint
264
+ @step
265
+ def train(self):
266
+ model = create_model(self.parameters, checkpoint_path = None)
267
+ for i in range(self.epochs):
268
+ # some training logic
269
+ loss = model.train(self.dataset)
270
+ if i % 10 == 0:
271
+ model.save(
272
+ current.checkpoint.directory,
273
+ )
274
+ # saves the contents of the `current.checkpoint.directory` as a checkpoint
275
+ # and returns a reference dictionary to the checkpoint saved in the datastore
276
+ self.latest_checkpoint = current.checkpoint.save(
277
+ name="epoch_checkpoint",
278
+ metadata={
279
+ "epoch": i,
280
+ "loss": loss,
281
+ }
282
+ )
283
+ ```
284
+ Usage (Using Loaded Checkpoints):
285
+ -------
286
+ ```
287
+ @retry(times=3)
288
+ @checkpoint
289
+ @step
290
+ def train(self):
291
+ # Assume that the task has restarted and the previous attempt of the task
292
+ # saved a checkpoint
293
+ checkpoint_path = None
294
+ if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
295
+ print("Loaded checkpoint from the previous attempt")
296
+ checkpoint_path = current.checkpoint.directory
297
+
298
+ model = create_model(self.parameters, checkpoint_path = checkpoint_path)
299
+ for i in range(self.epochs):
300
+ ...
301
+ ```
302
+
303
+ Returns
304
+ -------
305
+ CurrentCheckpointer
306
+ The object for handling checkpointing within a step.
307
+ """
308
+ ...
309
+ @property
310
+ def parallel(self) -> "metaflow.metaflow_current.Parallel":
311
+ """
312
+ (only in the presence of the @parallel decorator)
313
+
314
+ Returns a namedtuple with relevant information about the parallel task.
315
+
316
+ Returns
317
+ -------
318
+ Parallel
319
+ `namedtuple` with the following fields:
320
+ - main_ip (`str`)
321
+ The IP address of the control task.
322
+ - num_nodes (`int`)
323
+ The total number of tasks created by @parallel
324
+ - node_index (`int`)
325
+ The index of the current task in all the @parallel tasks.
326
+ - control_task_id (`Optional[str]`)
327
+ The task ID of the control task. Available to all tasks.
328
+ """
329
+ ...
330
+ @property
331
+ def is_parallel(self) -> bool:
332
+ """
333
+ (only in the presence of the @parallel decorator)
334
+
335
+ True if the current step is a @parallel step.
336
+ """
337
+ ...
338
+ @property
231
339
  def huggingface_hub(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
232
340
  """
233
341
  (only in the presence of the @huggingface_hub decorator)
@@ -297,35 +405,6 @@ class Current(object, metaclass=type):
297
405
  """
298
406
  ...
299
407
  @property
300
- def parallel(self) -> "metaflow.metaflow_current.Parallel":
301
- """
302
- (only in the presence of the @parallel decorator)
303
-
304
- Returns a namedtuple with relevant information about the parallel task.
305
-
306
- Returns
307
- -------
308
- Parallel
309
- `namedtuple` with the following fields:
310
- - main_ip (`str`)
311
- The IP address of the control task.
312
- - num_nodes (`int`)
313
- The total number of tasks created by @parallel
314
- - node_index (`int`)
315
- The index of the current task in all the @parallel tasks.
316
- - control_task_id (`Optional[str]`)
317
- The task ID of the control task. Available to all tasks.
318
- """
319
- ...
320
- @property
321
- def is_parallel(self) -> bool:
322
- """
323
- (only in the presence of the @parallel decorator)
324
-
325
- True if the current step is a @parallel step.
326
- """
327
- ...
328
- @property
329
408
  def model(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
330
409
  """
331
410
  (only in the presence of the @model decorator)
@@ -387,85 +466,6 @@ class Current(object, metaclass=type):
387
466
  """
388
467
  ...
389
468
  @property
390
- def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
391
- """
392
- (only in the presence of the @checkpoint decorator)
393
-
394
- The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
395
- The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
396
-
397
- You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
398
- by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
399
- where the checkpoint maybe loaded or saved.
400
-
401
- Usage (Saving Checkpoints):
402
- -------
403
- ```
404
- @checkpoint
405
- @step
406
- def train(self):
407
- model = create_model(self.parameters, checkpoint_path = None)
408
- for i in range(self.epochs):
409
- # some training logic
410
- loss = model.train(self.dataset)
411
- if i % 10 == 0:
412
- model.save(
413
- current.checkpoint.directory,
414
- )
415
- # saves the contents of the `current.checkpoint.directory` as a checkpoint
416
- # and returns a reference dictionary to the checkpoint saved in the datastore
417
- self.latest_checkpoint = current.checkpoint.save(
418
- name="epoch_checkpoint",
419
- metadata={
420
- "epoch": i,
421
- "loss": loss,
422
- }
423
- )
424
- ```
425
- Usage (Using Loaded Checkpoints):
426
- -------
427
- ```
428
- @retry(times=3)
429
- @checkpoint
430
- @step
431
- def train(self):
432
- # Assume that the task has restarted and the previous attempt of the task
433
- # saved a checkpoint
434
- checkpoint_path = None
435
- if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
436
- print("Loaded checkpoint from the previous attempt")
437
- checkpoint_path = current.checkpoint.directory
438
-
439
- model = create_model(self.parameters, checkpoint_path = checkpoint_path)
440
- for i in range(self.epochs):
441
- ...
442
- ```
443
-
444
- Returns
445
- -------
446
- CurrentCheckpointer
447
- The object for handling checkpointing within a step.
448
- """
449
- ...
450
- @property
451
- def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
452
- """
453
- (only in the presence of the @card decorator)
454
-
455
- The `@card` decorator makes the cards available through the `current.card`
456
- object. If multiple `@card` decorators are present, you can add an `ID` to
457
- distinguish between them using `@card(id=ID)` as the decorator. You will then
458
- be able to access that specific card using `current.card[ID].
459
-
460
- Methods available are `append` and `extend`
461
-
462
- Returns
463
- -------
464
- CardComponentCollector
465
- The or one of the cards attached to this step.
466
- """
467
- ...
468
- @property
469
469
  def trigger(self) -> "metaflow.events.Trigger":
470
470
  """
471
471
  (only in the presence of the @trigger, or @trigger_on_finish decorators)
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.040681 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.086237 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.049268 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.101900 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.049334 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.101989 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.049388 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.102077 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.100513 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.180918 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.101113 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.181517 #
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.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.100559 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.180967 #
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.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.150918 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.221851 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
9
9
  import typing
10
10
  import metaflow
11
11
  if typing.TYPE_CHECKING:
12
- import metaflow.plugins.cards.card_modules.components
13
12
  import metaflow.plugins.cards.card_modules.card
13
+ import metaflow.plugins.cards.card_modules.components
14
14
 
15
15
  from ......plugins.cards.card_modules.components import VegaChart as VegaChart
16
16
  from ......plugins.cards.card_modules.card import MetaflowCardComponent as MetaflowCardComponent
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.049443 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.102173 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.101888 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.183029 #
5
5
  ######################################################################################################
6
6
 
@@ -1,18 +1,18 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.101933 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.183078 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import threading
10
9
  import typing
10
+ import threading
11
11
  import metaflow
12
12
  if typing.TYPE_CHECKING:
13
13
  import threading
14
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
15
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.card_utils.async_cards
15
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
16
16
 
17
17
  from ...card_utils.deco_injection_mixin import CardDecoratorInjector as CardDecoratorInjector
18
18
  from ...card_utils.async_cards import CardRefresher as CardRefresher
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.102299 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.183432 #
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.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.149999 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.220499 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -10,9 +10,9 @@ import typing
10
10
  import metaflow
11
11
  if typing.TYPE_CHECKING:
12
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
13
+ import metaflow.datastore.datastore_storage
13
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
14
15
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
15
- import metaflow.datastore.datastore_storage
16
16
 
17
17
  from ..exceptions import KeyNotCompatibleWithObjectException as KeyNotCompatibleWithObjectException
18
18
  from ..utils.identity_utils import pathspec_hash as pathspec_hash
@@ -123,8 +123,6 @@ class CheckpointDatastore(metaflow.mf_extensions.obcheckpoint.plugins.machine_le
123
123
  @classmethod
124
124
  def decompose_key(cls, key) -> CheckpointsPathComponents:
125
125
  ...
126
- def __str__(self):
127
- ...
128
126
  def __init__(self, artifact_store: metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core.ObjectStorage, metadata_store: metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core.ObjectStorage, artifact_metadatastore: metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core.ObjectStorage):
129
127
  ...
130
128
  ...
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.073112 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.142503 #
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.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.099627 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.178761 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,9 +9,9 @@ from __future__ import annotations
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
11
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
12
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
13
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.core
14
13
  import metaflow
14
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
15
15
 
16
16
  from ......metaflow_current import current as current
17
17
  from ......exception import MetaflowException as MetaflowException
@@ -22,7 +22,6 @@ from .checkpoint_storage import CheckpointDatastore as CheckpointDatastore
22
22
  from ..datastructures import CheckpointArtifact as CheckpointArtifact
23
23
  from ..datastore.task_utils import init_datastorage_object as init_datastorage_object
24
24
  from ..datastore.task_utils import resolve_storage_backend as resolve_task_storage_backend
25
- from ..datastore.task_utils import storage_backend_from_flow as storage_backend_from_flow
26
25
 
27
26
  TYPE_CHECKING: bool
28
27
 
@@ -46,8 +45,6 @@ class Checkpointer(object, metaclass=type):
46
45
  ...
47
46
  def load_metadata(self, version_id: int = None, name = 'mfchckpt') -> dict:
48
47
  ...
49
- def artifact_id(self, name: str, version_id: int = None):
50
- ...
51
48
  def save(self, path: str, metadata = {}, latest = True, name = 'mfchckpt', storage_format = 'files') -> metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.CheckpointArtifact:
52
49
  ...
53
50
  ...
@@ -105,7 +102,7 @@ class ReadResolver(object, metaclass=type):
105
102
  """
106
103
  ...
107
104
  @classmethod
108
- def from_checkpoint(cls, checkpoint: metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.CheckpointArtifact):
105
+ def from_key_and_pathspec(cls, pathspec, checkpoint_key):
109
106
  """
110
107
  """
111
108
  ...
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.075221 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.146298 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,9 +9,9 @@ from __future__ import annotations
9
9
  import typing
10
10
  import metaflow
11
11
  if typing.TYPE_CHECKING:
12
+ import metaflow.decorators
12
13
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
14
  import os
14
- import metaflow.decorators
15
15
  import metaflow
16
16
 
17
17
  from .exceptions import CheckpointException as CheckpointException
@@ -28,7 +28,6 @@ from .constructors import load_checkpoint as load_checkpoint
28
28
  from .core import ScopeResolver as ScopeResolver
29
29
  from .core import CheckpointLoadPolicy as CheckpointLoadPolicy
30
30
  from ..datastructures import CheckpointArtifact as CheckpointArtifact
31
- from ..datastore.decorator import set_datastore_context as set_datastore_context
32
31
  from .final_api import Checkpoint as Checkpoint
33
32
 
34
33
  DEFAULT_NAME: str
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.073341 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.142890 #
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.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.049484 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.102244 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -63,8 +63,6 @@ class Checkpoint(object, metaclass=type):
63
63
  If `files`, saves directory directly to the datastore.
64
64
  """
65
65
  ...
66
- def generate_key(self, name: str, version_id: int = None):
67
- ...
68
66
  def __enter__(self):
69
67
  ...
70
68
  def __exit__(self, exc_type, exc_val, exc_tb):
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.102556 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.183688 #
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.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.050974 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.143890 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.104075 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.180033 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -105,6 +105,9 @@ class ObjectStorage(object, metaclass=type):
105
105
  ...
106
106
  def set_full_prefix(self, root_prefix):
107
107
  ...
108
+ @staticmethod
109
+ def resolve_root(storage_type):
110
+ ...
108
111
  def full_base_url(self, prefix = None):
109
112
  ...
110
113
  def create_key_name(self, *args):
@@ -139,8 +142,6 @@ class ObjectStorage(object, metaclass=type):
139
142
  List all objects in the datastore's `keys` index.
140
143
  """
141
144
  ...
142
- def __str__(self) -> str:
143
- ...
144
145
  ...
145
146
 
146
147
  class DatastoreInterface(object, metaclass=type):
@@ -182,3 +183,6 @@ class DatastoreInterface(object, metaclass=type):
182
183
  ...
183
184
  ...
184
185
 
186
+ def resolve_root(datastore_type):
187
+ ...
188
+
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.14.0.2rc0+obcheckpoint(0.1.8.1rc0);ob(v1) #
4
- # Generated on 2025-02-17T19:27:36.165512 #
3
+ # MF version: 2.14.3.1+obcheckpoint(0.1.8);ob(v1) #
4
+ # Generated on 2025-02-24T18:52:39.235716 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations