ob-metaflow-stubs 6.0.3.163__py2.py3-none-any.whl → 6.0.3.164__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 (206) hide show
  1. metaflow-stubs/__init__.pyi +724 -710
  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 +3 -3
  12. metaflow-stubs/generated_for.txt +1 -1
  13. metaflow-stubs/includefile.pyi +2 -2
  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 +136 -136
  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 +3 -3
  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 +2 -2
  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 +2 -2
  37. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/decorator.pyi +2 -2
  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 +2 -2
  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 +1 -1
  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 +2 -2
  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/ollama/__init__.pyi +1 -1
  72. metaflow-stubs/mf_extensions/outerbounds/plugins/ollama/ollama.pyi +1 -1
  73. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/__init__.pyi +1 -1
  74. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/snowflake.pyi +1 -1
  75. metaflow-stubs/mf_extensions/outerbounds/profilers/__init__.pyi +1 -1
  76. metaflow-stubs/mf_extensions/outerbounds/profilers/gpu.pyi +1 -1
  77. metaflow-stubs/mf_extensions/outerbounds/remote_config.pyi +1 -1
  78. metaflow-stubs/mf_extensions/outerbounds/toplevel/__init__.pyi +1 -1
  79. metaflow-stubs/mf_extensions/outerbounds/toplevel/global_aliases_for_metaflow_package.pyi +1 -1
  80. metaflow-stubs/multicore_utils.pyi +1 -1
  81. metaflow-stubs/parameters.pyi +2 -2
  82. metaflow-stubs/plugins/__init__.pyi +9 -9
  83. metaflow-stubs/plugins/airflow/__init__.pyi +1 -1
  84. metaflow-stubs/plugins/airflow/airflow_utils.pyi +1 -1
  85. metaflow-stubs/plugins/airflow/exception.pyi +1 -1
  86. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +1 -1
  87. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +1 -1
  88. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +1 -1
  89. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +1 -1
  90. metaflow-stubs/plugins/argo/__init__.pyi +1 -1
  91. metaflow-stubs/plugins/argo/argo_client.pyi +1 -1
  92. metaflow-stubs/plugins/argo/argo_events.pyi +1 -1
  93. metaflow-stubs/plugins/argo/argo_workflows.pyi +3 -3
  94. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +2 -2
  95. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  96. metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +2 -2
  97. metaflow-stubs/plugins/aws/__init__.pyi +1 -1
  98. metaflow-stubs/plugins/aws/aws_client.pyi +1 -1
  99. metaflow-stubs/plugins/aws/aws_utils.pyi +1 -1
  100. metaflow-stubs/plugins/aws/batch/__init__.pyi +1 -1
  101. metaflow-stubs/plugins/aws/batch/batch.pyi +1 -1
  102. metaflow-stubs/plugins/aws/batch/batch_client.pyi +1 -1
  103. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +1 -1
  104. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +1 -1
  105. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +3 -3
  106. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +1 -1
  107. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +1 -1
  108. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +1 -1
  109. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +1 -1
  110. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +1 -1
  111. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +3 -3
  112. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +3 -3
  113. metaflow-stubs/plugins/azure/__init__.pyi +1 -1
  114. metaflow-stubs/plugins/azure/azure_credential.pyi +1 -1
  115. metaflow-stubs/plugins/azure/azure_exceptions.pyi +1 -1
  116. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +3 -3
  117. metaflow-stubs/plugins/azure/azure_utils.pyi +1 -1
  118. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +1 -1
  119. metaflow-stubs/plugins/azure/includefile_support.pyi +1 -1
  120. metaflow-stubs/plugins/cards/__init__.pyi +1 -1
  121. metaflow-stubs/plugins/cards/card_client.pyi +1 -1
  122. metaflow-stubs/plugins/cards/card_creator.pyi +1 -1
  123. metaflow-stubs/plugins/cards/card_datastore.pyi +1 -1
  124. metaflow-stubs/plugins/cards/card_decorator.pyi +1 -1
  125. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +1 -1
  126. metaflow-stubs/plugins/cards/card_modules/basic.pyi +2 -2
  127. metaflow-stubs/plugins/cards/card_modules/card.pyi +1 -1
  128. metaflow-stubs/plugins/cards/card_modules/components.pyi +3 -3
  129. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +1 -1
  130. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +1 -1
  131. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +1 -1
  132. metaflow-stubs/plugins/cards/card_resolver.pyi +1 -1
  133. metaflow-stubs/plugins/cards/component_serializer.pyi +1 -1
  134. metaflow-stubs/plugins/cards/exception.pyi +1 -1
  135. metaflow-stubs/plugins/catch_decorator.pyi +2 -2
  136. metaflow-stubs/plugins/datatools/__init__.pyi +1 -1
  137. metaflow-stubs/plugins/datatools/local.pyi +1 -1
  138. metaflow-stubs/plugins/datatools/s3/__init__.pyi +1 -1
  139. metaflow-stubs/plugins/datatools/s3/s3.pyi +2 -2
  140. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +1 -1
  141. metaflow-stubs/plugins/datatools/s3/s3util.pyi +1 -1
  142. metaflow-stubs/plugins/debug_logger.pyi +1 -1
  143. metaflow-stubs/plugins/debug_monitor.pyi +1 -1
  144. metaflow-stubs/plugins/environment_decorator.pyi +1 -1
  145. metaflow-stubs/plugins/events_decorator.pyi +1 -1
  146. metaflow-stubs/plugins/frameworks/__init__.pyi +1 -1
  147. metaflow-stubs/plugins/frameworks/pytorch.pyi +1 -1
  148. metaflow-stubs/plugins/gcp/__init__.pyi +1 -1
  149. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +3 -3
  150. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +1 -1
  151. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +1 -1
  152. metaflow-stubs/plugins/gcp/gs_utils.pyi +1 -1
  153. metaflow-stubs/plugins/gcp/includefile_support.pyi +1 -1
  154. metaflow-stubs/plugins/kubernetes/__init__.pyi +1 -1
  155. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +2 -2
  156. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +1 -1
  157. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +1 -1
  158. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +1 -1
  159. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +1 -1
  160. metaflow-stubs/plugins/kubernetes/spot_monitor_sidecar.pyi +1 -1
  161. metaflow-stubs/plugins/ollama/__init__.pyi +2 -2
  162. metaflow-stubs/plugins/parallel_decorator.pyi +1 -1
  163. metaflow-stubs/plugins/perimeters.pyi +1 -1
  164. metaflow-stubs/plugins/project_decorator.pyi +1 -1
  165. metaflow-stubs/plugins/pypi/__init__.pyi +1 -1
  166. metaflow-stubs/plugins/pypi/conda_decorator.pyi +1 -1
  167. metaflow-stubs/plugins/pypi/conda_environment.pyi +5 -5
  168. metaflow-stubs/plugins/pypi/parsers.pyi +1 -1
  169. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +1 -1
  170. metaflow-stubs/plugins/pypi/pypi_environment.pyi +1 -1
  171. metaflow-stubs/plugins/pypi/utils.pyi +1 -1
  172. metaflow-stubs/plugins/resources_decorator.pyi +1 -1
  173. metaflow-stubs/plugins/retry_decorator.pyi +1 -1
  174. metaflow-stubs/plugins/secrets/__init__.pyi +2 -2
  175. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +2 -2
  176. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +1 -1
  177. metaflow-stubs/plugins/snowflake/__init__.pyi +1 -1
  178. metaflow-stubs/plugins/storage_executor.pyi +1 -1
  179. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +1 -1
  180. metaflow-stubs/plugins/timeout_decorator.pyi +2 -2
  181. metaflow-stubs/plugins/uv/__init__.pyi +1 -1
  182. metaflow-stubs/plugins/uv/uv_environment.pyi +2 -2
  183. metaflow-stubs/profilers/__init__.pyi +1 -1
  184. metaflow-stubs/pylint_wrapper.pyi +1 -1
  185. metaflow-stubs/runner/__init__.pyi +1 -1
  186. metaflow-stubs/runner/deployer.pyi +29 -29
  187. metaflow-stubs/runner/deployer_impl.pyi +2 -2
  188. metaflow-stubs/runner/metaflow_runner.pyi +2 -2
  189. metaflow-stubs/runner/nbdeploy.pyi +1 -1
  190. metaflow-stubs/runner/nbrun.pyi +1 -1
  191. metaflow-stubs/runner/subprocess_manager.pyi +1 -1
  192. metaflow-stubs/runner/utils.pyi +2 -2
  193. metaflow-stubs/system/__init__.pyi +1 -1
  194. metaflow-stubs/system/system_logger.pyi +2 -2
  195. metaflow-stubs/system/system_monitor.pyi +1 -1
  196. metaflow-stubs/tagging_util.pyi +1 -1
  197. metaflow-stubs/tuple_util.pyi +1 -1
  198. metaflow-stubs/user_configs/__init__.pyi +1 -1
  199. metaflow-stubs/user_configs/config_decorators.pyi +5 -5
  200. metaflow-stubs/user_configs/config_options.pyi +3 -3
  201. metaflow-stubs/user_configs/config_parameters.pyi +5 -5
  202. {ob_metaflow_stubs-6.0.3.163.dist-info → ob_metaflow_stubs-6.0.3.164.dist-info}/METADATA +1 -1
  203. ob_metaflow_stubs-6.0.3.164.dist-info/RECORD +206 -0
  204. ob_metaflow_stubs-6.0.3.163.dist-info/RECORD +0 -206
  205. {ob_metaflow_stubs-6.0.3.163.dist-info → ob_metaflow_stubs-6.0.3.164.dist-info}/WHEEL +0 -0
  206. {ob_metaflow_stubs-6.0.3.163.dist-info → ob_metaflow_stubs-6.0.3.164.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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.415281 #
4
+ # Generated on 2025-05-07T07:24:19.632241 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.431677 #
4
+ # Generated on 2025-05-07T07:24:19.651521 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.430437 #
4
+ # Generated on 2025-05-07T07:24:19.649504 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.456762 #
4
+ # Generated on 2025-05-07T07:24:19.679719 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.419362 #
4
+ # Generated on 2025-05-07T07:24:19.636541 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.423866 #
4
+ # Generated on 2025-05-07T07:24:19.641062 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,12 +9,12 @@ from __future__ import annotations
9
9
  import metaflow
10
10
  import typing
11
11
  if typing.TYPE_CHECKING:
12
- import tempfile
13
- import datetime
12
+ import tarfile
14
13
  import metaflow.events
15
14
  import metaflow.client.core
16
15
  import typing
17
- import tarfile
16
+ import tempfile
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.451846 #
4
+ # Generated on 2025-05-07T07:24:19.674716 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.416021 #
4
+ # Generated on 2025-05-07T07:24:19.633014 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow
12
11
  import metaflow.events
12
+ import metaflow
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.407923 #
4
+ # Generated on 2025-05-07T07:24:19.624650 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.412523 #
4
+ # Generated on 2025-05-07T07:24:19.629278 #
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.exception
13
13
  import metaflow.unbounded_foreach
14
14
  import metaflow.flowspec
15
- import typing
16
15
  import metaflow.datastore.inputs
16
+ import typing
17
17
 
18
18
  from . import parameters as parameters
19
19
  from .parameters import DelayedEvaluationParameter as DelayedEvaluationParameter
@@ -1 +1 @@
1
- 2.15.11.1+obcheckpoint(0.2.1);ob(v1) 2025-05-06T23:22:15.404227
1
+ 2.15.11.1+obcheckpoint(0.2.1);ob(v1) 2025-05-07T07:24:19.620933
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.418721 #
4
+ # Generated on 2025-05-07T07:24:19.635721 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -10,8 +10,8 @@ import metaflow
10
10
  import typing
11
11
  if typing.TYPE_CHECKING:
12
12
  import metaflow._vendor.click.types
13
- import typing
14
13
  import metaflow.parameters
14
+ import typing
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.407188 #
4
+ # Generated on 2025-05-07T07:24:19.623877 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.411443 #
4
+ # Generated on 2025-05-07T07:24:19.628169 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.435948 #
4
+ # Generated on 2025-05-07T07:24:19.658713 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.435443 #
4
+ # Generated on 2025-05-07T07:24:19.658128 #
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.metadata_provider.metadata
13
13
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.435683 #
4
+ # Generated on 2025-05-07T07:24:19.658439 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.409032 #
4
+ # Generated on 2025-05-07T07:24:19.625758 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.554684 #
4
+ # Generated on 2025-05-07T07:24:19.775718 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow
12
- 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
11
  import metaflow.metaflow_current
15
12
  import metaflow.events
13
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
14
+ import metaflow
15
+ import typing
16
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
16
17
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
17
18
  import metaflow.plugins.cards.component_serializer
18
- import typing
19
19
 
20
20
 
21
21
  TYPE_CHECKING: bool
@@ -228,72 +228,64 @@ 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":
231
+ def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
232
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
-
233
+ (only in the presence of the @checkpoint decorator)
241
234
 
242
- Usage:
243
- ------
235
+ The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
236
+ The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
244
237
 
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"])`
238
+ You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
239
+ by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
240
+ where the checkpoint maybe loaded or saved.
255
241
 
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)
242
+ Usage (Saving Checkpoints):
243
+ -------
262
244
  ```
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"]
245
+ @checkpoint
246
+ @step
247
+ def train(self):
248
+ model = create_model(self.parameters, checkpoint_path = None)
249
+ for i in range(self.epochs):
250
+ # some training logic
251
+ loss = model.train(self.dataset)
252
+ if i % 10 == 0:
253
+ model.save(
254
+ current.checkpoint.directory,
255
+ )
256
+ # saves the contents of the `current.checkpoint.directory` as a checkpoint
257
+ # and returns a reference dictionary to the checkpoint saved in the datastore
258
+ self.latest_checkpoint = current.checkpoint.save(
259
+ name="epoch_checkpoint",
260
+ metadata={
261
+ "epoch": i,
262
+ "loss": loss,
263
+ }
264
+ )
270
265
  ```
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
266
+ Usage (Using Loaded Checkpoints):
267
+ -------
278
268
  ```
269
+ @retry(times=3)
270
+ @checkpoint
271
+ @step
272
+ def train(self):
273
+ # Assume that the task has restarted and the previous attempt of the task
274
+ # saved a checkpoint
275
+ checkpoint_path = None
276
+ if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
277
+ print("Loaded checkpoint from the previous attempt")
278
+ checkpoint_path = current.checkpoint.directory
279
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
280
+ model = create_model(self.parameters, checkpoint_path = checkpoint_path)
281
+ for i in range(self.epochs):
282
+ ...
296
283
  ```
