ob-metaflow-stubs 6.0.10.2rc0__py2.py3-none-any.whl → 6.0.10.4__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.

Potentially problematic release.


This version of ob-metaflow-stubs might be problematic. Click here for more details.

Files changed (262) hide show
  1. metaflow-stubs/__init__.pyi +777 -731
  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 +6 -6
  8. metaflow-stubs/client/filecache.pyi +2 -2
  9. metaflow-stubs/events.pyi +3 -3
  10. metaflow-stubs/exception.pyi +2 -2
  11. metaflow-stubs/flowspec.pyi +5 -5
  12. metaflow-stubs/generated_for.txt +1 -1
  13. metaflow-stubs/includefile.pyi +4 -4
  14. metaflow-stubs/meta_files.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 +2 -2
  20. metaflow-stubs/metaflow_current.pyi +92 -48
  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 +5 -5
  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 +10 -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 +6 -4
  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 +2 -2
  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 +2 -2
  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 +3 -3
  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 +129 -14
  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/apps/__init__.pyi +2 -2
  67. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/__init__.pyi +2 -3
  68. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/_state_machine.pyi +2 -2
  69. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/_vendor/__init__.pyi +2 -2
  70. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/_vendor/spinner/__init__.pyi +2 -2
  71. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/_vendor/spinner/spinners.pyi +2 -2
  72. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/app_cli.pyi +3 -3
  73. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/app_config.pyi +3 -3
  74. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/capsule.pyi +3 -3
  75. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/click_importer.pyi +2 -2
  76. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/code_package/__init__.pyi +2 -2
  77. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/code_package/code_packager.pyi +2 -2
  78. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/config/__init__.pyi +2 -2
  79. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/config/cli_generator.pyi +2 -2
  80. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/config/config_utils.pyi +4 -4
  81. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/config/schema_export.pyi +2 -2
  82. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/config/typed_configs.pyi +3 -3
  83. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/config/unified_config.pyi +4 -4
  84. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/dependencies.pyi +3 -3
  85. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/deployer.pyi +5 -11
  86. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/experimental/__init__.pyi +2 -2
  87. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/perimeters.pyi +2 -2
  88. metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/utils.pyi +3 -3
  89. metaflow-stubs/mf_extensions/outerbounds/plugins/aws/__init__.pyi +2 -2
  90. metaflow-stubs/mf_extensions/outerbounds/plugins/aws/assume_role_decorator.pyi +2 -2
  91. metaflow-stubs/mf_extensions/outerbounds/plugins/card_utilities/__init__.pyi +2 -2
  92. metaflow-stubs/mf_extensions/outerbounds/plugins/card_utilities/async_cards.pyi +2 -2
  93. metaflow-stubs/mf_extensions/outerbounds/plugins/card_utilities/injector.pyi +2 -2
  94. metaflow-stubs/mf_extensions/outerbounds/plugins/checkpoint_datastores/__init__.pyi +2 -2
  95. metaflow-stubs/mf_extensions/outerbounds/plugins/checkpoint_datastores/coreweave.pyi +4 -4
  96. metaflow-stubs/mf_extensions/outerbounds/plugins/checkpoint_datastores/nebius.pyi +4 -4
  97. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/__init__.pyi +2 -2
  98. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/baker.pyi +5 -5
  99. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/docker_environment.pyi +2 -2
  100. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/fast_bakery.pyi +2 -2
  101. metaflow-stubs/mf_extensions/outerbounds/plugins/kubernetes/__init__.pyi +2 -2
  102. metaflow-stubs/mf_extensions/outerbounds/plugins/kubernetes/pod_killer.pyi +2 -2
  103. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/__init__.pyi +2 -2
  104. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/constants.pyi +2 -2
  105. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/exceptions.pyi +2 -2
  106. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/ollama.pyi +2 -2
  107. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/status_card.pyi +2 -2
  108. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/__init__.pyi +2 -2
  109. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/snowflake.pyi +2 -2
  110. metaflow-stubs/mf_extensions/outerbounds/profilers/__init__.pyi +2 -2
  111. metaflow-stubs/mf_extensions/outerbounds/profilers/gpu.pyi +2 -2
  112. metaflow-stubs/mf_extensions/outerbounds/remote_config.pyi +4 -4
  113. metaflow-stubs/mf_extensions/outerbounds/toplevel/__init__.pyi +2 -2
  114. metaflow-stubs/mf_extensions/outerbounds/toplevel/global_aliases_for_metaflow_package.pyi +2 -3
  115. metaflow-stubs/mf_extensions/outerbounds/toplevel/s3_proxy.pyi +2 -2
  116. metaflow-stubs/multicore_utils.pyi +2 -2
  117. metaflow-stubs/ob_internal.pyi +2 -3
  118. metaflow-stubs/packaging_sys/__init__.pyi +7 -7
  119. metaflow-stubs/packaging_sys/backend.pyi +4 -4
  120. metaflow-stubs/packaging_sys/distribution_support.pyi +5 -5
  121. metaflow-stubs/packaging_sys/tar_backend.pyi +5 -5
  122. metaflow-stubs/packaging_sys/utils.pyi +2 -2
  123. metaflow-stubs/packaging_sys/v1.pyi +3 -3
  124. metaflow-stubs/parameters.pyi +4 -4
  125. metaflow-stubs/plugins/__init__.pyi +12 -12
  126. metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
  127. metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
  128. metaflow-stubs/plugins/airflow/exception.pyi +2 -2
  129. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
  130. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
  131. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +2 -2
  132. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +2 -2
  133. metaflow-stubs/plugins/argo/__init__.pyi +2 -2
  134. metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
  135. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  136. metaflow-stubs/plugins/argo/argo_workflows.pyi +3 -3
  137. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +3 -3
  138. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  139. metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +3 -3
  140. metaflow-stubs/plugins/argo/exit_hooks.pyi +3 -3
  141. metaflow-stubs/plugins/aws/__init__.pyi +2 -2
  142. metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
  143. metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
  144. metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
  145. metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
  146. metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
  147. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +2 -2
  148. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
  149. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +4 -4
  150. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +2 -2
  151. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +2 -2
  152. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +2 -2
  153. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +2 -2
  154. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +2 -2
  155. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +3 -3
  156. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +4 -4
  157. metaflow-stubs/plugins/azure/__init__.pyi +2 -2
  158. metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
  159. metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
  160. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +4 -4
  161. metaflow-stubs/plugins/azure/azure_utils.pyi +2 -2
  162. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +2 -2
  163. metaflow-stubs/plugins/azure/includefile_support.pyi +2 -2
  164. metaflow-stubs/plugins/cards/__init__.pyi +2 -2
  165. metaflow-stubs/plugins/cards/card_client.pyi +3 -3
  166. metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
  167. metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
  168. metaflow-stubs/plugins/cards/card_decorator.pyi +3 -3
  169. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
  170. metaflow-stubs/plugins/cards/card_modules/basic.pyi +2 -2
  171. metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
  172. metaflow-stubs/plugins/cards/card_modules/components.pyi +3 -3
  173. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
  174. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
  175. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +2 -2
  176. metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
  177. metaflow-stubs/plugins/cards/component_serializer.pyi +2 -2
  178. metaflow-stubs/plugins/cards/exception.pyi +2 -2
  179. metaflow-stubs/plugins/catch_decorator.pyi +3 -3
  180. metaflow-stubs/plugins/datatools/__init__.pyi +2 -2
  181. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  182. metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
  183. metaflow-stubs/plugins/datatools/s3/s3.pyi +3 -3
  184. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
  185. metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
  186. metaflow-stubs/plugins/debug_logger.pyi +2 -2
  187. metaflow-stubs/plugins/debug_monitor.pyi +2 -2
  188. metaflow-stubs/plugins/environment_decorator.pyi +2 -2
  189. metaflow-stubs/plugins/events_decorator.pyi +2 -2
  190. metaflow-stubs/plugins/exit_hook/__init__.pyi +2 -2
  191. metaflow-stubs/plugins/exit_hook/exit_hook_decorator.pyi +2 -2
  192. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  193. metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
  194. metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
  195. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +4 -4
  196. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +2 -2
  197. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +2 -2
  198. metaflow-stubs/plugins/gcp/gs_utils.pyi +2 -2
  199. metaflow-stubs/plugins/gcp/includefile_support.pyi +2 -2
  200. metaflow-stubs/plugins/kubernetes/__init__.pyi +2 -2
  201. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +3 -3
  202. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +2 -2
  203. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  204. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +2 -2
  205. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
  206. metaflow-stubs/plugins/kubernetes/spot_monitor_sidecar.pyi +2 -2
  207. metaflow-stubs/plugins/ollama/__init__.pyi +3 -3
  208. metaflow-stubs/plugins/optuna/__init__.pyi +2 -2
  209. metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
  210. metaflow-stubs/plugins/perimeters.pyi +2 -2
  211. metaflow-stubs/plugins/project_decorator.pyi +2 -2
  212. metaflow-stubs/plugins/pypi/__init__.pyi +3 -3
  213. metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
  214. metaflow-stubs/plugins/pypi/conda_environment.pyi +6 -6
  215. metaflow-stubs/plugins/pypi/parsers.pyi +2 -2
  216. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
  217. metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
  218. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  219. metaflow-stubs/plugins/resources_decorator.pyi +2 -2
  220. metaflow-stubs/plugins/retry_decorator.pyi +2 -2
  221. metaflow-stubs/plugins/secrets/__init__.pyi +3 -3
  222. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +4 -4
  223. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
  224. metaflow-stubs/plugins/secrets/secrets_func.pyi +2 -2
  225. metaflow-stubs/plugins/secrets/secrets_spec.pyi +2 -2
  226. metaflow-stubs/plugins/secrets/utils.pyi +2 -2
  227. metaflow-stubs/plugins/snowflake/__init__.pyi +2 -2
  228. metaflow-stubs/plugins/storage_executor.pyi +2 -2
  229. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +2 -2
  230. metaflow-stubs/plugins/timeout_decorator.pyi +3 -3
  231. metaflow-stubs/plugins/torchtune/__init__.pyi +2 -2
  232. metaflow-stubs/plugins/uv/__init__.pyi +2 -2
  233. metaflow-stubs/plugins/uv/uv_environment.pyi +2 -2
  234. metaflow-stubs/profilers/__init__.pyi +2 -2
  235. metaflow-stubs/pylint_wrapper.pyi +2 -2
  236. metaflow-stubs/runner/__init__.pyi +2 -2
  237. metaflow-stubs/runner/deployer.pyi +6 -6
  238. metaflow-stubs/runner/deployer_impl.pyi +2 -2
  239. metaflow-stubs/runner/metaflow_runner.pyi +4 -4
  240. metaflow-stubs/runner/nbdeploy.pyi +2 -2
  241. metaflow-stubs/runner/nbrun.pyi +2 -2
  242. metaflow-stubs/runner/subprocess_manager.pyi +2 -2
  243. metaflow-stubs/runner/utils.pyi +3 -3
  244. metaflow-stubs/system/__init__.pyi +2 -2
  245. metaflow-stubs/system/system_logger.pyi +2 -2
  246. metaflow-stubs/system/system_monitor.pyi +2 -2
  247. metaflow-stubs/tagging_util.pyi +2 -2
  248. metaflow-stubs/tuple_util.pyi +2 -2
  249. metaflow-stubs/user_configs/__init__.pyi +2 -2
  250. metaflow-stubs/user_configs/config_options.pyi +4 -4
  251. metaflow-stubs/user_configs/config_parameters.pyi +7 -7
  252. metaflow-stubs/user_decorators/__init__.pyi +2 -2
  253. metaflow-stubs/user_decorators/common.pyi +2 -2
  254. metaflow-stubs/user_decorators/mutable_flow.pyi +4 -4
  255. metaflow-stubs/user_decorators/mutable_step.pyi +4 -4
  256. metaflow-stubs/user_decorators/user_flow_decorator.pyi +4 -4
  257. metaflow-stubs/user_decorators/user_step_decorator.pyi +4 -4
  258. {ob_metaflow_stubs-6.0.10.2rc0.dist-info → ob_metaflow_stubs-6.0.10.4.dist-info}/METADATA +1 -1
  259. ob_metaflow_stubs-6.0.10.4.dist-info/RECORD +262 -0
  260. ob_metaflow_stubs-6.0.10.2rc0.dist-info/RECORD +0 -262
  261. {ob_metaflow_stubs-6.0.10.2rc0.dist-info → ob_metaflow_stubs-6.0.10.4.dist-info}/WHEEL +0 -0
  262. {ob_metaflow_stubs-6.0.10.2rc0.dist-info → ob_metaflow_stubs-6.0.10.4.dist-info}/top_level.txt +0 -0
