ob-metaflow-stubs 6.0.3.109rc1__py2.py3-none-any.whl → 6.0.3.111__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (140) hide show
  1. metaflow-stubs/__init__.pyi +579 -587
  2. metaflow-stubs/cards.pyi +4 -4
  3. metaflow-stubs/cli.pyi +2 -2
  4. metaflow-stubs/client/__init__.pyi +3 -3
  5. metaflow-stubs/client/core.pyi +6 -6
  6. metaflow-stubs/client/filecache.pyi +2 -2
  7. metaflow-stubs/clone_util.pyi +2 -2
  8. metaflow-stubs/events.pyi +2 -2
  9. metaflow-stubs/exception.pyi +2 -2
  10. metaflow-stubs/flowspec.pyi +4 -4
  11. metaflow-stubs/generated_for.txt +1 -1
  12. metaflow-stubs/includefile.pyi +4 -4
  13. metaflow-stubs/info_file.pyi +2 -2
  14. metaflow-stubs/metadata/metadata.pyi +2 -2
  15. metaflow-stubs/metadata/util.pyi +2 -2
  16. metaflow-stubs/metaflow_config.pyi +4 -2
  17. metaflow-stubs/metaflow_current.pyi +83 -83
  18. metaflow-stubs/mflog/mflog.pyi +2 -2
  19. metaflow-stubs/multicore_utils.pyi +2 -2
  20. metaflow-stubs/parameters.pyi +4 -4
  21. metaflow-stubs/plugins/__init__.pyi +5 -3
  22. metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
  23. metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
  24. metaflow-stubs/plugins/airflow/exception.pyi +2 -2
  25. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
  26. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +3 -3
  27. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +3 -3
  28. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +3 -3
  29. metaflow-stubs/plugins/argo/__init__.pyi +2 -2
  30. metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
  31. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  32. metaflow-stubs/plugins/argo/argo_workflows.pyi +5 -5
  33. metaflow-stubs/plugins/argo/argo_workflows_cli.pyi +6 -6
  34. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +5 -5
  35. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +132 -4
  36. metaflow-stubs/plugins/aws/__init__.pyi +2 -2
  37. metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
  38. metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
  39. metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
  40. metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
  41. metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
  42. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +3 -3
  43. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
  44. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +4 -4
  45. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +2 -2
  46. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +2 -2
  47. metaflow-stubs/plugins/aws/step_functions/production_token.pyi +2 -2
  48. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +2 -2
  49. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +2 -2
  50. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +2 -2
  51. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +6 -3
  52. metaflow-stubs/plugins/azure/__init__.pyi +2 -2
  53. metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
  54. metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
  55. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +4 -4
  56. metaflow-stubs/plugins/azure/azure_utils.pyi +2 -2
  57. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +2 -2
  58. metaflow-stubs/plugins/azure/includefile_support.pyi +2 -2
  59. metaflow-stubs/plugins/cards/__init__.pyi +2 -2
  60. metaflow-stubs/plugins/cards/card_cli.pyi +5 -5
  61. metaflow-stubs/plugins/cards/card_client.pyi +3 -3
  62. metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
  63. metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
  64. metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
  65. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
  66. metaflow-stubs/plugins/cards/card_modules/basic.pyi +3 -3
  67. metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
  68. metaflow-stubs/plugins/cards/card_modules/components.pyi +4 -4
  69. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
  70. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
  71. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +2 -2
  72. metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
  73. metaflow-stubs/plugins/cards/component_serializer.pyi +4 -4
  74. metaflow-stubs/plugins/cards/exception.pyi +2 -2
  75. metaflow-stubs/plugins/catch_decorator.pyi +3 -3
  76. metaflow-stubs/plugins/datatools/__init__.pyi +3 -3
  77. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  78. metaflow-stubs/plugins/datatools/s3/__init__.pyi +3 -3
  79. metaflow-stubs/plugins/datatools/s3/s3.pyi +5 -5
  80. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
  81. metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
  82. metaflow-stubs/plugins/debug_logger.pyi +2 -2
  83. metaflow-stubs/plugins/debug_monitor.pyi +2 -2
  84. metaflow-stubs/plugins/environment_decorator.pyi +2 -2
  85. metaflow-stubs/plugins/events_decorator.pyi +2 -2
  86. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  87. metaflow-stubs/plugins/frameworks/pytorch.pyi +3 -3
  88. metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
  89. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +4 -4
  90. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +2 -2
  91. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +2 -2
  92. metaflow-stubs/plugins/gcp/gs_utils.pyi +2 -2
  93. metaflow-stubs/plugins/gcp/includefile_support.pyi +2 -2
  94. metaflow-stubs/plugins/kubernetes/__init__.pyi +2 -2
  95. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +2 -2
  96. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +2 -2
  97. metaflow-stubs/plugins/kubernetes/kubernetes_cli.pyi +3 -3
  98. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  99. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +3 -3
  100. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
  101. metaflow-stubs/plugins/logs_cli.pyi +3 -3
  102. metaflow-stubs/plugins/package_cli.pyi +2 -2
  103. metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
  104. metaflow-stubs/plugins/perimeters.pyi +2 -2
  105. metaflow-stubs/plugins/project_decorator.pyi +2 -2
  106. metaflow-stubs/plugins/pypi/__init__.pyi +2 -2
  107. metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
  108. metaflow-stubs/plugins/pypi/conda_environment.pyi +3 -3
  109. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
  110. metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
  111. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  112. metaflow-stubs/plugins/resources_decorator.pyi +2 -2
  113. metaflow-stubs/plugins/retry_decorator.pyi +2 -2
  114. metaflow-stubs/plugins/secrets/__init__.pyi +2 -2
  115. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +3 -3
  116. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
  117. metaflow-stubs/plugins/storage_executor.pyi +2 -2
  118. metaflow-stubs/plugins/tag_cli.pyi +4 -4
  119. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +3 -3
  120. metaflow-stubs/plugins/timeout_decorator.pyi +3 -3
  121. metaflow-stubs/procpoll.pyi +2 -2
  122. metaflow-stubs/profilers/__init__.pyi +2 -2
  123. metaflow-stubs/pylint_wrapper.pyi +2 -2
  124. metaflow-stubs/runner/__init__.pyi +2 -2
  125. metaflow-stubs/runner/deployer.pyi +21 -5
  126. metaflow-stubs/runner/metaflow_runner.pyi +4 -4
  127. metaflow-stubs/runner/nbdeploy.pyi +2 -2
  128. metaflow-stubs/runner/nbrun.pyi +2 -2
  129. metaflow-stubs/runner/subprocess_manager.pyi +2 -2
  130. metaflow-stubs/runner/utils.pyi +2 -2
  131. metaflow-stubs/system/__init__.pyi +4 -4
  132. metaflow-stubs/system/system_logger.pyi +3 -3
  133. metaflow-stubs/system/system_monitor.pyi +3 -3
  134. metaflow-stubs/tagging_util.pyi +2 -2
  135. metaflow-stubs/tuple_util.pyi +2 -2
  136. {ob_metaflow_stubs-6.0.3.109rc1.dist-info → ob_metaflow_stubs-6.0.3.111.dist-info}/METADATA +1 -1
  137. ob_metaflow_stubs-6.0.3.111.dist-info/RECORD +140 -0
  138. ob_metaflow_stubs-6.0.3.109rc1.dist-info/RECORD +0 -140
  139. {ob_metaflow_stubs-6.0.3.109rc1.dist-info → ob_metaflow_stubs-6.0.3.111.dist-info}/WHEEL +0 -0
  140. {ob_metaflow_stubs-6.0.3.109rc1.dist-info → ob_metaflow_stubs-6.0.3.111.dist-info}/top_level.txt +0 -0
