ob-metaflow-stubs 6.0.3.177__py2.py3-none-any.whl → 6.0.3.179rc0__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 (220) hide show
  1. metaflow-stubs/__init__.pyi +727 -722
  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 +2 -2
  9. metaflow-stubs/events.pyi +6 -6
  10. metaflow-stubs/exception.pyi +2 -2
  11. metaflow-stubs/flowspec.pyi +6 -6
  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 +126 -126
  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 +4 -4
  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 +5 -5
  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 +4 -4
  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 +2 -2
  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/aws/__init__.pyi +2 -2
  67. metaflow-stubs/mf_extensions/outerbounds/plugins/aws/assume_role_decorator.pyi +2 -2
  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/fast_bakery/__init__.pyi +6 -0
  75. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/baker.pyi +51 -0
  76. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/docker_environment.pyi +65 -0
  77. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/fast_bakery.pyi +74 -0
  78. metaflow-stubs/mf_extensions/outerbounds/plugins/kubernetes/__init__.pyi +2 -2
  79. metaflow-stubs/mf_extensions/outerbounds/plugins/kubernetes/pod_killer.pyi +2 -2
  80. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/__init__.pyi +2 -2
  81. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/constants.pyi +2 -2
  82. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/exceptions.pyi +2 -2
  83. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/ollama.pyi +2 -2
  84. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/status_card.pyi +2 -2
  85. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/__init__.pyi +2 -2
  86. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/snowflake.pyi +2 -2
  87. metaflow-stubs/mf_extensions/outerbounds/profilers/__init__.pyi +2 -2
  88. metaflow-stubs/mf_extensions/outerbounds/profilers/gpu.pyi +2 -2
  89. metaflow-stubs/mf_extensions/outerbounds/remote_config.pyi +2 -2
  90. metaflow-stubs/mf_extensions/outerbounds/toplevel/__init__.pyi +2 -2
  91. metaflow-stubs/mf_extensions/outerbounds/toplevel/global_aliases_for_metaflow_package.pyi +3 -2
  92. metaflow-stubs/multicore_utils.pyi +2 -2
  93. metaflow-stubs/ob_internal.pyi +11 -0
  94. metaflow-stubs/parameters.pyi +5 -5
  95. metaflow-stubs/plugins/__init__.pyi +10 -10
  96. metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
  97. metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
  98. metaflow-stubs/plugins/airflow/exception.pyi +2 -2
  99. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
  100. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
  101. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +2 -2
  102. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +2 -2
  103. metaflow-stubs/plugins/argo/__init__.pyi +2 -2
  104. metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
  105. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  106. metaflow-stubs/plugins/argo/argo_workflows.pyi +5 -3
  107. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +3 -3
  108. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  109. metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +5 -7
  110. metaflow-stubs/plugins/aws/__init__.pyi +2 -2
  111. metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
  112. metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
  113. metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
  114. metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
  115. metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
  116. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +2 -2
  117. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
  118. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +2 -2
  119. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +2 -2
  120. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +2 -2
  121. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +2 -2
  122. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +2 -2
  123. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +2 -2
  124. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +4 -4
  125. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +5 -5
  126. metaflow-stubs/plugins/azure/__init__.pyi +2 -2
  127. metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
  128. metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
  129. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +2 -2
  130. metaflow-stubs/plugins/azure/azure_utils.pyi +2 -2
  131. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +2 -2
  132. metaflow-stubs/plugins/azure/includefile_support.pyi +2 -2
  133. metaflow-stubs/plugins/cards/__init__.pyi +6 -6
  134. metaflow-stubs/plugins/cards/card_client.pyi +2 -2
  135. metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
  136. metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
  137. metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
  138. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
  139. metaflow-stubs/plugins/cards/card_modules/basic.pyi +2 -2
  140. metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
  141. metaflow-stubs/plugins/cards/card_modules/components.pyi +4 -4
  142. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
  143. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
  144. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +2 -2
  145. metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
  146. metaflow-stubs/plugins/cards/component_serializer.pyi +2 -2
  147. metaflow-stubs/plugins/cards/exception.pyi +2 -2
  148. metaflow-stubs/plugins/catch_decorator.pyi +2 -2
  149. metaflow-stubs/plugins/datatools/__init__.pyi +2 -2
  150. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  151. metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
  152. metaflow-stubs/plugins/datatools/s3/s3.pyi +16 -16
  153. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
  154. metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
  155. metaflow-stubs/plugins/debug_logger.pyi +2 -2
  156. metaflow-stubs/plugins/debug_monitor.pyi +2 -2
  157. metaflow-stubs/plugins/environment_decorator.pyi +2 -2
  158. metaflow-stubs/plugins/events_decorator.pyi +2 -2
  159. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  160. metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
  161. metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
  162. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +2 -2
  163. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +2 -2
  164. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +2 -2
  165. metaflow-stubs/plugins/gcp/gs_utils.pyi +2 -2
  166. metaflow-stubs/plugins/gcp/includefile_support.pyi +2 -2
  167. metaflow-stubs/plugins/kubernetes/__init__.pyi +2 -2
  168. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +3 -3
  169. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +4 -4
  170. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  171. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +8 -2
  172. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
  173. metaflow-stubs/plugins/kubernetes/spot_monitor_sidecar.pyi +2 -2
  174. metaflow-stubs/plugins/ollama/__init__.pyi +2 -2
  175. metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
  176. metaflow-stubs/plugins/perimeters.pyi +2 -2
  177. metaflow-stubs/plugins/project_decorator.pyi +2 -2
  178. metaflow-stubs/plugins/pypi/__init__.pyi +3 -3
  179. metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
  180. metaflow-stubs/plugins/pypi/conda_environment.pyi +5 -5
  181. metaflow-stubs/plugins/pypi/parsers.pyi +2 -2
  182. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
  183. metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
  184. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  185. metaflow-stubs/plugins/resources_decorator.pyi +2 -2
  186. metaflow-stubs/plugins/retry_decorator.pyi +2 -2
  187. metaflow-stubs/plugins/secrets/__init__.pyi +2 -2
  188. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +2 -2
  189. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
  190. metaflow-stubs/plugins/snowflake/__init__.pyi +2 -2
  191. metaflow-stubs/plugins/storage_executor.pyi +2 -2
  192. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +3 -3
  193. metaflow-stubs/plugins/timeout_decorator.pyi +2 -2
  194. metaflow-stubs/plugins/torchtune/__init__.pyi +2 -2
  195. metaflow-stubs/plugins/uv/__init__.pyi +2 -2
  196. metaflow-stubs/plugins/uv/uv_environment.pyi +3 -3
  197. metaflow-stubs/profilers/__init__.pyi +2 -2
  198. metaflow-stubs/pylint_wrapper.pyi +2 -2
  199. metaflow-stubs/runner/__init__.pyi +2 -2
  200. metaflow-stubs/runner/deployer.pyi +8 -5
  201. metaflow-stubs/runner/deployer_impl.pyi +5 -2
  202. metaflow-stubs/runner/metaflow_runner.pyi +8 -5
  203. metaflow-stubs/runner/nbdeploy.pyi +2 -2
  204. metaflow-stubs/runner/nbrun.pyi +2 -2
  205. metaflow-stubs/runner/subprocess_manager.pyi +2 -2
  206. metaflow-stubs/runner/utils.pyi +6 -3
  207. metaflow-stubs/system/__init__.pyi +2 -2
  208. metaflow-stubs/system/system_logger.pyi +3 -3
  209. metaflow-stubs/system/system_monitor.pyi +2 -2
  210. metaflow-stubs/tagging_util.pyi +2 -2
  211. metaflow-stubs/tuple_util.pyi +2 -2
  212. metaflow-stubs/user_configs/__init__.pyi +2 -2
  213. metaflow-stubs/user_configs/config_decorators.pyi +7 -7
  214. metaflow-stubs/user_configs/config_options.pyi +3 -3
  215. metaflow-stubs/user_configs/config_parameters.pyi +77 -17
  216. {ob_metaflow_stubs-6.0.3.177.dist-info → ob_metaflow_stubs-6.0.3.179rc0.dist-info}/METADATA +1 -1
  217. ob_metaflow_stubs-6.0.3.179rc0.dist-info/RECORD +220 -0
  218. ob_metaflow_stubs-6.0.3.177.dist-info/RECORD +0 -215
  219. {ob_metaflow_stubs-6.0.3.177.dist-info → ob_metaflow_stubs-6.0.3.179rc0.dist-info}/WHEEL +0 -0
  220. {ob_metaflow_stubs-6.0.3.177.dist-info → ob_metaflow_stubs-6.0.3.179rc0.dist-info}/top_level.txt +0 -0
@@ -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-10T19:56:51.890940 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.255684 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,11 +9,11 @@ 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.hf_hub.decorator
12
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
12
13
  import typing
13
14
  import metaflow.plugins.cards.component_serializer
14
15
  import metaflow.metaflow_current
15
16
  import metaflow.events
16
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
17
17
  import metaflow
18
18
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
19
19
 
@@ -228,21 +228,64 @@ 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":
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 @card decorator)
233
+ (only in the presence of the @model decorator)
234
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].
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`.
239
+
240
+ Usage (Saving a model):
241
+ -------
242
+
243
+ ```
244
+ @model
245
+ @step
246
+ def train(self):
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)
266
+ ```
267
+
268
+ Usage (Loading models):
269
+ -------
270
+
271
+ ```
272
+ @step
273
+ def train(self):
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)
282
+ ```
239
283
 
240
- Methods available are `append` and `extend`
241
284
 
242
285
  Returns
243
286
  -------
244
- CardComponentCollector
245
- The or one of the cards attached to this step.
287
+ ModelSerializer
288
+ The object used for loading / saving models.
246
289
  """
247
290
  ...
248
291
  @property
@@ -275,67 +318,6 @@ class Current(object, metaclass=type):
275
318
  """
276
319
  ...
277
320
  @property
278
- def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
279
- """
280
- (only in the presence of the @checkpoint decorator)
281
-
282
- The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
283
- The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
284
-
285
- You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
286
- by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
287
- where the checkpoint maybe loaded or saved.
288
-
289
- Usage (Saving Checkpoints):
290
- -------
291
- ```
292
- @checkpoint
293
- @step
294
- def train(self):
295
- model = create_model(self.parameters, checkpoint_path = None)
296
- for i in range(self.epochs):
297
- # some training logic
298
- loss = model.train(self.dataset)
299
- if i % 10 == 0:
300
- model.save(
301
- current.checkpoint.directory,
302
- )
303
- # saves the contents of the `current.checkpoint.directory` as a checkpoint
304
- # and returns a reference dictionary to the checkpoint saved in the datastore
305
- self.latest_checkpoint = current.checkpoint.save(
306
- name="epoch_checkpoint",
307
- metadata={
308
- "epoch": i,
309
- "loss": loss,
310
- }
311
- )
312
- ```
313
- Usage (Using Loaded Checkpoints):
314
- -------
315
- ```
316
- @retry(times=3)
317
- @checkpoint
318
- @step
319
- def train(self):
320
- # Assume that the task has restarted and the previous attempt of the task
321
- # saved a checkpoint
322
- checkpoint_path = None
323
- if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
324
- print("Loaded checkpoint from the previous attempt")
325
- checkpoint_path = current.checkpoint.directory
326
-
327
- model = create_model(self.parameters, checkpoint_path = checkpoint_path)
328
- for i in range(self.epochs):
329
- ...
330
- ```
331
-
332
- Returns
333
- -------
334
- CurrentCheckpointer
335
- The object for handling checkpointing within a step.
336
- """
337
- ...
338
- @property
339
321
  def huggingface_hub(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
340
322
  """
341
323
  (only in the presence of the @huggingface_hub decorator)
@@ -405,64 +387,95 @@ class Current(object, metaclass=type):
405
387
  """
406
388
  ...
407
389
  @property
408
- def model(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
390
+ def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
409
391
  """
410
- (only in the presence of the @model decorator)
392
+ (only in the presence of the @card decorator)
411
393
 
412
- The object used for loading / saving models.
413
- `current.model` exposes a `save` method to save models and a `load` method to load models.
414
- `current.model.loaded` exposes the paths to the models loaded via the `load` argument in the @model decorator
415
- or models loaded via `current.model.load`.
394
+ The `@card` decorator makes the cards available through the `current.card`
395
+ object. If multiple `@card` decorators are present, you can add an `ID` to
396
+ distinguish between them using `@card(id=ID)` as the decorator. You will then
397
+ be able to access that specific card using `current.card[ID].
416
398
 
417
- Usage (Saving a model):
399
+ Methods available are `append` and `extend`
400
+
401
+ Returns
418
402
  -------
403
+ CardComponentCollector
404
+ The or one of the cards attached to this step.
405
+ """
406
+ ...
407
+ @property
408
+ def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
409
+ """
410
+ (only in the presence of the @checkpoint decorator)
411
+
412
+ The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
413
+ The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
414
+
415
+ You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
416
+ by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
417
+ where the checkpoint maybe loaded or saved.
419
418
 
419
+ Usage (Saving Checkpoints):
420
+ -------
420
421
  ```
421
- @model
422
+ @checkpoint
422
423
  @step
423
424
  def train(self):
424
- # current.model.save returns a dictionary reference to the model saved
425
- self.my_model = current.model.save(
426
- path_to_my_model,
427
- label="my_model",
428
- metadata={
429
- "epochs": 10,
430
- "batch-size": 32,
431
- "learning-rate": 0.001,
432
- }
433
- )
434
- self.next(self.test)
435
-
436
- @model(load="my_model")
437
- @step
438
- def test(self):
439
- # `current.model.loaded` returns a dictionary of the loaded models
440
- # where the key is the name of the artifact and the value is the path to the model
441
- print(os.listdir(current.model.loaded["my_model"]))
442
- self.next(self.end)
425
+ model = create_model(self.parameters, checkpoint_path = None)
426
+ for i in range(self.epochs):
427
+ # some training logic
428
+ loss = model.train(self.dataset)
429
+ if i % 10 == 0:
430
+ model.save(
431
+ current.checkpoint.directory,
432
+ )
433
+ # saves the contents of the `current.checkpoint.directory` as a checkpoint
434
+ # and returns a reference dictionary to the checkpoint saved in the datastore
435
+ self.latest_checkpoint = current.checkpoint.save(
436
+ name="epoch_checkpoint",
437
+ metadata={
438
+ "epoch": i,
439
+ "loss": loss,
440
+ }
441
+ )
443
442
  ```