284
+
285
+ Returns
286
+ -------
287
+ CurrentCheckpointer
288
+ The object for handling checkpointing within a step.
297
289
  """
298
290
  ...
299
291
  @property
@@ -358,67 +350,6 @@ class Current(object, metaclass=type):
358
350
  """
359
351
  ...
360
352
  @property
361
- def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
362
- """
363
- (only in the presence of the @checkpoint decorator)
364
-
365
- The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
366
- The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
367
-
368
- You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
369
- by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
370
- where the checkpoint maybe loaded or saved.
371
-
372
- Usage (Saving Checkpoints):
373
- -------
374
- ```
375
- @checkpoint
376
- @step
377
- def train(self):
378
- model = create_model(self.parameters, checkpoint_path = None)
379
- for i in range(self.epochs):
380
- # some training logic
381
- loss = model.train(self.dataset)
382
- if i % 10 == 0:
383
- model.save(
384
- current.checkpoint.directory,
385
- )
386
- # saves the contents of the `current.checkpoint.directory` as a checkpoint
387
- # and returns a reference dictionary to the checkpoint saved in the datastore
388
- self.latest_checkpoint = current.checkpoint.save(
389
- name="epoch_checkpoint",
390
- metadata={
391
- "epoch": i,
392
- "loss": loss,
393
- }
394
- )
395
- ```
396
- Usage (Using Loaded Checkpoints):
397
- -------
398
- ```
399
- @retry(times=3)
400
- @checkpoint
401
- @step
402
- def train(self):
403
- # Assume that the task has restarted and the previous attempt of the task
404
- # saved a checkpoint
405
- checkpoint_path = None
406
- if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
407
- print("Loaded checkpoint from the previous attempt")
408
- checkpoint_path = current.checkpoint.directory
409
-
410
- model = create_model(self.parameters, checkpoint_path = checkpoint_path)
411
- for i in range(self.epochs):
412
- ...
413
- ```
414
-
415
- Returns
416
- -------
417
- CurrentCheckpointer
418
- The object for handling checkpointing within a step.
419
- """
420
- ...
421
- @property
422
353
  def parallel(self) -> "metaflow.metaflow_current.Parallel":