metaflow-stubs/cards.pyi CHANGED
@@ -1,19 +1,19 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.520933 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.449301 #
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.plugins.cards.card_client
11
12
  import metaflow.plugins.cards.card_modules.components
12
13
  import metaflow.plugins.cards.card_modules.card
13
- import metaflow.plugins.cards.card_modules.basic
14
14
  import typing
15
- import metaflow.plugins.cards.card_client
16
15
  import metaflow
16
+ import metaflow.plugins.cards.card_modules.basic
17
17
 
18
18
  def get_cards(task: typing.Union[str, "metaflow.Task"], id: typing.Optional[str] = None, type: typing.Optional[str] = None, follow_resumed: bool = True) -> metaflow.plugins.cards.card_client.CardContainer:
19
19
  """
metaflow-stubs/cli.pyi CHANGED
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.537393 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.465838 #
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.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.528657 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.456087 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
+ import typing
11
12
  import metaflow.events
12
13
  import metaflow.client.core
13
14
  import datetime
14
- import typing
15
15
 
16
16
  def namespace(ns: typing.Optional[str]) -> typing.Optional[str]:
17
17
  """
@@ -1,21 +1,21 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.517520 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.445808 #
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.metaflow_current
12
11
  import metaflow.events
13
- import metaflow.client.core
14
- import datetime
15
12
  import metaflow.exception
16
- import tarfile
17
13
  import typing
14
+ import metaflow.metaflow_current
18
15
  import metaflow
16
+ import metaflow.client.core
17
+ import datetime
18
+ import tarfile
19
19
 
20
20
  current: metaflow.metaflow_current.Current
21
21
 
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.538244 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.466737 #
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.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.536260 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.464727 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
metaflow-stubs/events.pyi CHANGED
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.521526 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.449891 #
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.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.509694 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.438086 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,18 +1,18 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.518906 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.447298 #
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.datastore.inputs
12
11
  import metaflow.flowspec
12
+ import metaflow.parameters
13
13
  import metaflow.exception
14
+ import metaflow.datastore.inputs
14
15
  import typing
15
- import metaflow.parameters
16
16
  import metaflow.unbounded_foreach
17
17
 
18
18
  class DelayedEvaluationParameter(object, metaclass=type):
@@ -1 +1 @@
1
- 2.12.25.1+obcheckpoint(0.0.13);ob(v1) 2024-10-10T01:39:58.494400
1
+ 2.12.25.2+obcheckpoint(0.1.0);ob(v1) 2024-10-21T17:14:28.423007
@@ -1,18 +1,18 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.524452 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.452700 #
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.parameters
11
12
  import metaflow._vendor.click.types
12
- import io
13
13
  import typing
14
14
  import metaflow.plugins.datatools.s3.s3
15
- import metaflow.parameters
15
+ import io
16
16
 
17
17
  class MetaflowException(Exception, metaclass=type):
18
18
  def __init__(self, msg = "", lineno = None):
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.508929 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.437405 #
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.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.562023 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.491273 #
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.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.597237 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.528150 #
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.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.510737 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.439248 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -240,6 +240,8 @@ AIRFLOW_KUBERNETES_KUBECONFIG_FILE: None
240
240
 
241
241
  AIRFLOW_KUBERNETES_KUBECONFIG_CONTEXT: None
242
242
 
243
+ FROM_DEPLOYMENT_IMPL: str
244
+
243
245
  CONDA_PACKAGE_S3ROOT: None
244
246
 
245
247
  CONDA_PACKAGE_AZUREROOT: None
@@ -1,21 +1,21 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.607938 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.545404 #
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
11
12
  import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
13
+ import typing
12
14
  import metaflow.metaflow_current
13
- import metaflow.events
14
- import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
15
+ import metaflow
15
16
  import metaflow.plugins.cards.component_serializer
16
- import typing
17
17
  import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
18
- import metaflow
18
+ import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
19
19
 
20
20
  TYPE_CHECKING: bool
21
21
 
@@ -255,36 +255,64 @@ class Current(object, metaclass=type):
255
255
  """
256
256
  ...
257
257
  @property
258
- def huggingface_hub(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
258
+ def checkpoint(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
259
259
  """
260
- (only in the presence of the @huggingface_hub decorator)
260
+ (only in the presence of the @checkpoint decorator)
261
261
 
262
- The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
263
- over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
264
- [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
265
- The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
266
- `<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.
262
+ The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
263
+ The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
267
264
 
265
+ You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
266
+ by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
267
+ where the checkpoint maybe loaded or saved.
268
268
 
269
- Usage:
270
- ------
271
- ```python
272
- @huggingface_hub
273
- @step
274
- def pull_model_from_huggingface(self):
275
- # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
276
- # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
277
- # with the same `repo_id` in the backend storage, it will not download the model again. The return
278
- # value of the function is a reference to the model in the backend storage.
279
- # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
269
+ Usage (Saving Checkpoints):
270
+ -------
271
+ ```
272
+ @checkpoint
273
+ @step
274
+ def train(self):
275
+ model = create_model(self.parameters, checkpoint_path = None)
276
+ for i in range(self.epochs):
277
+ # some training logic
278
+ loss = model.train(self.dataset)
279
+ if i % 10 == 0:
280
+ model.save(
281
+ current.checkpoint.directory,
282
+ )
283
+ # saves the contents of the `current.checkpoint.directory` as a checkpoint
284
+ # and returns a reference dictionary to the checkpoint saved in the datastore
285
+ self.latest_checkpoint = current.checkpoint.save(
286
+ name="epoch_checkpoint",
287
+ metadata={
288
+ "epoch": i,
289
+ "loss": loss,
290
+ }
291
+ )
292
+ ```
293
+ Usage (Using Loaded Checkpoints):
294
+ -------
295
+ ```
296
+ @retry(times=3)
297
+ @checkpoint
298
+ @step
299
+ def train(self):
300
+ # Assume that the task has restarted and the previous attempt of the task
301
+ # saved a checkpoint
302
+ checkpoint_path = None
303
+ if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
304
+ print("Loaded checkpoint from the previous attempt")
305
+ checkpoint_path = current.checkpoint.directory
280
306
 
281
- self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
282
- self.llama_model = current.huggingface_hub.snapshot_download(
283
- repo_id=self.model_id,
284
- allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
285
- )
286
- self.next(self.train)
307
+ model = create_model(self.parameters, checkpoint_path = checkpoint_path)
308
+ for i in range(self.epochs):
309
+ ...
287
310
  ```
311
+
312
+ Returns
313
+ -------
314
+ CurrentCheckpointer
315
+ The object for handling checkpointing within a step.
288
316
  """
289
317
  ...
290
318
  @property
@@ -349,64 +377,36 @@ class Current(object, metaclass=type):
349
377
  """
350
378
  ...
351
379
  @property
352
- def checkpoint(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
380
+ def huggingface_hub(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
353
381
  """
354
- (only in the presence of the @checkpoint decorator)
382
+ (only in the presence of the @huggingface_hub decorator)
355
383
 
356
- The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
357
- The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
384
+ The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
385
+ over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
386
+ [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
387
+ The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
388
+ `<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.
358
389
 
359
- You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
360
- by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
361
- where the checkpoint maybe loaded or saved.
362
390
 
363
- Usage (Saving Checkpoints):
364
- -------
365
- ```
366
- @checkpoint
367
- @step
368
- def train(self):
369
- model = create_model(self.parameters, checkpoint_path = None)
370
- for i in range(self.epochs):
371
- # some training logic
372
- loss = model.train(self.dataset)
373
- if i % 10 == 0:
374
- model.save(
375
- current.checkpoint.directory,
376
- )
377
- # saves the contents of the `current.checkpoint.directory` as a checkpoint
378
- # and returns a reference dictionary to the checkpoint saved in the datastore
379
- self.latest_checkpoint = current.checkpoint.save(
380
- name="epoch_checkpoint",
381
- metadata={
382
- "epoch": i,
383
- "loss": loss,
384
- }
385
- )
386
- ```
387
- Usage (Using Loaded Checkpoints):
388
- -------
389
- ```
390
- @retry(times=3)
391
- @checkpoint
392
- @step
393
- def train(self):
394
- # Assume that the task has restarted and the previous attempt of the task
395
- # saved a checkpoint
396
- checkpoint_path = None
397
- if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
398
- print("Loaded checkpoint from the previous attempt")
399
- checkpoint_path = current.checkpoint.directory
391
+ Usage:
392
+ ------
393
+ ```python
394
+ @huggingface_hub
395
+ @step
396
+ def pull_model_from_huggingface(self):
397
+ # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
398
+ # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
399
+ # with the same `repo_id` in the backend storage, it will not download the model again. The return
400
+ # value of the function is a reference to the model in the backend storage.
401
+ # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
400
402
 
401
- model = create_model(self.parameters, checkpoint_path = checkpoint_path)
402
- for i in range(self.epochs):
403
- ...
403
+ self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
404
+ self.llama_model = current.huggingface_hub.snapshot_download(
405
+ repo_id=self.model_id,
406
+ allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
407
+ )
408
+ self.next(self.train)
404
409
  ```
405
-
406
- Returns
407
- -------
408
- CurrentCheckpointer
409
- The object for handling checkpointing within a step.
410
410
  """
411
411
  ...
412
412
  @property
@@ -497,7 +497,7 @@ class Current(object, metaclass=type):
497
497
  @property
498
498
  def trigger(self) -> "metaflow.events.Trigger":
499
499
  """
500
- (only in the presence of the @trigger, or @trigger_on_finish decorators)
500
+ (only in the presence of the @trigger_on_finish, or @trigger decorators)
501
501
 
502
502
  Returns `Trigger` if the current run is triggered by an event
503
503
 
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.562332 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.491593 #
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.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.511221 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.439665 #
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.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.512401 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.440849 #
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.parameters
11
+ import typing
12
12
  import metaflow._vendor.click.types
13
13
  import metaflow.exception
14
- import typing
14
+ import metaflow.parameters
15
15
 
16
16
  class ParameterFieldFailed(metaflow.exception.MetaflowException, metaclass=type):
17
17
  def __init__(self, name, field):
@@ -1,15 +1,15 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.526139 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.457818 #
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.plugins.cards.card_modules.card
12
11
  import metaflow.unbounded_foreach
12
+ import metaflow.plugins.cards.card_modules.card
13
13
 
14
14
  CLIS_DESC: list
15
15
 
@@ -65,6 +65,8 @@ DEPLOYER_IMPL_PROVIDERS_DESC: list
65
65
  def get_plugin_cli():
66
66
  ...
67
67
 
68
+ FROM_DEPLOYMENT_PROVIDERS: dict
69
+
68
70
  STEP_DECORATORS: list
69
71
 
70
72
  FLOW_DECORATORS: list
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.556038 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.485048 #
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.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.595042 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.525350 #
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.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.594057 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.524395 #
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.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.595340 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.525639 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,15 +1,15 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.605793 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.542649 #
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.decorators
12
11
  import metaflow.exception
12
+ import metaflow.decorators
13
13
 
14
14
  class AirflowException(metaflow.exception.MetaflowException, metaclass=type):
15
15
  def __init__(self, msg):
@@ -1,16 +1,16 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.1+obcheckpoint(0.0.13);ob(v1) #
4
- # Generated on 2024-10-10T01:39:58.606203 #
3
+ # MF version: 2.12.25.2+obcheckpoint(0.1.0);ob(v1) #
4
+ # Generated on 2024-10-21T17:14:28.543245 #
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.decorators
12
11
  import metaflow.plugins.airflow.sensors.base_sensor
13
12
  import metaflow.exception
13
+ import metaflow.decorators
14
14
 
15
15
  class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
16
16
  """