444
-
445
- Usage (Loading models):
443
+ Usage (Using Loaded Checkpoints):
446
444
  -------
447
-
448
445
  ```
446
+ @retry(times=3)
447
+ @checkpoint
449
448
  @step
450
449
  def train(self):
451
- # current.model.load returns the path to the model loaded
452
- checkpoint_path = current.model.load(
453
- self.checkpoint_key,
454
- )
455
- model_path = current.model.load(
456
- self.model,
457
- )
458
- self.next(self.test)
450
+ # Assume that the task has restarted and the previous attempt of the task
451
+ # saved a checkpoint
452
+ checkpoint_path = None
453
+ if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
454
+ print("Loaded checkpoint from the previous attempt")
455
+ checkpoint_path = current.checkpoint.directory
456
+
457
+ model = create_model(self.parameters, checkpoint_path = checkpoint_path)
458
+ for i in range(self.epochs):
459
+ ...
459
460
  ```
460
461
 
462
+ Returns
463
+ -------
464
+ CurrentCheckpointer
465
+ The object for handling checkpointing within a step.
466
+ """
467
+ ...
468
+ @property
469
+ def trigger(self) -> "metaflow.events.Trigger":
470
+ """
471
+ (only in the presence of the @trigger, or @trigger_on_finish decorators)
472
+
473
+ Returns `Trigger` if the current run is triggered by an event
461
474
 
462
475
  Returns
463
476
  -------
464
- ModelSerializer
465
- The object used for loading / saving models.
477
+ Trigger
478
+ `Trigger` if triggered by an event
466
479
  """
467
480
  ...
468
481
  @property
@@ -532,19 +545,6 @@ class Current(object, metaclass=type):
532
545
  True if the flow is deployed with `--production`.
533
546
  """
534
547
  ...
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-10T19:56:51.748919 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.098086 #
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-10T19:56:51.750998 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.100086 #
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-10T19:56:51.760055 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.110652 #
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-10T19:56:51.760114 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.110753 #
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-10T19:56:51.760168 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.110848 #
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-10T19:56:51.816624 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.179504 #
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-10T19:56:51.817213 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.180115 #
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-10T19:56:51.816671 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.179556 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,16 +1,16 @@
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-10T19:56:51.860471 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.223386 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import typing
10
9
  import metaflow
10
+ import typing
11
11
  if typing.TYPE_CHECKING:
12
- import metaflow.plugins.cards.card_modules.card
13
12
  import metaflow.plugins.cards.card_modules.components
13
+ import metaflow.plugins.cards.card_modules.card
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.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-10T19:56:51.760221 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.110940 #
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-10T19:56:51.817996 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.180876 #
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-10T19:56:51.818054 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.180924 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import threading
10
- import typing
11
10
  import metaflow
11
+ import typing
12
12
  if typing.TYPE_CHECKING:
13
- import threading
14
13
  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 threading
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-10T19:56:51.818442 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.181414 #
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-10T19:56:51.859537 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.222472 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import typing
10
9
  import metaflow
10
+ import typing
11
11
  if typing.TYPE_CHECKING:
12
- import metaflow.datastore.datastore_storage
13
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
14
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
+ import metaflow.datastore.datastore_storage
15
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
15
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
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-10T19:56:51.788007 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.148810 #
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-10T19:56:51.815744 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.178595 #
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
13
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
14
13
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.core
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-10T19:56:51.790321 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.151095 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import typing
10
9
  import metaflow
10
+ import typing
11
11
  if typing.TYPE_CHECKING:
12
+ import os
12
13
  import metaflow.decorators
13
14
  import metaflow
14
15
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
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-10T19:56:51.788237 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.149035 #
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-10T19:56:51.760261 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.111012 #
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-10T19:56:51.818727 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.181686 #
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-10T19:56:51.761821 #
3
+ # MF version: 2.15.17.1+obcheckpoint(0.2.1);ob(v1) #
4
+ # Generated on 2025-06-13T18:47:55.113986 #
5
5
  ######################################################################################################
6
6