423
354
  """
424
355
  (only in the presence of the @parallel decorator)
@@ -448,6 +379,75 @@ class Current(object, metaclass=type):
448
379
  """
449
380
  ...
450
381
  @property
382
+ def huggingface_hub(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
383
+ """
384
+ (only in the presence of the @huggingface_hub decorator)
385
+
386
+ The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
387
+ over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
388
+ [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
389
+ The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
390
+ `<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.
391
+
392
+
393
+ Usage:
394
+ ------
395
+
396
+ **Usage: creating references of models from huggingface that may be loaded in downstream steps**
397
+ ```python
398
+ @huggingface_hub
399
+ @step
400
+ def pull_model_from_huggingface(self):
401
+ # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
402
+ # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
403
+ # with the same `repo_id` in the backend storage, it will not download the model again. The return
404
+ # value of the function is a reference to the model in the backend storage.
405
+ # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
406
+
407
+ self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
408
+ self.llama_model = current.huggingface_hub.snapshot_download(
409
+ repo_id=self.model_id,
410
+ allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
411
+ )
412
+ self.next(self.train)
413
+ ```
414
+
415
+ **Usage: loading models directly from huggingface hub or from cache (from metaflow's datastore)**
416
+ ```python
417
+ @huggingface_hub(load=["mistralai/Mistral-7B-Instruct-v0.1"])
418
+ @step
419
+ def pull_model_from_huggingface(self):
420
+ path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
421
+ ```
422
+
423
+ ```python
424
+ @huggingface_hub(load=[("mistralai/Mistral-7B-Instruct-v0.1", "/my-directory"), ("myorg/mistral-lora, "/my-lora-directory")])
425
+ @step
426
+ def finetune_model(self):
427
+ path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
428
+ # path_to_model will be /my-directory
429
+ ```
430
+
431
+ ```python
432
+ # Takes all the arguments passed to `snapshot_download`
433
+ # except for `local_dir`
434
+ @huggingface_hub(load=[
435
+ {
436
+ "repo_id": "mistralai/Mistral-7B-Instruct-v0.1",
437
+ },
438
+ {
439
+ "repo_id": "myorg/mistral-lora",
440
+ "repo_type": "model",
441
+ },
442
+ ])
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
447
+ ```
448
+ """
449
+ ...
450
+ @property
451
451
  def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
452
452
  """
453
453
  (only in the presence of the @card decorator)
@@ -466,19 +466,6 @@ class Current(object, metaclass=type):
466
466
  """
467
467
  ...
468
468
  @property
469
- def trigger(self) -> "metaflow.events.Trigger":
470
- """
471
- (only in the presence of the @trigger, or @trigger_on_finish decorators)
472
-
473
- Returns `Trigger` if the current run is triggered by an event
474
-
475
- Returns
476
- -------
477
- Trigger
478
- `Trigger` if triggered by an event
479
- """
480
- ...
481
- @property
482
469
  def project_name(self) -> str:
483
470
  """
484
471
  (only in the presence of the @project decorator)
@@ -545,6 +532,19 @@ class Current(object, metaclass=type):
545
532
  True if the flow is deployed with `--production`.
546
533
  """
547
534
  ...
535
+ @property
536
+ def trigger(self) -> "metaflow.events.Trigger":
537
+ """
538
+ (only in the presence of the @trigger_on_finish, or @trigger decorators)
539
+
540
+ Returns `Trigger` if the current run is triggered by an event
541
+
542
+ Returns
543
+ -------
544
+ Trigger
545
+ `Trigger` if triggered by an event
546
+ """
547
+ ...
548
548
  ...
549
549
 
550
550
  current: Current
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.416213 #
4
+ # Generated on 2025-05-07T07:24:19.632435 #
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.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.417480 #
4
+ # Generated on 2025-05-07T07:24:19.634319 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.426973 #
4
+ # Generated on 2025-05-07T07:24:19.644067 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.427034 #
4
+ # Generated on 2025-05-07T07:24:19.644126 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.427090 #
4
+ # Generated on 2025-05-07T07:24:19.644200 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.480628 #
4
+ # Generated on 2025-05-07T07:24:19.703720 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.15.11.1+obcheckpoint(0.2.1);ob(v1) #
4
- # Generated on 2025-05-06T23:22:15.481325 #
4
+ # Generated on 2025-05-07T07:24:19.704444 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations