ob-metaflow-stubs 6.0.3.185__py2.py3-none-any.whl → 6.0.3.186__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 (216) hide show
  1. metaflow-stubs/__init__.pyi +955 -738
  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 +5 -5
  8. metaflow-stubs/client/filecache.pyi +3 -3
  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 +2 -2
  18. metaflow-stubs/metadata_provider/util.pyi +2 -2
  19. metaflow-stubs/metaflow_config.pyi +2 -2
  20. metaflow-stubs/metaflow_current.pyi +37 -185
  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 +3 -3
  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 +3 -3
  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 +50 -48
  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 +10 -14
  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 +2 -2
  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 +2 -2
  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 +86 -2
  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 +78 -75
  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 +48 -13
  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 +2 -2
  63. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/tar_utils.pyi +2 -2
  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/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 +2 -2
  88. metaflow-stubs/multicore_utils.pyi +2 -2
  89. metaflow-stubs/ob_internal.pyi +2 -2
  90. metaflow-stubs/parameters.pyi +3 -3
  91. metaflow-stubs/plugins/__init__.pyi +10 -10
  92. metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
  93. metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
  94. metaflow-stubs/plugins/airflow/exception.pyi +2 -2
  95. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
  96. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
  97. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +2 -2
  98. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +2 -2
  99. metaflow-stubs/plugins/argo/__init__.pyi +2 -2
  100. metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
  101. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  102. metaflow-stubs/plugins/argo/argo_workflows.pyi +2 -2
  103. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +3 -3
  104. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  105. metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +3 -3
  106. metaflow-stubs/plugins/aws/__init__.pyi +2 -2
  107. metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
  108. metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
  109. metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
  110. metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
  111. metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
  112. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +2 -2
  113. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
  114. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +3 -3
  115. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +2 -2
  116. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +2 -2
  117. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +2 -2
  118. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +2 -2
  119. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +2 -2
  120. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +3 -3
  121. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +2 -2
  122. metaflow-stubs/plugins/azure/__init__.pyi +2 -2
  123. metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
  124. metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
  125. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +3 -3
  126. metaflow-stubs/plugins/azure/azure_utils.pyi +2 -2
  127. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +2 -2
  128. metaflow-stubs/plugins/azure/includefile_support.pyi +2 -2
  129. metaflow-stubs/plugins/cards/__init__.pyi +2 -2
  130. metaflow-stubs/plugins/cards/card_client.pyi +3 -3
  131. metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
  132. metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
  133. metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
  134. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
  135. metaflow-stubs/plugins/cards/card_modules/basic.pyi +3 -3
  136. metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
  137. metaflow-stubs/plugins/cards/card_modules/components.pyi +3 -3
  138. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
  139. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
  140. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +2 -2
  141. metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
  142. metaflow-stubs/plugins/cards/component_serializer.pyi +2 -2
  143. metaflow-stubs/plugins/cards/exception.pyi +2 -2
  144. metaflow-stubs/plugins/catch_decorator.pyi +3 -3
  145. metaflow-stubs/plugins/datatools/__init__.pyi +2 -2
  146. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  147. metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
  148. metaflow-stubs/plugins/datatools/s3/s3.pyi +3 -3
  149. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
  150. metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
  151. metaflow-stubs/plugins/debug_logger.pyi +2 -2
  152. metaflow-stubs/plugins/debug_monitor.pyi +2 -2
  153. metaflow-stubs/plugins/environment_decorator.pyi +2 -2
  154. metaflow-stubs/plugins/events_decorator.pyi +2 -2
  155. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  156. metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
  157. metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
  158. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +3 -3
  159. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +2 -2
  160. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +2 -2
  161. metaflow-stubs/plugins/gcp/gs_utils.pyi +2 -2
  162. metaflow-stubs/plugins/gcp/includefile_support.pyi +2 -2
  163. metaflow-stubs/plugins/kubernetes/__init__.pyi +2 -2
  164. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +2 -2
  165. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +2 -2
  166. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  167. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +2 -2
  168. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
  169. metaflow-stubs/plugins/kubernetes/spot_monitor_sidecar.pyi +2 -2
  170. metaflow-stubs/plugins/ollama/__init__.pyi +3 -3
  171. metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
  172. metaflow-stubs/plugins/perimeters.pyi +2 -2
  173. metaflow-stubs/plugins/project_decorator.pyi +2 -2
  174. metaflow-stubs/plugins/pypi/__init__.pyi +2 -2
  175. metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
  176. metaflow-stubs/plugins/pypi/conda_environment.pyi +5 -5
  177. metaflow-stubs/plugins/pypi/parsers.pyi +2 -2
  178. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
  179. metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
  180. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  181. metaflow-stubs/plugins/resources_decorator.pyi +2 -2
  182. metaflow-stubs/plugins/retry_decorator.pyi +2 -2
  183. metaflow-stubs/plugins/secrets/__init__.pyi +2 -2
  184. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +3 -3
  185. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
  186. metaflow-stubs/plugins/snowflake/__init__.pyi +2 -2
  187. metaflow-stubs/plugins/storage_executor.pyi +2 -2
  188. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +3 -3
  189. metaflow-stubs/plugins/timeout_decorator.pyi +3 -3
  190. metaflow-stubs/plugins/torchtune/__init__.pyi +2 -2
  191. metaflow-stubs/plugins/uv/__init__.pyi +2 -2
  192. metaflow-stubs/plugins/uv/uv_environment.pyi +2 -2
  193. metaflow-stubs/profilers/__init__.pyi +2 -2
  194. metaflow-stubs/pylint_wrapper.pyi +2 -2
  195. metaflow-stubs/runner/__init__.pyi +2 -2
  196. metaflow-stubs/runner/deployer.pyi +28 -28
  197. metaflow-stubs/runner/deployer_impl.pyi +2 -2
  198. metaflow-stubs/runner/metaflow_runner.pyi +3 -3
  199. metaflow-stubs/runner/nbdeploy.pyi +2 -2
  200. metaflow-stubs/runner/nbrun.pyi +2 -2
  201. metaflow-stubs/runner/subprocess_manager.pyi +2 -2
  202. metaflow-stubs/runner/utils.pyi +3 -3
  203. metaflow-stubs/system/__init__.pyi +2 -2
  204. metaflow-stubs/system/system_logger.pyi +2 -2
  205. metaflow-stubs/system/system_monitor.pyi +2 -2
  206. metaflow-stubs/tagging_util.pyi +2 -2
  207. metaflow-stubs/tuple_util.pyi +2 -2
  208. metaflow-stubs/user_configs/__init__.pyi +2 -2
  209. metaflow-stubs/user_configs/config_decorators.pyi +6 -6
  210. metaflow-stubs/user_configs/config_options.pyi +2 -2
  211. metaflow-stubs/user_configs/config_parameters.pyi +5 -5
  212. {ob_metaflow_stubs-6.0.3.185.dist-info → ob_metaflow_stubs-6.0.3.186.dist-info}/METADATA +1 -1
  213. ob_metaflow_stubs-6.0.3.186.dist-info/RECORD +216 -0
  214. ob_metaflow_stubs-6.0.3.185.dist-info/RECORD +0 -216
  215. {ob_metaflow_stubs-6.0.3.185.dist-info → ob_metaflow_stubs-6.0.3.186.dist-info}/WHEEL +0 -0
  216. {ob_metaflow_stubs-6.0.3.185.dist-info → ob_metaflow_stubs-6.0.3.186.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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.175333 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.080043 #
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.15.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.062160 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:32.983509 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.126493 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.038802 #
5
5
  ######################################################################################################
6
6
 
@@ -1,14 +1,14 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.126549 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.038850 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
+ import threading
9
10
  import typing
10
11
  import metaflow
11
- import threading
12
12
  if typing.TYPE_CHECKING:
13
13
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
14
14
  import threading
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.126928 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.039222 #
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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.174299 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.079005 #
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.checkpoints.checkpoint_storage
13
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
14
13
  import metaflow.datastore.datastore_storage
15
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.093759 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.010016 #
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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.124051 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.036608 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,8 +9,8 @@ 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.checkpoints.checkpoint_storage
12
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
12
  import metaflow
13
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
14
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.core
15
15
 
16
16
  from ......metaflow_current import current as current
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.096329 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.012191 #
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 os
13
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
14
- import metaflow
15
13
  import metaflow.decorators
14
+ import metaflow
15
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
16
16
 
17
17
  from .exceptions import CheckpointException as CheckpointException
18
18
  from ..utils import flowspec_utils as flowspec_utils
@@ -210,6 +210,51 @@ class CheckpointDecorator(metaflow.decorators.StepDecorator, metaclass=type):
210
210
  """
211
211
  Enables checkpointing for a step.
212
212
 
213
+ > Examples
214
+
215
+ - Saving Checkpoints
216
+
217
+ ```python
218
+ @checkpoint
219
+ @step
220
+ def train(self):
221
+ model = create_model(self.parameters, checkpoint_path = None)
222
+ for i in range(self.epochs):
223
+ # some training logic
224
+ loss = model.train(self.dataset)
225
+ if i % 10 == 0:
226
+ model.save(
227
+ current.checkpoint.directory,
228
+ )
229
+ # saves the contents of the `current.checkpoint.directory` as a checkpoint
230
+ # and returns a reference dictionary to the checkpoint saved in the datastore
231
+ self.latest_checkpoint = current.checkpoint.save(
232
+ name="epoch_checkpoint",
233
+ metadata={
234
+ "epoch": i,
235
+ "loss": loss,
236
+ }
237
+ )
238
+ ```
239
+
240
+ - Using Loaded Checkpoints
241
+
242
+ ```python
243
+ @retry(times=3)
244
+ @checkpoint
245
+ @step
246
+ def train(self):
247
+ # Assume that the task has restarted and the previous attempt of the task
248
+ # saved a checkpoint
249
+ checkpoint_path = None
250
+ if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
251
+ print("Loaded checkpoint from the previous attempt")
252
+ checkpoint_path = current.checkpoint.directory
253
+
254
+ model = create_model(self.parameters, checkpoint_path = checkpoint_path)
255
+ for i in range(self.epochs):
256
+ ...
257
+ ```
213
258
 
214
259
  Parameters
215
260
  ----------
@@ -238,51 +283,8 @@ class CheckpointDecorator(metaflow.decorators.StepDecorator, metaclass=type):
238
283
  by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
239
284
  where the checkpoint maybe loaded or saved.
240
285
 
241
- Usage (Saving Checkpoints):
242
- -------
243
- ```
244
- @checkpoint
245
- @step
246
- def train(self):
247
- model = create_model(self.parameters, checkpoint_path = None)
248
- for i in range(self.epochs):
249
- # some training logic
250
- loss = model.train(self.dataset)
251
- if i % 10 == 0:
252
- model.save(
253
- current.checkpoint.directory,
254
- )
255
- # saves the contents of the `current.checkpoint.directory` as a checkpoint
256
- # and returns a reference dictionary to the checkpoint saved in the datastore
257
- self.latest_checkpoint = current.checkpoint.save(
258
- name="epoch_checkpoint",
259
- metadata={
260
- "epoch": i,
261
- "loss": loss,
262
- }
263
- )
264
- ```
265
- Usage (Using Loaded Checkpoints):
266
- -------
267
- ```
268
- @retry(times=3)
269
- @checkpoint
270
- @step
271
- def train(self):
272
- # Assume that the task has restarted and the previous attempt of the task
273
- # saved a checkpoint
274
- checkpoint_path = None
275
- if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
276
- print("Loaded checkpoint from the previous attempt")
277
- checkpoint_path = current.checkpoint.directory
278
-
279
- model = create_model(self.parameters, checkpoint_path = checkpoint_path)
280
- for i in range(self.epochs):
281
- ...
282
- ```
283
-
284
286
  @@ Returns
285
- -------
287
+ ----------
286
288
  CurrentCheckpointer
287
289
  The object for handling checkpointing within a step.
288
290
  """
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.093995 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.010231 #
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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.062212 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:32.983551 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -30,7 +30,10 @@ class Checkpoint(object, metaclass=type):
30
30
  def __init__(self, temp_dir_root = None, init_dir = False):
31
31
  ...
32
32
  @property
33
- def directory(self):
33
+ def directory(self) -> typing.Optional[str]:
34
+ """
35
+ The directory where a checkpoint is loaded
36
+ """
34
37
  ...
35
38
  def save(self, path = None, metadata = None, latest = True, name = 'mfchckpt', storage_format = 'files') -> typing.Dict:
36
39
  """
@@ -73,19 +76,12 @@ class Checkpoint(object, metaclass=type):
73
76
  """
74
77
  lists the checkpoints in the current task or the specified task.
75
78
 
76
- When users call `list` without any arguments, it will list all the checkpoints in the currently executing
77
- task (this includes all attempts). If the `list` method is called without any arguments outside a Metaflow Task execution context,
78
- it will raise an exception. Users can also call `list` with `attempt` argument to list all checkpoints within a
79
- the specific attempt of the currently executing task.
79
+ When users call `list` without any arguments, it will list all the checkpoints in the currently executing task (this includes all attempts). If the `list` method is called without any arguments outside a Metaflow Task execution context, it will raise an exception. Users can also call `list` with `attempt` argument to list all checkpoints within a the specific attempt of the currently executing task.
80
80
 
81
- When a `task` argument is provided, the `list` method will return all the checkpoints
82
- for a task's latest attempt unless a specific attempt number is set in the `attempt` argument.
83
- If the `Task` object contains a `DataArtifact` with all the previous checkpoints, then the `list` method will return
84
- all the checkpoints from the data artifact. If for some reason the DataArtifact is not written, then the `list` method will
85
- return all checkpoints directly from the checkpoint's datastore.
81
+ When a `task` argument is provided, the `list` method will return all the checkpoints for a task's latest attempt unless a specific attempt number is set in the `attempt` argument. If the `Task` object contains a `DataArtifact` with all the previous checkpoints, then the `list` method will return all the checkpoints from the data artifact. If for some reason the DataArtifact is not written, then the `list` method will return all checkpoints directly from the checkpoint's datastore.
86
82
 
87
- Usage:
88
- ------
83
+ Examples
84
+ --------
89
85
 
90
86
  ```python
91
87
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.127205 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.039475 #
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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.063954 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:32.985174 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.064007 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:32.985225 #
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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.128917 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.041037 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
12
11
  import metaflow.datastore.datastore_storage
12
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
13
13
 
14
14
  from ......exception import MetaflowException as MetaflowException
15
15
  from ..utils.tar_utils import create_tarball_on_disk as create_tarball_on_disk
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.127595 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.039826 #
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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.193529 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.095079 #
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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.094777 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.010909 #
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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.130214 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.042199 #
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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.063227 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:32.984519 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -111,5 +111,89 @@ class Factory(object, metaclass=type):
111
111
  ...
112
112
 
113
113
  def load_model(reference: typing.Union[str, metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.MetaflowDataArtifactReference, dict], path: str):
114
+ """
115
+ Load a model or checkpoint from Metaflow's datastore to a local path.
116
+
117
+ This function provides a convenient way to load models and checkpoints that were previously saved using `@model`, `@checkpoint`, or `@huggingface_hub` decorators, either from within a Metaflow task or externally using the Run API.
118
+
119
+ Parameters
120
+ ----------
121
+ reference : Union[str, MetaflowDataArtifactReference, dict]
122
+ The reference to the model/checkpoint to load. This can be A string key (e.g., "model/my_model_abc123") OR A MetaflowDataArtifactReference object OR a dictionary artifact reference (e.g., self.my_model from a previous step)
123
+ path : str
124
+ The local filesystem path where the model/checkpoint should be loaded. The directory will be created if it doesn't exist.
125
+
126
+ Raises
127
+ ------
128
+ ValueError
129
+ If reference or path is None
130
+ KeyNotCompatibleException
131
+ If the reference key is not compatible with supported artifact types
132
+
133
+ Examples
134
+ --------
135
+ **Loading within a Metaflow task:**
136
+
137
+ ```python
138
+ from metaflow import FlowSpec, step
139
+
140
+
141
+ class MyFlow(FlowSpec):
142
+ @model
143
+ @step
144
+ def train(self):
145
+ # Save a model
146
+ self.my_model = current.model.save(
147
+ "/path/to/trained/model",
148
+ label="trained_model"
149
+ )
150
+ self.next(self.evaluate)
151
+
152
+ @step
153
+ def evaluate(self):
154
+ from metaflow import load_model
155
+ # Load the model using the artifact reference
156
+ load_model(self.my_model, "/tmp/loaded_model")
157
+ # Model is now available at /tmp/loaded_model
158
+ self.next(self.end)
159
+ ```
160
+
161
+ **Loading externally using Metaflow's Run API:**
162
+
163
+ ```python
164
+ from metaflow import Run
165
+ from metaflow import load_model
166
+
167
+ # Get a reference to a completed run
168
+ run = Run("MyFlow/123")
169
+
170
+ # Load using artifact reference from a step
171
+ task_model_ref = run["train"].task.data.my_model
172
+ load_model(task_model_ref, "/local/path/to/model")
173
+
174
+ model_ref = run.data.my_model
175
+ load_model(model_ref, "/local/path/to/model")
176
+ ```
177
+
178
+ **Loading HuggingFace models:**
179
+
180
+ ```python
181
+ # If you saved a HuggingFace model reference
182
+ @huggingface_hub
183
+ @step
184
+ def download_hf_model(self):
185
+ self.hf_model = current.huggingface_hub.snapshot_download(
186
+ repo_id="mistralai/Mistral-7B-Instruct-v0.1"
187
+ )
188
+ self.next(self.use_model)
189
+
190
+ @step
191
+ def use_model(self):
192
+ from metaflow import load_model
193
+ # Load the HuggingFace model
194
+ load_model(self.hf_model, "/tmp/mistral_model")
195
+ # Model files are now available at /tmp/mistral_model
196
+ ```
197
+ """
114
198
  ...
115
199
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.15.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.094339 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.010551 #
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.18.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-06-26T22:38:03.097264 #
3
+ # MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1) #
4
+ # Generated on 2025-07-01T08:40:33.013071 #
5
5
  ######################################################################################################
6
6