@@ -1,16 +1,16 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.809264 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.861049 #
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 metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
13
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
14
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
15
15
  import metaflow.datastore.datastore_storage
16
16
 
@@ -108,6 +108,12 @@ class CheckpointDatastore(metaflow.mf_extensions.obcheckpoint.plugins.machine_le
108
108
  def create_key_name(self, *args):
109
109
  ...
110
110
  @classmethod
111
+ def init_global_registry_write_store(cls, storage_backend: metaflow.datastore.datastore_storage.DataStoreStorage, pathspec, artifact_store_path_components):
112
+ """
113
+ The normal mode of operation ie (init_write_store) is a metaflow coupled mode of operation where we store the checkpoints based on metaflow based logic.
114
+ """
115
+ ...
116
+ @classmethod
111
117
  def init_write_store(cls, storage_backend: metaflow.datastore.datastore_storage.DataStoreStorage, pathspec, scope, task_identifier):
112
118
  ...
113
119
  def save(self, local_path: str, attempt, version_id, name = 'mfchckpt', metadata = {}, set_latest = True, storage_format = 'files') -> metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures.CheckpointArtifact:
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.672545 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.709039 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.708434 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.747000 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
12
- import metaflow
13
11
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.core
12
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
14
13
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
14
+ import metaflow
15
15
 
16
16
  from ......metaflow_current import current as current
17
17
  from ......exception import MetaflowException as MetaflowException
@@ -40,6 +40,8 @@ class Checkpointer(object, metaclass=type):
40
40
  @property
41
41
  def current_version(self):
42
42
  ...
43
+ def override_path_components(self, path_components: typing.List[str]):
44
+ ...
43
45
  def set_root_prefix(self, root_prefix):
44
46
  ...
45
47
  def __init__(self, datastore: metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage.CheckpointDatastore, attempt: int = 0):
@@ -1,18 +1,18 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.674754 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.711314 #
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 metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
- import metaflow
14
12
  import metaflow.decorators
13
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
15
14
  import os
15
+ import metaflow
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.672760 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.709327 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.637527 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.672153 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.711326 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.749970 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.639172 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.673894 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.639221 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.673943 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.712864 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.751589 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.711657 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.750337 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.825347 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.877117 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.673432 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.710020 #
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
13
13
  import metaflow.exception
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.713955 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.752738 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.638493 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.673176 #
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.datastructures
13
13
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.673092 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.709651 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.675647 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.712470 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.675699 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.712520 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
9
9
  import metaflow
10
10
  import typing
11
11
  if typing.TYPE_CHECKING:
12
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
13
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
13
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
14
14
 
15
15
  from ..checkpoints.decorator import CheckpointDecorator as CheckpointDecorator
16
16
  from ..checkpoints.decorator import CurrentCheckpointer as CurrentCheckpointer
@@ -30,9 +30,6 @@ def download_model_from_huggingface(**kwargs):
30
30
 
31
31
  class HuggingfaceRegistry(object, metaclass=type):
32
32
  """
33
- This object provides syntactic sugar over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
34
-
35
- The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the `<repo_type>/<repo_id>` name. The `repo_type` is by default `model` and can be overriden by passing the `repo_type` parameter to the `snapshot_download` function.
36
33
  """
37
34
  def __init__(self, logger):
38
35
  ...
@@ -44,13 +41,40 @@ class HuggingfaceRegistry(object, metaclass=type):
44
41
  ...
45
42
  def snapshot_download(self, **kwargs) -> dict:
46
43
  """
47
- Downloads a model from huggingface hub and cache's it to the Metaflow's datastore.
48
- It passes down all the parameters to the `huggingface_hub.snapshot_download` function.
44
+ Downloads a model from the Hugging Face Hub and caches it in the Metaflow datastore.
45
+ It passes all parameters to the `huggingface_hub.snapshot_download` function.
49
46
 
50
47
  Returns
51
48
  -------
52
49
  dict
53
- A reference to the artifact that was saved/retrieved from the Metaflow's datastore.
50
+ A reference to the artifact saved to or retrieved from the Metaflow datastore.
51
+ """
52
+ ...
53
+ def load(self, repo_id = None, path = None, repo_type = 'model', **kwargs):
54
+ """
55
+ Context manager to load a Hugging Face repo (model/dataset) to a local path.
56
+
57
+ - If `path` is provided, the repo is loaded there and the same path is yielded.
58
+ - If `path` is not provided, a temporary directory is created, the repo is
59
+ loaded there, the path is yielded, and the directory is cleaned up when
60
+ the context exits.
61
+
62
+ Parameters
63
+ ----------
64
+ repo_id : str, optional
65
+ The Hugging Face repo ID. If omitted, must be provided via kwargs["repo_id"].
66
+ path : str, optional
67
+ Target directory to place files. If None, a temp directory is created.
68
+ repo_type : str, optional
69
+ Repo type (e.g., "model", "dataset"). Defaults to "model".
70
+ **kwargs : Any
71
+ Additional args forwarded to snapshot_download (e.g. force_download, revision,
72
+ allow_patterns, ignore_patterns, etc.).
73
+
74
+ Yields
75
+ ------
76
+ str
77
+ Local filesystem path where the repo is available.
54
78
  """
55
79
  ...
56
80
  ...
@@ -113,11 +137,11 @@ class HuggingfaceLoadedModels(object, metaclass=type):
113
137
 
114
138
  class HuggingfaceHubDecorator(metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CheckpointDecorator, metaclass=type):
115
139
  """
116
- Decorator that helps cache, version and store models/datasets from huggingface hub.
140
+ Decorator that helps cache, version, and store models/datasets from the Hugging Face Hub.
117
141
 
118
142
  > Examples
119
143
 
120
- **Usage: creating references of models from huggingface that may be loaded in downstream steps**
144
+ **Usage: creating references to models from the Hugging Face Hub that may be loaded in downstream steps**
121
145
  ```python
122
146
  @huggingface_hub
123
147
  @step
@@ -136,7 +160,23 @@ class HuggingfaceHubDecorator(metaflow.mf_extensions.obcheckpoint.plugins.machin
136
160
  self.next(self.train)
137
161
  ```
138
162
 
139
- **Usage: loading models directly from huggingface hub or from cache (from metaflow's datastore)**
163
+ **Usage: explicitly loading models at runtime from the Hugging Face Hub or from cache (from Metaflow's datastore)**
164
+ ```python
165
+ @huggingface_hub
166
+ @step
167
+ def run_training(self):
168
+ # Temporary directory (auto-cleaned on exit)
169
+ with current.huggingface_hub.load(
170
+ repo_id="google-bert/bert-base-uncased",
171
+ allow_patterns=["*.bin"],
172
+ ) as local_path:
173
+ # Use files under local_path
174
+ train_model(local_path)
175
+ ...
176
+
177
+ ```
178
+
179
+ **Usage: loading models directly from the Hugging Face Hub or from cache (from Metaflow's datastore)**
140
180
  ```python
141
181
  @huggingface_hub(load=["mistralai/Mistral-7B-Instruct-v0.1"])
142
182
  @step
@@ -145,7 +185,7 @@ class HuggingfaceHubDecorator(metaflow.mf_extensions.obcheckpoint.plugins.machin
145
185
  ```
146
186
 
147
187
  ```python
148
- @huggingface_hub(load=[("mistralai/Mistral-7B-Instruct-v0.1", "/my-directory"), ("myorg/mistral-lora, "/my-lora-directory")])
188
+ @huggingface_hub(load=[("mistralai/Mistral-7B-Instruct-v0.1", "/my-directory"), ("myorg/mistral-lora", "/my-lora-directory")])
149
189
  @step
150
190
  def finetune_model(self):
151
191
  path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
@@ -175,6 +215,37 @@ class HuggingfaceHubDecorator(metaflow.mf_extensions.obcheckpoint.plugins.machin
175
215
  temp_dir_root : str, optional
176
216
  The root directory that will hold the temporary directory where objects will be downloaded.
177
217
 
218
+ cache_scope : str, optional
219
+ The scope of the cache. Can be `checkpoint` / `flow` / `global`.
220
+
221
+ - `checkpoint` (default): All repos are stored like objects saved by `@checkpoint`.
222
+ i.e., the cached path is derived from the namespace, flow, step, and Metaflow foreach iteration.
223
+ Any repo downloaded under this scope will only be retrieved from the cache when the step runs under the same namespace in the same flow (at the same foreach index).
224
+
225
+ - `flow`: All repos are cached under the flow, regardless of namespace.
226
+ i.e., the cached path is derived solely from the flow name.
227
+ When to use this mode:
228
+ - Multiple users are executing the same flow and want shared access to the repos cached by the decorator.
229
+ - Multiple versions of a flow are deployed, all needing access to the same repos cached by the decorator.
230
+
231
+ - `global`: All repos are cached under a globally static path.
232
+ i.e., the base path of the cache is static and all repos are stored under it.
233
+ When to use this mode:
234
+ - All repos from the Hugging Face Hub need to be shared by users across all flow executions.
235
+
236
+ Each caching scope comes with its own trade-offs:
237
+ - `checkpoint`:
238
+ - Has explicit control over when caches are populated (controlled by the same flow that has the `@huggingface_hub` decorator) but ends up hitting the Hugging Face Hub more often if there are many users/namespaces/steps.
239
+ - Since objects are written on a `namespace/flow/step` basis, the blast radius of a bad checkpoint is limited to a particular flow in a namespace.
240
+ - `flow`:
241
+ - Has less control over when caches are populated (can be written by any execution instance of a flow from any namespace) but results in more cache hits.
242
+ - The blast radius of a bad checkpoint is limited to all runs of a particular flow.
243
+ - It doesn't promote cache reuse across flows.
244
+ - `global`:
245
+ - Has no control over when caches are populated (can be written by any flow execution) but has the highest cache hit rate.
246
+ - It promotes cache reuse across flows.
247
+ - The blast radius of a bad checkpoint spans every flow that could be using a particular repo.
248
+
178
249
  load: Union[List[str], List[Tuple[Dict, str]], List[Tuple[str, str]], List[Dict], None]
179
250
  The list of repos (models/datasets) to load.
180
251
 
@@ -193,7 +264,51 @@ class HuggingfaceHubDecorator(metaflow.mf_extensions.obcheckpoint.plugins.machin
193
264
  -----------------
194
265
  huggingface_hub -> metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry
195
266
 
196
- The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function. The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the `<repo_type>/<repo_id>` name. The `repo_type` is by default `model` and can be overriden by passing the `repo_type` parameter to the `snapshot_download` function.
267
+ This object provides a thin, Metaflow-friendly layer over
268
+ [huggingface_hub]'s `snapshot_download`:
269
+
270
+ - Snapshot references (persist-and-reuse):
271
+ Use `current.huggingface_hub.snapshot_download(repo_id=..., ...)` to
272
+ ensure a repo is available in the Metaflow datastore. If absent, it is
273
+ downloaded once and saved; the call returns a reference dict you can
274
+ store and load later (for example via `@model`).
275
+
276
+ - On-demand local access (context manager):
277
+ Use `current.huggingface_hub.load(repo_id=..., [path=...], ...)` as a
278
+ context manager to obtain a local filesystem path for immediate use.
279
+ If the repo exists in the datastore, it is loaded from there;
280
+ otherwise it is fetched from the Hugging Face Hub and then cached in
281
+ the datastore. When `path` is omitted, a temporary directory is
282
+ created and cleaned up automatically when the context exits. When
283
+ `path` is provided, files are placed there and are not cleaned up by
284
+ the context manager.
285
+
286
+ Repos are cached in the datastore using the huggingface_hub.snapshot_download's arguments. The cache
287
+ key may include: `repo_id`, `repo_type`, `revision`, `ignore_patterns`,
288
+ and `allow_patterns` (see `cache_scope` for how keys are scoped).
289
+
290
+ Examples
291
+ --------
292
+ Snapshot reference:
293
+ ```python
294
+ ref = current.huggingface_hub.snapshot_download(
295
+ repo_id="google-bert/bert-base-uncased",
296
+ allow_patterns=["*.json"]
297
+ )
298
+ ```
299
+
300
+ Explicit Model Loading with Context manager:
301
+ ```python
302
+ with current.huggingface_hub.load(
303
+ repo_id="google-bert/bert-base-uncased",
304
+ allow_patterns=["*.json"]
305
+ ) as local_path:
306
+ my_model = torch.load(os.path.join(local_path, "model.bin"))
307
+ ```
308
+
309
+ @@ Returns
310
+ ----------
311
+ HuggingfaceRegistry
197
312
  """
198
313
  def step_init(self, flow, graph, step_name, decorators, environment, flow_datastore, logger):
199
314
  ...
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.676602 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.713460 #
5
5
  ######################################################################################################
6
6
 
@@ -1,15 +1,15 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.676659 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.713516 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
12
11
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
12
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
13
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.model_storage
14
14
 
15
15
  from ..datastore.core import STORAGE_FORMATS as STORAGE_FORMATS
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.713777 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.752531 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.713557 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.752305 #
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 metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
13
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
14
14
  import metaflow.datastore.datastore_storage
15
15
 
16
16
  from ..datastore.core import ObjectStorage as ObjectStorage
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.708990 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.747603 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.709064 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.747653 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.714329 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.753124 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.714804 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.753632 #
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.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.715138 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.753959 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.18.3.2+obcheckpoint(0.2.4);ob(v1) #
4
- # Generated on 2025-09-09T23:55:12.810685 #
3
+ # MF version: 2.18.5.1+obcheckpoint(0.2.6);ob(v1) #
4
+ # Generated on 2025-09-16T23:23:08.862525 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations