ob-metaflow-stubs 6.0.3.176rc6__py2.py3-none-any.whl → 6.0.3.178__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 (219) hide show
  1. metaflow-stubs/__init__.pyi +793 -789
  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 +27 -27
  8. metaflow-stubs/client/filecache.pyi +3 -3
  9. metaflow-stubs/events.pyi +6 -6
  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 +4 -4
  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 +3 -3
  18. metaflow-stubs/metadata_provider/util.pyi +2 -2
  19. metaflow-stubs/metaflow_config.pyi +4 -2
  20. metaflow-stubs/metaflow_current.pyi +104 -104
  21. metaflow-stubs/metaflow_git.pyi +2 -2
  22. metaflow-stubs/mf_extensions/__init__.pyi +2 -2
  23. metaflow-stubs/mf_extensions/obcheckpoint/__init__.pyi +2 -2
  24. metaflow-stubs/mf_extensions/obcheckpoint/plugins/__init__.pyi +2 -2
  25. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/__init__.pyi +2 -2
  26. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/__init__.pyi +2 -2
  27. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/async_cards.pyi +2 -2
  28. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/deco_injection_mixin.pyi +2 -2
  29. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/extra_components.pyi +3 -3
  30. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/__init__.pyi +2 -2
  31. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/__init__.pyi +2 -2
  32. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/checkpoint_lister.pyi +4 -4
  33. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/lineage_card.pyi +2 -2
  34. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/checkpoint_storage.pyi +4 -4
  35. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/constructors.pyi +2 -2
  36. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/core.pyi +3 -3
  37. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/decorator.pyi +5 -5
  38. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/exceptions.pyi +2 -2
  39. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/final_api.pyi +3 -3
  40. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/lineage.pyi +2 -2
  41. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/__init__.pyi +2 -2
  42. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/context.pyi +3 -3
  43. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/core.pyi +3 -3
  44. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/decorator.pyi +2 -2
  45. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/exceptions.pyi +2 -2
  46. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/task_utils.pyi +3 -3
  47. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/utils.pyi +2 -2
  48. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastructures.pyi +5 -5
  49. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/exceptions.pyi +2 -2
  50. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/hf_hub/__init__.pyi +2 -2
  51. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/hf_hub/decorator.pyi +2 -2
  52. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/__init__.pyi +2 -2
  53. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/core.pyi +3 -3
  54. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/exceptions.pyi +2 -2
  55. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/model_storage.pyi +4 -4
  56. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/__init__.pyi +2 -2
  57. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/flowspec_utils.pyi +2 -2
  58. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/general.pyi +2 -2
  59. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/identity_utils.pyi +2 -2
  60. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/serialization_handler/__init__.pyi +2 -2
  61. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/serialization_handler/base.pyi +2 -2
  62. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/serialization_handler/tar.pyi +3 -3
  63. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/tar_utils.pyi +3 -3
  64. metaflow-stubs/mf_extensions/outerbounds/__init__.pyi +2 -2
  65. metaflow-stubs/mf_extensions/outerbounds/plugins/__init__.pyi +2 -2
  66. metaflow-stubs/mf_extensions/outerbounds/plugins/{fast_bakery → aws}/__init__.pyi +2 -2
  67. metaflow-stubs/mf_extensions/outerbounds/plugins/aws/assume_role_decorator.pyi +52 -0
  68. metaflow-stubs/mf_extensions/outerbounds/plugins/card_utilities/__init__.pyi +2 -2
  69. metaflow-stubs/mf_extensions/outerbounds/plugins/card_utilities/async_cards.pyi +3 -3
  70. metaflow-stubs/mf_extensions/outerbounds/plugins/card_utilities/injector.pyi +2 -2
  71. metaflow-stubs/mf_extensions/outerbounds/plugins/checkpoint_datastores/__init__.pyi +2 -2
  72. metaflow-stubs/mf_extensions/outerbounds/plugins/checkpoint_datastores/coreweave.pyi +2 -2
  73. metaflow-stubs/mf_extensions/outerbounds/plugins/checkpoint_datastores/nebius.pyi +2 -2
  74. metaflow-stubs/mf_extensions/outerbounds/plugins/kubernetes/__init__.pyi +2 -2
  75. metaflow-stubs/mf_extensions/outerbounds/plugins/kubernetes/pod_killer.pyi +2 -2
  76. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/__init__.pyi +2 -2
  77. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/constants.pyi +2 -2
  78. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/exceptions.pyi +2 -2
  79. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/ollama.pyi +2 -2
  80. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/status_card.pyi +2 -2
  81. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/__init__.pyi +2 -2
  82. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/snowflake.pyi +2 -2
  83. metaflow-stubs/mf_extensions/outerbounds/profilers/__init__.pyi +2 -2
  84. metaflow-stubs/mf_extensions/outerbounds/profilers/gpu.pyi +2 -2
  85. metaflow-stubs/mf_extensions/outerbounds/remote_config.pyi +2 -2
  86. metaflow-stubs/mf_extensions/outerbounds/toplevel/__init__.pyi +2 -2
  87. metaflow-stubs/mf_extensions/outerbounds/toplevel/global_aliases_for_metaflow_package.pyi +3 -3
  88. metaflow-stubs/multicore_utils.pyi +2 -2
  89. metaflow-stubs/parameters.pyi +5 -5
  90. metaflow-stubs/plugins/__init__.pyi +10 -10
  91. metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
  92. metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
  93. metaflow-stubs/plugins/airflow/exception.pyi +2 -2
  94. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
  95. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
  96. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +2 -2
  97. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +2 -2
  98. metaflow-stubs/plugins/argo/__init__.pyi +2 -2
  99. metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
  100. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  101. metaflow-stubs/plugins/argo/argo_workflows.pyi +5 -3
  102. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +3 -3
  103. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  104. metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +5 -7
  105. metaflow-stubs/plugins/aws/__init__.pyi +2 -2
  106. metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
  107. metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
  108. metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
  109. metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
  110. metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
  111. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +2 -2
  112. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
  113. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +3 -3
  114. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +2 -2
  115. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +2 -2
  116. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +2 -2
  117. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +2 -2
  118. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +2 -2
  119. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +3 -3
  120. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +5 -5
  121. metaflow-stubs/plugins/azure/__init__.pyi +2 -2
  122. metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
  123. metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
  124. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +3 -3
  125. metaflow-stubs/plugins/azure/azure_utils.pyi +2 -2
  126. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +2 -2
  127. metaflow-stubs/plugins/azure/includefile_support.pyi +2 -2
  128. metaflow-stubs/plugins/cards/__init__.pyi +2 -2
  129. metaflow-stubs/plugins/cards/card_client.pyi +3 -3
  130. metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
  131. metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
  132. metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
  133. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
  134. metaflow-stubs/plugins/cards/card_modules/basic.pyi +3 -3
  135. metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
  136. metaflow-stubs/plugins/cards/card_modules/components.pyi +3 -3
  137. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
  138. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
  139. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +2 -2
  140. metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
  141. metaflow-stubs/plugins/cards/component_serializer.pyi +2 -2
  142. metaflow-stubs/plugins/cards/exception.pyi +2 -2
  143. metaflow-stubs/plugins/catch_decorator.pyi +2 -2
  144. metaflow-stubs/plugins/datatools/__init__.pyi +2 -2
  145. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  146. metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
  147. metaflow-stubs/plugins/datatools/s3/s3.pyi +15 -15
  148. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
  149. metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
  150. metaflow-stubs/plugins/debug_logger.pyi +2 -2
  151. metaflow-stubs/plugins/debug_monitor.pyi +2 -2
  152. metaflow-stubs/plugins/environment_decorator.pyi +2 -2
  153. metaflow-stubs/plugins/events_decorator.pyi +2 -2
  154. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  155. metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
  156. metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
  157. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +3 -3
  158. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +2 -2
  159. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +2 -2
  160. metaflow-stubs/plugins/gcp/gs_utils.pyi +2 -2
  161. metaflow-stubs/plugins/gcp/includefile_support.pyi +2 -2
  162. metaflow-stubs/plugins/kubernetes/__init__.pyi +2 -2
  163. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +3 -3
  164. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +4 -4
  165. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  166. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +8 -2
  167. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
  168. metaflow-stubs/plugins/kubernetes/spot_monitor_sidecar.pyi +2 -2
  169. metaflow-stubs/plugins/ollama/__init__.pyi +3 -3
  170. metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
  171. metaflow-stubs/plugins/perimeters.pyi +2 -2
  172. metaflow-stubs/plugins/project_decorator.pyi +2 -2
  173. metaflow-stubs/plugins/pypi/__init__.pyi +2 -2
  174. metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
  175. metaflow-stubs/plugins/pypi/conda_environment.pyi +4 -4
  176. metaflow-stubs/plugins/pypi/parsers.pyi +2 -2
  177. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
  178. metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
  179. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  180. metaflow-stubs/plugins/resources_decorator.pyi +2 -2
  181. metaflow-stubs/plugins/retry_decorator.pyi +2 -2
  182. metaflow-stubs/plugins/secrets/__init__.pyi +2 -2
  183. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +3 -3
  184. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
  185. metaflow-stubs/plugins/snowflake/__init__.pyi +2 -2
  186. metaflow-stubs/plugins/storage_executor.pyi +2 -2
  187. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +3 -3
  188. metaflow-stubs/plugins/timeout_decorator.pyi +2 -2
  189. metaflow-stubs/plugins/torchtune/__init__.pyi +2 -2
  190. metaflow-stubs/plugins/uv/__init__.pyi +2 -2
  191. metaflow-stubs/plugins/uv/uv_environment.pyi +3 -3
  192. metaflow-stubs/profilers/__init__.pyi +2 -2
  193. metaflow-stubs/pylint_wrapper.pyi +2 -2
  194. metaflow-stubs/runner/__init__.pyi +2 -2
  195. metaflow-stubs/runner/deployer.pyi +9 -6
  196. metaflow-stubs/runner/deployer_impl.pyi +6 -3
  197. metaflow-stubs/runner/metaflow_runner.pyi +7 -4
  198. metaflow-stubs/runner/nbdeploy.pyi +2 -2
  199. metaflow-stubs/runner/nbrun.pyi +2 -2
  200. metaflow-stubs/runner/subprocess_manager.pyi +2 -2
  201. metaflow-stubs/runner/utils.pyi +6 -3
  202. metaflow-stubs/system/__init__.pyi +2 -2
  203. metaflow-stubs/system/system_logger.pyi +2 -2
  204. metaflow-stubs/system/system_monitor.pyi +2 -2
  205. metaflow-stubs/tagging_util.pyi +2 -2
  206. metaflow-stubs/tuple_util.pyi +2 -2
  207. metaflow-stubs/user_configs/__init__.pyi +2 -2
  208. metaflow-stubs/user_configs/config_decorators.pyi +6 -6
  209. metaflow-stubs/user_configs/config_options.pyi +4 -4
  210. metaflow-stubs/user_configs/config_parameters.pyi +77 -17
  211. {ob_metaflow_stubs-6.0.3.176rc6.dist-info → ob_metaflow_stubs-6.0.3.178.dist-info}/METADATA +1 -1
  212. ob_metaflow_stubs-6.0.3.178.dist-info/RECORD +215 -0
  213. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/baker.pyi +0 -51
  214. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/docker_environment.pyi +0 -65
  215. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/fast_bakery.pyi +0 -74
  216. metaflow-stubs/ob_internal.pyi +0 -11
  217. ob_metaflow_stubs-6.0.3.176rc6.dist-info/RECORD +0 -218
  218. {ob_metaflow_stubs-6.0.3.176rc6.dist-info → ob_metaflow_stubs-6.0.3.178.dist-info}/WHEEL +0 -0
  219. {ob_metaflow_stubs-6.0.3.176rc6.dist-info → ob_metaflow_stubs-6.0.3.178.dist-info}/top_level.txt +0 -0
