ob-metaflow-stubs 6.0.3.116__py2.py3-none-any.whl → 6.0.3.117__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 +625 -622
  2. metaflow-stubs/cards.pyi +6 -6
  3. metaflow-stubs/cli.pyi +3 -3
  4. metaflow-stubs/client/__init__.pyi +3 -3
  5. metaflow-stubs/client/core.pyi +6 -6
  6. metaflow-stubs/client/filecache.pyi +3 -3
  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 +5 -5
  11. metaflow-stubs/generated_for.txt +1 -1
  12. metaflow-stubs/includefile.pyi +3 -3
  13. metaflow-stubs/info_file.pyi +2 -2
  14. metaflow-stubs/metadata/metadata.pyi +3 -3
  15. metaflow-stubs/metadata/util.pyi +2 -2
  16. metaflow-stubs/metaflow_config.pyi +2 -2
  17. metaflow-stubs/metaflow_current.pyi +94 -58
  18. metaflow-stubs/mflog/mflog.pyi +2 -2
  19. metaflow-stubs/multicore_utils.pyi +2 -2
  20. metaflow-stubs/parameters.pyi +3 -3
  21. metaflow-stubs/plugins/__init__.pyi +3 -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 +4 -4
  33. metaflow-stubs/plugins/argo/argo_workflows_cli.pyi +6 -6
  34. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +8 -8
  35. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +2 -2
  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 +2 -2
  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 +4 -4
  61. metaflow-stubs/plugins/cards/card_client.pyi +4 -4
  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 +3 -3
  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 +4 -4
  77. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  78. metaflow-stubs/plugins/datatools/s3/__init__.pyi +4 -4
  79. metaflow-stubs/plugins/datatools/s3/s3.pyi +6 -6
  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 +3 -3
  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 +4 -4
  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 +2 -2
  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 +3 -3
  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 +3 -3
  132. metaflow-stubs/system/system_logger.pyi +3 -3
  133. metaflow-stubs/system/system_monitor.pyi +2 -2
  134. metaflow-stubs/tagging_util.pyi +2 -2
  135. metaflow-stubs/tuple_util.pyi +2 -2
  136. {ob_metaflow_stubs-6.0.3.116.dist-info → ob_metaflow_stubs-6.0.3.117.dist-info}/METADATA +1 -1
  137. ob_metaflow_stubs-6.0.3.117.dist-info/RECORD +140 -0
  138. {ob_metaflow_stubs-6.0.3.116.dist-info → ob_metaflow_stubs-6.0.3.117.dist-info}/WHEEL +1 -1
  139. ob_metaflow_stubs-6.0.3.116.dist-info/RECORD +0 -140
  140. {ob_metaflow_stubs-6.0.3.116.dist-info → ob_metaflow_stubs-6.0.3.117.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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:12.987624 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.353993 #
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 typing
13
- import metaflow.plugins.cards.card_modules.card
14
- import metaflow.plugins.cards.card_modules.components
15
11
  import metaflow.plugins.cards.card_client
12
+ import metaflow.plugins.cards.card_modules.card
13
+ import metaflow
16
14
  import metaflow.plugins.cards.card_modules.basic
15
+ import metaflow.plugins.cards.card_modules.components
16
+ import typing
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,15 +1,15 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.007974 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.370593 #
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.exception
12
11
  import metaflow.metaflow_current
12
+ import metaflow.exception
13
13
 
14
14
  def get_metadata() -> str:
15
15
  """
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:12.996576 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.360173 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,9 +9,9 @@ from __future__ import annotations
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
11
  import metaflow.events
12
- import typing
13
12
  import datetime
14
13
  import metaflow.client.core
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:12.982719 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.350576 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
+ import datetime
11
12
  import metaflow
12
- import typing
13
13
  import metaflow.exception
14
- import metaflow.metaflow_current
15
- import datetime
16
14
  import metaflow.client.core
17
- import metaflow.events
18
15
  import tarfile
16
+ import metaflow.events
17
+ import metaflow.metaflow_current
18
+ import typing
19
19
 
20
20
  TYPE_CHECKING: bool
21
21
 
@@ -1,15 +1,15 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.008843 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.371444 #
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.exception
12
11
  import metaflow.datastore.content_addressed_store
12
+ import metaflow.exception
13
13
 
14
14
  class MetaflowException(Exception, metaclass=type):
15
15
  def __init__(self, msg = "", lineno = None):
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.006832 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.369430 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:12.984969 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.354694 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:12.974945 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.342841 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,19 +1,19 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:12.984348 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.351938 #
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
- import typing
13
11
  import metaflow.flowspec
12
+ import typing
13
+ import metaflow.parameters
14
14
  import metaflow.unbounded_foreach
15
+ import metaflow.datastore.inputs
15
16
  import metaflow.exception
16
- import metaflow.parameters
17
17
 
18
18
  class DelayedEvaluationParameter(object, metaclass=type):
19
19
  """
@@ -1 +1 @@
1
- 2.12.27.1+obcheckpoint(0.1.1);ob(v1) 2024-11-04T20:32:12.959508
1
+ 2.12.27.1+obcheckpoint(0.1.2);ob(v1) 2024-11-13T19:05:29.327489
@@ -1,15 +1,15 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:12.991681 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.357444 #
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
12
11
  import metaflow.plugins.datatools.s3.s3
12
+ import typing
13
13
  import io
14
14
  import metaflow.parameters
15
15
  import metaflow._vendor.click.types
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:12.974270 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.342156 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.033616 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.394809 #
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.exception
12
11
  import metaflow.metadata.metadata
12
+ import metaflow.exception
13
13
 
14
14
  class MetaflowInternalError(metaflow.exception.MetaflowException, metaclass=type):
15
15
  ...
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.079493 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.438132 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:12.975983 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.343920 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,21 +1,21 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.082093 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.440634 #
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_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
12
- import metaflow
13
11
  import typing
14
- import metaflow.metaflow_current
12
+ import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
15
13
  import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
16
- import metaflow.events
17
14
  import metaflow.plugins.cards.component_serializer
18
15
  import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
16
+ import metaflow.events
17
+ import metaflow.metaflow_current
18
+ import metaflow
19
19
 
20
20
  TYPE_CHECKING: bool
21
21
 
@@ -227,24 +227,6 @@ class Current(object, metaclass=type):
227
227
  def graph(_):
228
228
  ...
229
229
  @property
230
- def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
231
- """
232
- (only in the presence of the @card decorator)
233
-
234
- The `@card` decorator makes the cards available through the `current.card`
235
- object. If multiple `@card` decorators are present, you can add an `ID` to
236
- distinguish between them using `@card(id=ID)` as the decorator. You will then
237
- be able to access that specific card using `current.card[ID].
238
-
239
- Methods available are `append` and `extend`
240
-
241
- Returns
242
- -------
243
- CardComponentCollector
244
- The or one of the cards attached to this step.
245
- """
246
- ...
247
- @property
248
230
  def model(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
249
231
  """
250
232
  (only in the presence of the @model decorator)
@@ -306,6 +288,24 @@ class Current(object, metaclass=type):
306
288
  """
307
289
  ...
308
290
  @property
291
+ def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
292
+ """
293
+ (only in the presence of the @card decorator)
294
+
295
+ The `@card` decorator makes the cards available through the `current.card`
296
+ object. If multiple `@card` decorators are present, you can add an `ID` to
297
+ distinguish between them using `@card(id=ID)` as the decorator. You will then
298
+ be able to access that specific card using `current.card[ID].
299
+
300
+ Methods available are `append` and `extend`
301
+
302
+ Returns
303
+ -------
304
+ CardComponentCollector
305
+ The or one of the cards attached to this step.
306
+ """
307
+ ...
308
+ @property
309
309
  def parallel(self) -> "metaflow.metaflow_current.Parallel":
310
310
  """
311
311
  (only in the presence of the @parallel decorator)
@@ -335,39 +335,6 @@ class Current(object, metaclass=type):
335
335
  """
336
336
  ...
337
337
  @property
338
- def huggingface_hub(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
339
- """
340
- (only in the presence of the @huggingface_hub decorator)
341
-
342
- The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
343
- over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
344
- [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
345
- The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
346
- `<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.
347
-
348
-
349
- Usage:
350
- ------
351
- ```python
352
- @huggingface_hub
353
- @step
354
- def pull_model_from_huggingface(self):
355
- # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
356
- # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
357
- # with the same `repo_id` in the backend storage, it will not download the model again. The return
358
- # value of the function is a reference to the model in the backend storage.
359
- # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
360
-
361
- self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
362
- self.llama_model = current.huggingface_hub.snapshot_download(
363
- repo_id=self.model_id,
364
- allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
365
- )
366
- self.next(self.train)
367
- ```
368
- """
369
- ...
370
- @property
371
338
  def checkpoint(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
372
339
  """
373
340
  (only in the presence of the @checkpoint decorator)
@@ -429,9 +396,78 @@ class Current(object, metaclass=type):
429
396
  """
430
397
  ...
431
398
  @property
399
+ def huggingface_hub(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
400
+ """
401
+ (only in the presence of the @huggingface_hub decorator)
402
+
403
+ The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
404
+ over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
405
+ [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
406
+ The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
407
+ `<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.
408
+
409
+
410
+ Usage:
411
+ ------
412
+
413
+ **Usage: creating references of models from huggingface that may be loaded in downstream steps**
414
+ ```python
415
+ @huggingface_hub
416
+ @step
417
+ def pull_model_from_huggingface(self):
418
+ # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
419
+ # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
420
+ # with the same `repo_id` in the backend storage, it will not download the model again. The return
421
+ # value of the function is a reference to the model in the backend storage.
422
+ # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
423
+
424
+ self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
425
+ self.llama_model = current.huggingface_hub.snapshot_download(
426
+ repo_id=self.model_id,
427
+ allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
428
+ )
429
+ self.next(self.train)
430
+ ```
431
+
432
+ **Usage: loading models directly from huggingface hub or from cache (from metaflow's datastore)**
433
+ ```python
434
+ @huggingface_hub(load=["mistralai/Mistral-7B-Instruct-v0.1"])
435
+ @step
436
+ def pull_model_from_huggingface(self):
437
+ path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
438
+ ```
439
+
440
+ ```python
441
+ @huggingface_hub(load=[("mistralai/Mistral-7B-Instruct-v0.1", "/my-directory"), ("myorg/mistral-lora, "/my-lora-directory")])
442
+ @step
443
+ def finetune_model(self):
444
+ path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
445
+ # path_to_model will be /my-directory
446
+ ```
447
+
448
+ ```python
449
+ # Takes all the arguments passed to `snapshot_download`
450
+ # except for `local_dir`
451
+ @huggingface_hub(load=[
452
+ {
453
+ "repo_id": "mistralai/Mistral-7B-Instruct-v0.1",
454
+ },
455
+ {
456
+ "repo_id": "myorg/mistral-lora",
457
+ "repo_type": "model",
458
+ },
459
+ ])
460
+ @step
461
+ def finetune_model(self):
462
+ path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
463
+ # path_to_model will be /my-directory
464
+ ```
465
+ """
466
+ ...
467
+ @property
432
468
  def trigger(self) -> "metaflow.events.Trigger":
433
469
  """
434
- (only in the presence of the @trigger, or @trigger_on_finish decorators)
470
+ (only in the presence of the @trigger_on_finish, or @trigger decorators)
435
471
 
436
472
  Returns `Trigger` if the current run is triggered by an event
437
473
 
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.033941 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.395124 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:12.976392 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.344336 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:12.977607 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.345522 #
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.exception
12
11
  import typing
13
12
  import metaflow.parameters
14
13
  import metaflow._vendor.click.types
14
+ import metaflow.exception
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.000091 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.362909 #
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.unbounded_foreach
12
11
  import metaflow.plugins.cards.card_modules.card
12
+ import metaflow.unbounded_foreach
13
13
 
14
14
  CLIS_DESC: list
15
15
 
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.026808 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.388841 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.068862 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.428066 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.067744 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.427028 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.069173 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.428360 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.080017 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.438628 #
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.exception
12
11
  import metaflow.decorators
12
+ import metaflow.exception
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.080436 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.439038 #
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
11
12
  import metaflow.plugins.airflow.sensors.base_sensor
12
13
  import metaflow.exception
13
- import metaflow.decorators
14
14
 
15
15
  class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
16
16
  """
@@ -1,16 +1,16 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.080813 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.439414 #
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
11
12
  import metaflow.plugins.airflow.sensors.base_sensor
12
13
  import metaflow.exception
13
- import metaflow.decorators
14
14
 
15
15
  class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
16
16
  """
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-11-04T20:32:13.021990 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1) #
4
+ # Generated on 2024-11-13T19:05:29.387038 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations