ob-metaflow-stubs 6.0.3.171__py2.py3-none-any.whl → 6.0.3.173rc0__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 (214) hide show
  1. metaflow-stubs/__init__.pyi +708 -707
  2. metaflow-stubs/cards.pyi +1 -1
  3. metaflow-stubs/cli.pyi +1 -1
  4. metaflow-stubs/cli_components/__init__.pyi +1 -1
  5. metaflow-stubs/cli_components/utils.pyi +1 -1
  6. metaflow-stubs/client/__init__.pyi +1 -1
  7. metaflow-stubs/client/core.pyi +4 -4
  8. metaflow-stubs/client/filecache.pyi +1 -1
  9. metaflow-stubs/events.pyi +2 -2
  10. metaflow-stubs/exception.pyi +1 -1
  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 +1 -1
  15. metaflow-stubs/metadata_provider/__init__.pyi +1 -1
  16. metaflow-stubs/metadata_provider/heartbeat.pyi +1 -1
  17. metaflow-stubs/metadata_provider/metadata.pyi +2 -2
  18. metaflow-stubs/metadata_provider/util.pyi +1 -1
  19. metaflow-stubs/metaflow_config.pyi +1 -1
  20. metaflow-stubs/metaflow_current.pyi +123 -123
  21. metaflow-stubs/metaflow_git.pyi +1 -1
  22. metaflow-stubs/mf_extensions/__init__.pyi +1 -1
  23. metaflow-stubs/mf_extensions/obcheckpoint/__init__.pyi +1 -1
  24. metaflow-stubs/mf_extensions/obcheckpoint/plugins/__init__.pyi +1 -1
  25. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/__init__.pyi +1 -1
  26. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/__init__.pyi +1 -1
  27. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/async_cards.pyi +1 -1
  28. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/deco_injection_mixin.pyi +1 -1
  29. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/extra_components.pyi +2 -2
  30. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/__init__.pyi +1 -1
  31. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/__init__.pyi +1 -1
  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 +1 -1
  34. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/checkpoint_storage.pyi +4 -4
  35. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/constructors.pyi +1 -1
  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 +3 -3
  38. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/exceptions.pyi +1 -1
  39. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/final_api.pyi +1 -1
  40. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/lineage.pyi +1 -1
  41. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/__init__.pyi +1 -1
  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 +1 -1
  45. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/exceptions.pyi +1 -1
  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 +1 -1
  48. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastructures.pyi +2 -2
  49. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/exceptions.pyi +1 -1
  50. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/hf_hub/__init__.pyi +1 -1
  51. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/hf_hub/decorator.pyi +1 -1
  52. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/__init__.pyi +1 -1
  53. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/core.pyi +1 -1
  54. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/exceptions.pyi +1 -1
  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 +1 -1
  57. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/flowspec_utils.pyi +1 -1
  58. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/general.pyi +1 -1
  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 +1 -1
  61. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/serialization_handler/base.pyi +1 -1
  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 +1 -1
  65. metaflow-stubs/mf_extensions/outerbounds/plugins/__init__.pyi +1 -1
  66. metaflow-stubs/mf_extensions/outerbounds/plugins/card_utilities/__init__.pyi +1 -1
  67. metaflow-stubs/mf_extensions/outerbounds/plugins/card_utilities/injector.pyi +1 -1
  68. metaflow-stubs/mf_extensions/outerbounds/plugins/checkpoint_datastores/__init__.pyi +1 -1
  69. metaflow-stubs/mf_extensions/outerbounds/plugins/checkpoint_datastores/coreweave.pyi +1 -1
  70. metaflow-stubs/mf_extensions/outerbounds/plugins/checkpoint_datastores/nebius.pyi +1 -1
  71. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/__init__.pyi +6 -0
  72. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/baker.pyi +51 -0
  73. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/docker_environment.pyi +65 -0
  74. metaflow-stubs/mf_extensions/outerbounds/plugins/fast_bakery/fast_bakery.pyi +74 -0
  75. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/__init__.pyi +1 -1
  76. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/constants.pyi +1 -1
  77. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/exceptions.pyi +1 -1
  78. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/ollama.pyi +1 -1
  79. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/__init__.pyi +1 -1
  80. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/snowflake.pyi +1 -1
  81. metaflow-stubs/mf_extensions/outerbounds/profilers/__init__.pyi +1 -1
  82. metaflow-stubs/mf_extensions/outerbounds/profilers/gpu.pyi +1 -1
  83. metaflow-stubs/mf_extensions/outerbounds/remote_config.pyi +1 -1
  84. metaflow-stubs/mf_extensions/outerbounds/toplevel/__init__.pyi +1 -1
  85. metaflow-stubs/mf_extensions/outerbounds/toplevel/global_aliases_for_metaflow_package.pyi +2 -1
  86. metaflow-stubs/multicore_utils.pyi +1 -1
  87. metaflow-stubs/ob_internal.pyi +11 -0
  88. metaflow-stubs/parameters.pyi +3 -3
  89. metaflow-stubs/plugins/__init__.pyi +12 -11
  90. metaflow-stubs/plugins/airflow/__init__.pyi +1 -1
  91. metaflow-stubs/plugins/airflow/airflow_utils.pyi +1 -1
  92. metaflow-stubs/plugins/airflow/exception.pyi +1 -1
  93. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +1 -1
  94. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +1 -1
  95. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +1 -1
  96. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +1 -1
  97. metaflow-stubs/plugins/argo/__init__.pyi +1 -1
  98. metaflow-stubs/plugins/argo/argo_client.pyi +1 -1
  99. metaflow-stubs/plugins/argo/argo_events.pyi +1 -1
  100. metaflow-stubs/plugins/argo/argo_workflows.pyi +3 -3
  101. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +2 -2
  102. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  103. metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +2 -2
  104. metaflow-stubs/plugins/aws/__init__.pyi +1 -1
  105. metaflow-stubs/plugins/aws/aws_client.pyi +1 -1
  106. metaflow-stubs/plugins/aws/aws_utils.pyi +1 -1
  107. metaflow-stubs/plugins/aws/batch/__init__.pyi +1 -1
  108. metaflow-stubs/plugins/aws/batch/batch.pyi +1 -1
  109. metaflow-stubs/plugins/aws/batch/batch_client.pyi +1 -1
  110. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +1 -1
  111. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +1 -1
  112. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +2 -2
  113. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +1 -1
  114. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +1 -1
  115. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +1 -1
  116. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +1 -1
  117. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +1 -1
  118. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +3 -3
  119. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +2 -2
  120. metaflow-stubs/plugins/azure/__init__.pyi +1 -1
  121. metaflow-stubs/plugins/azure/azure_credential.pyi +1 -1
  122. metaflow-stubs/plugins/azure/azure_exceptions.pyi +1 -1
  123. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +2 -2
  124. metaflow-stubs/plugins/azure/azure_utils.pyi +1 -1
  125. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +1 -1
  126. metaflow-stubs/plugins/azure/includefile_support.pyi +1 -1
  127. metaflow-stubs/plugins/cards/__init__.pyi +5 -5
  128. metaflow-stubs/plugins/cards/card_client.pyi +2 -2
  129. metaflow-stubs/plugins/cards/card_creator.pyi +1 -1
  130. metaflow-stubs/plugins/cards/card_datastore.pyi +1 -1
  131. metaflow-stubs/plugins/cards/card_decorator.pyi +1 -1
  132. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +1 -1
  133. metaflow-stubs/plugins/cards/card_modules/basic.pyi +1 -1
  134. metaflow-stubs/plugins/cards/card_modules/card.pyi +1 -1
  135. metaflow-stubs/plugins/cards/card_modules/components.pyi +3 -3
  136. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +1 -1
  137. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +1 -1
  138. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +1 -1
  139. metaflow-stubs/plugins/cards/card_resolver.pyi +1 -1
  140. metaflow-stubs/plugins/cards/component_serializer.pyi +1 -1
  141. metaflow-stubs/plugins/cards/exception.pyi +1 -1
  142. metaflow-stubs/plugins/catch_decorator.pyi +1 -1
  143. metaflow-stubs/plugins/datatools/__init__.pyi +1 -1
  144. metaflow-stubs/plugins/datatools/local.pyi +1 -1
  145. metaflow-stubs/plugins/datatools/s3/__init__.pyi +1 -1
  146. metaflow-stubs/plugins/datatools/s3/s3.pyi +3 -3
  147. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +1 -1
  148. metaflow-stubs/plugins/datatools/s3/s3util.pyi +1 -1
  149. metaflow-stubs/plugins/debug_logger.pyi +1 -1
  150. metaflow-stubs/plugins/debug_monitor.pyi +1 -1
  151. metaflow-stubs/plugins/environment_decorator.pyi +1 -1
  152. metaflow-stubs/plugins/events_decorator.pyi +1 -1
  153. metaflow-stubs/plugins/frameworks/__init__.pyi +1 -1
  154. metaflow-stubs/plugins/frameworks/pytorch.pyi +1 -1
  155. metaflow-stubs/plugins/gcp/__init__.pyi +1 -1
  156. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +2 -2
  157. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +1 -1
  158. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +1 -1
  159. metaflow-stubs/plugins/gcp/gs_utils.pyi +1 -1
  160. metaflow-stubs/plugins/gcp/includefile_support.pyi +1 -1
  161. metaflow-stubs/plugins/kubernetes/__init__.pyi +1 -1
  162. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +2 -2
  163. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +1 -1
  164. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +1 -1
  165. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +1 -1
  166. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +1 -1
  167. metaflow-stubs/plugins/kubernetes/spot_monitor_sidecar.pyi +1 -1
  168. metaflow-stubs/plugins/ollama/__init__.pyi +2 -2
  169. metaflow-stubs/plugins/parallel_decorator.pyi +1 -1
  170. metaflow-stubs/plugins/perimeters.pyi +1 -1
  171. metaflow-stubs/plugins/project_decorator.pyi +1 -1
  172. metaflow-stubs/plugins/pypi/__init__.pyi +2 -2
  173. metaflow-stubs/plugins/pypi/conda_decorator.pyi +1 -1
  174. metaflow-stubs/plugins/pypi/conda_environment.pyi +2 -2
  175. metaflow-stubs/plugins/pypi/parsers.pyi +1 -1
  176. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +1 -1
  177. metaflow-stubs/plugins/pypi/pypi_environment.pyi +1 -1
  178. metaflow-stubs/plugins/pypi/utils.pyi +1 -1
  179. metaflow-stubs/plugins/resources_decorator.pyi +1 -1
  180. metaflow-stubs/plugins/retry_decorator.pyi +1 -1
  181. metaflow-stubs/plugins/secrets/__init__.pyi +1 -1
  182. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +1 -1
  183. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +1 -1
  184. metaflow-stubs/plugins/snowflake/__init__.pyi +1 -1
  185. metaflow-stubs/plugins/storage_executor.pyi +1 -1
  186. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +2 -2
  187. metaflow-stubs/plugins/timeout_decorator.pyi +1 -1
  188. metaflow-stubs/plugins/torchtune/__init__.pyi +39 -0
  189. metaflow-stubs/plugins/uv/__init__.pyi +1 -1
  190. metaflow-stubs/plugins/uv/uv_environment.pyi +2 -2
  191. metaflow-stubs/profilers/__init__.pyi +1 -1
  192. metaflow-stubs/pylint_wrapper.pyi +1 -1
  193. metaflow-stubs/runner/__init__.pyi +1 -1
  194. metaflow-stubs/runner/deployer.pyi +27 -27
  195. metaflow-stubs/runner/deployer_impl.pyi +1 -1
  196. metaflow-stubs/runner/metaflow_runner.pyi +2 -2
  197. metaflow-stubs/runner/nbdeploy.pyi +1 -1
  198. metaflow-stubs/runner/nbrun.pyi +1 -1
  199. metaflow-stubs/runner/subprocess_manager.pyi +1 -1
  200. metaflow-stubs/runner/utils.pyi +3 -3
  201. metaflow-stubs/system/__init__.pyi +1 -1
  202. metaflow-stubs/system/system_logger.pyi +1 -1
  203. metaflow-stubs/system/system_monitor.pyi +1 -1
  204. metaflow-stubs/tagging_util.pyi +1 -1
  205. metaflow-stubs/tuple_util.pyi +1 -1
  206. metaflow-stubs/user_configs/__init__.pyi +1 -1
  207. metaflow-stubs/user_configs/config_decorators.pyi +4 -4
  208. metaflow-stubs/user_configs/config_options.pyi +3 -3
  209. metaflow-stubs/user_configs/config_parameters.pyi +6 -6
  210. {ob_metaflow_stubs-6.0.3.171.dist-info → ob_metaflow_stubs-6.0.3.173rc0.dist-info}/METADATA +1 -1
  211. ob_metaflow_stubs-6.0.3.173rc0.dist-info/RECORD +214 -0
  212. ob_metaflow_stubs-6.0.3.171.dist-info/RECORD +0 -208
  213. {ob_metaflow_stubs-6.0.3.171.dist-info → ob_metaflow_stubs-6.0.3.173rc0.dist-info}/WHEEL +0 -0
  214. {ob_metaflow_stubs-6.0.3.171.dist-info → ob_metaflow_stubs-6.0.3.173rc0.dist-info}/top_level.txt +0 -0