@@ -1,21 +1,21 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.328879 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.311171 #
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.metaflow_current
12
- import metaflow.plugins.cards.component_serializer
13
11
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
12
+ import metaflow.events
13
+ import typing
14
+ import metaflow.metaflow_current
14
15
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
15
- import metaflow
16
+ import metaflow.plugins.cards.component_serializer
16
17
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
17
- import typing
18
- import metaflow.events
18
+ import metaflow
19
19
 
20
20
 
21
21
  TYPE_CHECKING: bool
@@ -228,64 +228,64 @@ class Current(object, metaclass=type):
228
228
  def graph(self):
229
229
  ...
230
230
  @property
231
- def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
231
+ def model(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
232
232
  """
233
- (only in the presence of the @checkpoint decorator)
234
-
235
- The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
236
- The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
233
+ (only in the presence of the @model decorator)
237
234
 
238
- You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
239
- by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
240
- where the checkpoint maybe loaded or saved.
235
+ The object used for loading / saving models.
236
+ `current.model` exposes a `save` method to save models and a `load` method to load models.
237
+ `current.model.loaded` exposes the paths to the models loaded via the `load` argument in the @model decorator
238
+ or models loaded via `current.model.load`.
241
239
 
242
- Usage (Saving Checkpoints):
240
+ Usage (Saving a model):
243
241
  -------
242
+
244
243
  ```
245
- @checkpoint
244
+ @model
246
245
  @step
247
246
  def train(self):
248
- model = create_model(self.parameters, checkpoint_path = None)
249
- for i in range(self.epochs):
250
- # some training logic
251
- loss = model.train(self.dataset)
252
- if i % 10 == 0:
253
- model.save(
254
- current.checkpoint.directory,
255
- )
256
- # saves the contents of the `current.checkpoint.directory` as a checkpoint
257
- # and returns a reference dictionary to the checkpoint saved in the datastore
258
- self.latest_checkpoint = current.checkpoint.save(
259
- name="epoch_checkpoint",
260
- metadata={
261
- "epoch": i,
262
- "loss": loss,
263
- }
264
- )
247
+ # current.model.save returns a dictionary reference to the model saved
248
+ self.my_model = current.model.save(
249
+ path_to_my_model,
250
+ label="my_model",
251
+ metadata={
252
+ "epochs": 10,
253
+ "batch-size": 32,
254
+ "learning-rate": 0.001,
255
+ }
256
+ )
257
+ self.next(self.test)
258
+
259
+ @model(load="my_model")
260
+ @step
261
+ def test(self):
262
+ # `current.model.loaded` returns a dictionary of the loaded models
263
+ # where the key is the name of the artifact and the value is the path to the model
264
+ print(os.listdir(current.model.loaded["my_model"]))
265
+ self.next(self.end)
265
266
  ```
266
- Usage (Using Loaded Checkpoints):
267
+
268
+ Usage (Loading models):
267
269
  -------
270
+
268
271
  ```
269
- @retry(times=3)
270
- @checkpoint
271
272
  @step
272
273
  def train(self):
273
- # Assume that the task has restarted and the previous attempt of the task
274
- # saved a checkpoint
275
- checkpoint_path = None
276
- if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
277
- print("Loaded checkpoint from the previous attempt")
278
- checkpoint_path = current.checkpoint.directory
279
-
280
- model = create_model(self.parameters, checkpoint_path = checkpoint_path)
281
- for i in range(self.epochs):
282
- ...
274
+ # current.model.load returns the path to the model loaded
275
+ checkpoint_path = current.model.load(
276
+ self.checkpoint_key,
277
+ )
278
+ model_path = current.model.load(
279
+ self.model,
280
+ )
281
+ self.next(self.test)
283
282
  ```
284
283
 
284
+
285
285
  Returns
286
286
  -------
287
- CurrentCheckpointer
288
- The object for handling checkpointing within a step.
287
+ ModelSerializer
288
+ The object used for loading / saving models.
289
289
  """
290
290
  ...
291
291
  @property
@@ -376,64 +376,64 @@ class Current(object, metaclass=type):
376
376
  """
377
377
  ...
378
378
  @property
379
- def model(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
379
+ def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
380
380
  """
381
- (only in the presence of the @model decorator)
381
+ (only in the presence of the @checkpoint decorator)
382
382
 
383
- The object used for loading / saving models.
384
- `current.model` exposes a `save` method to save models and a `load` method to load models.
385
- `current.model.loaded` exposes the paths to the models loaded via the `load` argument in the @model decorator
386
- or models loaded via `current.model.load`.
383
+ The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
384
+ The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
387
385
 
388
- Usage (Saving a model):
389
- -------
386
+ You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
387
+ by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
388
+ where the checkpoint maybe loaded or saved.
390
389
 
390
+ Usage (Saving Checkpoints):
391
+ -------
391
392
  ```
392
- @model
393
+ @checkpoint
393
394
  @step
394
395
  def train(self):
395
- # current.model.save returns a dictionary reference to the model saved
396
- self.my_model = current.model.save(
397
- path_to_my_model,
398
- label="my_model",
399
- metadata={
400
- "epochs": 10,
401
- "batch-size": 32,
402
- "learning-rate": 0.001,
403
- }
404
- )
405
- self.next(self.test)
406
-
407
- @model(load="my_model")
408
- @step
409
- def test(self):
410
- # `current.model.loaded` returns a dictionary of the loaded models
411
- # where the key is the name of the artifact and the value is the path to the model
412
- print(os.listdir(current.model.loaded["my_model"]))
413
- self.next(self.end)
396
+ model = create_model(self.parameters, checkpoint_path = None)
397
+ for i in range(self.epochs):
398
+ # some training logic
399
+ loss = model.train(self.dataset)
400
+ if i % 10 == 0:
401
+ model.save(
402
+ current.checkpoint.directory,
403
+ )
404
+ # saves the contents of the `current.checkpoint.directory` as a checkpoint
405
+ # and returns a reference dictionary to the checkpoint saved in the datastore
406
+ self.latest_checkpoint = current.checkpoint.save(
407
+ name="epoch_checkpoint",
408
+ metadata={
409
+ "epoch": i,
410
+ "loss": loss,
411
+ }
412
+ )
414
413
  ```
415
-
416
- Usage (Loading models):
414
+ Usage (Using Loaded Checkpoints):
417
415
  -------
418
-
419
416
  ```
417
+ @retry(times=3)
418
+ @checkpoint
420
419
  @step
421
420
  def train(self):
422
- # current.model.load returns the path to the model loaded
423
- checkpoint_path = current.model.load(
424
- self.checkpoint_key,
425
- )
426
- model_path = current.model.load(
427
- self.model,
428
- )
429
- self.next(self.test)
430
- ```
421
+ # Assume that the task has restarted and the previous attempt of the task
422
+ # saved a checkpoint
423
+ checkpoint_path = None
424
+ if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
425
+ print("Loaded checkpoint from the previous attempt")
426
+ checkpoint_path = current.checkpoint.directory
431
427
 
428
+ model = create_model(self.parameters, checkpoint_path = checkpoint_path)
429
+ for i in range(self.epochs):
430
+ ...
431
+ ```
432
432
 
433
433
  Returns
434
434
  -------
435
- ModelSerializer
436
- The object used for loading / saving models.
435
+ CurrentCheckpointer
436
+ The object for handling checkpointing within a step.
437
437
  """
438
438
  ...
439
439
  @property
@@ -466,19 +466,6 @@ class Current(object, metaclass=type):
466
466
  """
467
467
  ...
468
468
  @property
469
- def trigger(self) -> "metaflow.events.Trigger":
470
- """
471
- (only in the presence of the @trigger_on_finish, or @trigger decorators)
472
-
473
- Returns `Trigger` if the current run is triggered by an event
474
-
475
- Returns
476
- -------
477
- Trigger
478
- `Trigger` if triggered by an event
479
- """
480
- ...
481
- @property
482
469
  def project_name(self) -> str:
483
470
  """
484
471
  (only in the presence of the @project decorator)
@@ -545,6 +532,19 @@ class Current(object, metaclass=type):
545
532
  True if the flow is deployed with `--production`.
546
533
  """
547
534
  ...
535
+ @property
536
+ def trigger(self) -> "metaflow.events.Trigger":
537
+ """
538
+ (only in the presence of the @trigger_on_finish, or @trigger decorators)
539
+
540
+ Returns `Trigger` if the current run is triggered by an event
541
+
542
+ Returns
543
+ -------
544
+ Trigger
545
+ `Trigger` if triggered by an event
546
+ """
547
+ ...
548
548
  ...
549
549
 
550
550
  current: Current
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.190441 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.171164 #
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.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.191771 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.172516 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.200942 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.181471 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.201003 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.181531 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.201057 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.181585 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.257898 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.239326 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.258471 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.239893 #
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.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.257951 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.239373 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,13 +1,13 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.299755 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.281846 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import metaflow
10
9
  import typing
10
+ import metaflow
11
11
  if typing.TYPE_CHECKING:
12
12
  import metaflow.plugins.cards.card_modules.components
13
13
  import metaflow.plugins.cards.card_modules.card
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.201111 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.181638 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.259252 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.240677 #
5
5
  ######################################################################################################
6
6
 
@@ -1,18 +1,18 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.259301 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.240727 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import metaflow
10
9
  import threading
11
10
  import typing
11
+ import metaflow
12
12
  if typing.TYPE_CHECKING:
13
13
  import threading
14
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.card_utils.async_cards
15
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
15
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.card_utils.async_cards
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.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.259662 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.241077 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,18 +1,18 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.298877 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.281090 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import metaflow
10
9
  import typing
10
+ import metaflow
11
11
  if typing.TYPE_CHECKING:
12
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
13
13
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
14
- import metaflow.datastore.datastore_storage
15
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
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
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.228858 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.210434 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,17 +1,17 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.257029 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.238452 #
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
12
11
  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.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
14
+ import metaflow
15
15
 
16
16
  from ......metaflow_current import current as current
17
17
  from ......exception import MetaflowException as MetaflowException
@@ -1,18 +1,18 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.231006 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.212662 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import metaflow
10
9
  import typing
10
+ import metaflow
11
11
  if typing.TYPE_CHECKING:
12
- import os
13
- import metaflow
14
12
  import metaflow.decorators
15
13
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
14
+ import metaflow
15
+ import os
16
16
 
17
17
  from .exceptions import CheckpointException as CheckpointException
18
18
  from ..utils import flowspec_utils as flowspec_utils
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.229075 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.210654 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,15 +1,15 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.201160 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.181684 #
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
12
11
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
12
+ import metaflow
13
13
 
14
14
  from ..datastructures import CheckpointArtifact as CheckpointArtifact
15
15
  from .constructors import load_checkpoint as load_checkpoint
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.259938 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.241359 #
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.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.202739 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.183270 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.202787 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.183320 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,9 +9,9 @@ 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.datastore.context
12
13
  import metaflow
13
14
  import metaflow.exception
14
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.context
15
15
 
16
16
  from ......exception import MetaflowException as MetaflowException
17
17
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-04T22:04:18.261486 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:34:09.242880 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -136,7 +136,7 @@ class ObjectStorage(object, metaclass=type):
136
136
  ...
137
137
  def get_file(self, key):
138
138
  ...
139
- def list_paths(self, keys, recursive = False) -> typing.Iterator[ListPathResult]:
139
+ def list_paths(self, keys, recursive = False) -> typing.Iterator[metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core.ListPathResult]:
140
140
  """
141
141
  List all objects in the datastore's `keys` index.
142
142
  """