metaflow-stubs/cards.pyi CHANGED
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.102466 #
4
+ # Generated on 2025-05-28T01:05:50.855417 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
metaflow-stubs/cli.pyi CHANGED
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.118243 #
4
+ # Generated on 2025-05-28T01:05:50.881573 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.117068 #
4
+ # Generated on 2025-05-28T01:05:50.879574 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.144054 #
4
+ # Generated on 2025-05-28T01:05:50.923601 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.106372 #
4
+ # Generated on 2025-05-28T01:05:50.860709 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,20 +1,20 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.110764 #
4
+ # Generated on 2025-05-28T01:05:50.868854 #
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 datetime
12
+ import tempfile
13
13
  import typing
14
14
  import metaflow.client.core
15
- import tempfile
16
15
  import metaflow.events
17
16
  import tarfile
17
+ import datetime
18
18
 
19
19
  from ..metaflow_current import current as current
20
20
  from ..events import Trigger as Trigger
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.139126 #
4
+ # Generated on 2025-05-28T01:05:50.916355 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
metaflow-stubs/events.pyi CHANGED
@@ -1,15 +1,15 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.103088 #
4
+ # Generated on 2025-05-28T01:05:50.854762 #
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.events
12
11
  import metaflow
12
+ import metaflow.events
13
13
 
14
14
 
15
15
  TYPE_CHECKING: bool
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.095100 #
4
+ # Generated on 2025-05-28T01:05:50.841435 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,19 +1,19 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.099624 #
4
+ # Generated on 2025-05-28T01:05:50.849096 #
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.exception
13
12
  import typing
14
- import metaflow.unbounded_foreach
15
13
  import metaflow.datastore.inputs
16
14
  import metaflow.flowspec
15
+ import metaflow.unbounded_foreach
16
+ import metaflow.exception
17
17
 
18
18
  from . import parameters as parameters
19
19
  from .parameters import DelayedEvaluationParameter as DelayedEvaluationParameter
@@ -1 +1 @@
1
- 2.15.14.1+obcheckpoint(0.2.1);ob(v1) 2025-05-27T00:40:42.091378
1
+ 2.15.14.1+obcheckpoint(0.2.1);ob(v1) 2025-05-28T01:05:50.833233
@@ -1,17 +1,17 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.105684 #
4
+ # Generated on 2025-05-28T01:05:50.859605 #
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
12
  import metaflow.parameters
13
- import metaflow._vendor.click.types
14
13
  import typing
14
+ import metaflow._vendor.click.types
15
15
 
16
16
  from ._vendor import click as click
17
17
  from .exception import MetaflowException as MetaflowException
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.094360 #
4
+ # Generated on 2025-05-28T01:05:50.840275 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.098537 #
4
+ # Generated on 2025-05-28T01:05:50.847258 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.123024 #
4
+ # Generated on 2025-05-28T01:05:50.890567 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,13 +1,13 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.122439 #
4
+ # Generated on 2025-05-28T01:05:50.889736 #
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
12
  import metaflow.metadata_provider.metadata
13
13
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.122651 #
4
+ # Generated on 2025-05-28T01:05:50.890135 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.096207 #
4
+ # Generated on 2025-05-28T01:05:50.843627 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,21 +1,21 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.236295 #
4
+ # Generated on 2025-05-28T01:05:51.021079 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
12
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
13
- import metaflow.metaflow_current
14
11
  import metaflow.plugins.cards.component_serializer
12
+ import metaflow
15
13
  import typing
16
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
17
- import metaflow
15
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
18
16
  import metaflow.events
17
+ import metaflow.metaflow_current
18
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
19
19
 
20
20
 
21
21
  TYPE_CHECKING: bool
@@ -228,75 +228,6 @@ class Current(object, metaclass=type):
228
228
  def graph(self):
229
229
  ...
230
230
  @property
231
- def huggingface_hub(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
232
- """
233
- (only in the presence of the @huggingface_hub decorator)
234
-
235
- The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
236
- over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
237
- [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
238
- The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
239
- `<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.
240
-
241
-
242
- Usage:
243
- ------
244
-
245
- **Usage: creating references of models from huggingface that may be loaded in downstream steps**
246
- ```python
247
- @huggingface_hub
248
- @step
249
- def pull_model_from_huggingface(self):
250
- # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
251
- # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
252
- # with the same `repo_id` in the backend storage, it will not download the model again. The return
253
- # value of the function is a reference to the model in the backend storage.
254
- # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
255
-
256
- self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
257
- self.llama_model = current.huggingface_hub.snapshot_download(
258
- repo_id=self.model_id,
259
- allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
260
- )
261
- self.next(self.train)
262
- ```
263
-
264
- **Usage: loading models directly from huggingface hub or from cache (from metaflow's datastore)**
265
- ```python
266
- @huggingface_hub(load=["mistralai/Mistral-7B-Instruct-v0.1"])
267
- @step
268
- def pull_model_from_huggingface(self):
269
- path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
270
- ```
271
-
272
- ```python
273
- @huggingface_hub(load=[("mistralai/Mistral-7B-Instruct-v0.1", "/my-directory"), ("myorg/mistral-lora, "/my-lora-directory")])
274
- @step
275
- def finetune_model(self):
276
- path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
277
- # path_to_model will be /my-directory
278
- ```
279
-
280
- ```python
281
- # Takes all the arguments passed to `snapshot_download`
282
- # except for `local_dir`
283
- @huggingface_hub(load=[
284
- {
285
- "repo_id": "mistralai/Mistral-7B-Instruct-v0.1",
286
- },
287
- {
288
- "repo_id": "myorg/mistral-lora",
289
- "repo_type": "model",
290
- },
291
- ])
292
- @step
293
- def finetune_model(self):
294
- path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
295
- # path_to_model will be /my-directory
296
- ```
297
- """
298
- ...
299
- @property
300
231
  def parallel(self) -> "metaflow.metaflow_current.Parallel":
301
232
  """
302
233
  (only in the presence of the @parallel decorator)
@@ -344,6 +275,67 @@ class Current(object, metaclass=type):
344
275
  """
345
276
  ...
346
277
  @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
347
339
  def model(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
348
340
  """
349
341
  (only in the presence of the @model decorator)
@@ -405,64 +397,72 @@ class Current(object, metaclass=type):
405
397
  """
406
398
  ...
407
399
  @property
408
- def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
400
+ def huggingface_hub(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
409
401
  """
410
- (only in the presence of the @checkpoint decorator)
402
+ (only in the presence of the @huggingface_hub decorator)
411
403
 
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.
404
+ The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
405
+ over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
406
+ [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
407
+ The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
408
+ `<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.
414
409
 
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.
418
410
 
419
- Usage (Saving Checkpoints):
420
- -------
421
- ```
422
- @checkpoint
423
- @step
424
- def train(self):
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
- )
411
+ Usage:
412
+ ------
413
+
414
+ **Usage: creating references of models from huggingface that may be loaded in downstream steps**
415
+ ```python
416
+ @huggingface_hub
417
+ @step
418
+ def pull_model_from_huggingface(self):
419
+ # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
420
+ # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
421
+ # with the same `repo_id` in the backend storage, it will not download the model again. The return
422
+ # value of the function is a reference to the model in the backend storage.
423
+ # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
424
+
425
+ self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
426
+ self.llama_model = current.huggingface_hub.snapshot_download(
427
+ repo_id=self.model_id,
428
+ allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
429
+ )
430
+ self.next(self.train)
442
431
  ```
443
- Usage (Using Loaded Checkpoints):
444
- -------
432
+
433
+ **Usage: loading models directly from huggingface hub or from cache (from metaflow's datastore)**
434
+ ```python
435
+ @huggingface_hub(load=["mistralai/Mistral-7B-Instruct-v0.1"])
436
+ @step
437
+ def pull_model_from_huggingface(self):
438
+ path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
445
439
  ```
446
- @retry(times=3)
447
- @checkpoint
448
- @step
449
- def train(self):
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
440
 
457
- model = create_model(self.parameters, checkpoint_path = checkpoint_path)
458
- for i in range(self.epochs):
459
- ...
441
+ ```python
442
+ @huggingface_hub(load=[("mistralai/Mistral-7B-Instruct-v0.1", "/my-directory"), ("myorg/mistral-lora, "/my-lora-directory")])
443
+ @step
444
+ def finetune_model(self):
445
+ path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
446
+ # path_to_model will be /my-directory
460
447
  ```
461
448
 
462
- Returns
463
- -------
464
- CurrentCheckpointer
465
- The object for handling checkpointing within a step.
449
+ ```python
450
+ # Takes all the arguments passed to `snapshot_download`
451
+ # except for `local_dir`
452
+ @huggingface_hub(load=[
453
+ {
454
+ "repo_id": "mistralai/Mistral-7B-Instruct-v0.1",
455
+ },
456
+ {
457
+ "repo_id": "myorg/mistral-lora",
458
+ "repo_type": "model",
459
+ },
460
+ ])
461
+ @step
462
+ def finetune_model(self):
463
+ path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
464
+ # path_to_model will be /my-directory
465
+ ```
466
466
  """
467
467
  ...
468
468
  @property
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.103281 #
4
+ # Generated on 2025-05-28T01:05:50.853596 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.104519 #
4
+ # Generated on 2025-05-28T01:05:50.857644 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.113615 #
4
+ # Generated on 2025-05-28T01:05:50.873691 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.113675 #
4
+ # Generated on 2025-05-28T01:05:50.873783 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.113729 #
4
+ # Generated on 2025-05-28T01:05:50.873878 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.166610 #
4
+ # Generated on 2025-05-28T01:05:50.949162 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.167305 #
4
+ # Generated on 2025-05-28T01:05:50.949758 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.166657 #
4
+ # Generated on 2025-05-28T01:05:50.949219 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,13 +1,13 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.14.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-27T00:40:42.207846 #
4
+ # Generated on 2025-05-28T01:05:50.992192 #
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
12
  import metaflow.plugins.cards.card_modules.card
13
13
  import metaflow.plugins.cards.card_modules.components