ob-metaflow-stubs 6.0.3.126__py2.py3-none-any.whl → 6.0.3.127__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (173) hide show
  1. metaflow-stubs/__init__.pyi +197 -191
  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 +3 -3
  8. metaflow-stubs/client/filecache.pyi +1 -1
  9. metaflow-stubs/events.pyi +1 -1
  10. metaflow-stubs/exception.pyi +1 -1
  11. metaflow-stubs/flowspec.pyi +5 -5
  12. metaflow-stubs/generated_for.txt +1 -1
  13. metaflow-stubs/includefile.pyi +3 -3
  14. metaflow-stubs/info_file.pyi +1 -1
  15. metaflow-stubs/metadata_provider/__init__.pyi +1 -1
  16. metaflow-stubs/metadata_provider/heartbeat.pyi +1 -1
  17. metaflow-stubs/metadata_provider/metadata.pyi +1 -1
  18. metaflow-stubs/metadata_provider/util.pyi +1 -1
  19. metaflow-stubs/metaflow_config.pyi +1 -1
  20. metaflow-stubs/metaflow_current.pyi +110 -110
  21. metaflow-stubs/mf_extensions/__init__.pyi +1 -1
  22. metaflow-stubs/mf_extensions/obcheckpoint/__init__.pyi +1 -1
  23. metaflow-stubs/mf_extensions/obcheckpoint/plugins/__init__.pyi +1 -1
  24. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/__init__.pyi +1 -1
  25. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/__init__.pyi +1 -1
  26. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/checkpoint_storage.pyi +2 -2
  27. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/constructors.pyi +1 -1
  28. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/core.pyi +2 -2
  29. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/exceptions.pyi +1 -1
  30. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/final_api.pyi +2 -2
  31. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/__init__.pyi +1 -1
  32. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/core.pyi +1 -1
  33. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/exceptions.pyi +1 -1
  34. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/task_utils.pyi +2 -2
  35. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/utils.pyi +1 -1
  36. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastructures.pyi +2 -2
  37. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/exceptions.pyi +1 -1
  38. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/__init__.pyi +1 -1
  39. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/flowspec_utils.pyi +1 -1
  40. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/general.pyi +1 -1
  41. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/identity_utils.pyi +1 -1
  42. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/tar_utils.pyi +2 -2
  43. metaflow-stubs/mf_extensions/outerbounds/__init__.pyi +1 -1
  44. metaflow-stubs/mf_extensions/outerbounds/plugins/__init__.pyi +1 -1
  45. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/__init__.pyi +1 -1
  46. metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/snowflake.pyi +1 -1
  47. metaflow-stubs/mf_extensions/outerbounds/profilers/__init__.pyi +1 -1
  48. metaflow-stubs/mf_extensions/outerbounds/profilers/gpu.pyi +1 -1
  49. metaflow-stubs/mf_extensions/outerbounds/remote_config.pyi +1 -1
  50. metaflow-stubs/mf_extensions/outerbounds/toplevel/__init__.pyi +1 -1
  51. metaflow-stubs/mf_extensions/outerbounds/toplevel/global_aliases_for_metaflow_package.pyi +1 -1
  52. metaflow-stubs/multicore_utils.pyi +1 -1
  53. metaflow-stubs/parameters.pyi +3 -3
  54. metaflow-stubs/plugins/__init__.pyi +11 -11
  55. metaflow-stubs/plugins/airflow/__init__.pyi +1 -1
  56. metaflow-stubs/plugins/airflow/airflow_utils.pyi +1 -1
  57. metaflow-stubs/plugins/airflow/exception.pyi +1 -1
  58. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +1 -1
  59. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +1 -1
  60. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +1 -1
  61. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +1 -1
  62. metaflow-stubs/plugins/argo/__init__.pyi +1 -1
  63. metaflow-stubs/plugins/argo/argo_client.pyi +1 -1
  64. metaflow-stubs/plugins/argo/argo_events.pyi +1 -1
  65. metaflow-stubs/plugins/argo/argo_workflows.pyi +1 -1
  66. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +1 -1
  67. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  68. metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +2 -2
  69. metaflow-stubs/plugins/aws/__init__.pyi +1 -1
  70. metaflow-stubs/plugins/aws/aws_client.pyi +1 -1
  71. metaflow-stubs/plugins/aws/aws_utils.pyi +1 -1
  72. metaflow-stubs/plugins/aws/batch/__init__.pyi +1 -1
  73. metaflow-stubs/plugins/aws/batch/batch.pyi +1 -1
  74. metaflow-stubs/plugins/aws/batch/batch_client.pyi +1 -1
  75. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +1 -1
  76. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +1 -1
  77. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +3 -3
  78. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +1 -1
  79. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +1 -1
  80. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +1 -1
  81. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +1 -1
  82. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +1 -1
  83. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +3 -3
  84. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +2 -2
  85. metaflow-stubs/plugins/azure/__init__.pyi +1 -1
  86. metaflow-stubs/plugins/azure/azure_credential.pyi +1 -1
  87. metaflow-stubs/plugins/azure/azure_exceptions.pyi +1 -1
  88. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +3 -3
  89. metaflow-stubs/plugins/azure/azure_utils.pyi +1 -1
  90. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +1 -1
  91. metaflow-stubs/plugins/azure/includefile_support.pyi +1 -1
  92. metaflow-stubs/plugins/cards/__init__.pyi +5 -5
  93. metaflow-stubs/plugins/cards/card_client.pyi +1 -1
  94. metaflow-stubs/plugins/cards/card_creator.pyi +1 -1
  95. metaflow-stubs/plugins/cards/card_datastore.pyi +1 -1
  96. metaflow-stubs/plugins/cards/card_decorator.pyi +1 -1
  97. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +1 -1
  98. metaflow-stubs/plugins/cards/card_modules/basic.pyi +1 -1
  99. metaflow-stubs/plugins/cards/card_modules/card.pyi +1 -1
  100. metaflow-stubs/plugins/cards/card_modules/components.pyi +2 -2
  101. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +1 -1
  102. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +1 -1
  103. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +1 -1
  104. metaflow-stubs/plugins/cards/card_resolver.pyi +1 -1
  105. metaflow-stubs/plugins/cards/component_serializer.pyi +1 -1
  106. metaflow-stubs/plugins/cards/exception.pyi +1 -1
  107. metaflow-stubs/plugins/catch_decorator.pyi +2 -2
  108. metaflow-stubs/plugins/datatools/__init__.pyi +1 -1
  109. metaflow-stubs/plugins/datatools/local.pyi +1 -1
  110. metaflow-stubs/plugins/datatools/s3/__init__.pyi +1 -1
  111. metaflow-stubs/plugins/datatools/s3/s3.pyi +2 -2
  112. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +1 -1
  113. metaflow-stubs/plugins/datatools/s3/s3util.pyi +1 -1
  114. metaflow-stubs/plugins/debug_logger.pyi +1 -1
  115. metaflow-stubs/plugins/debug_monitor.pyi +1 -1
  116. metaflow-stubs/plugins/environment_decorator.pyi +1 -1
  117. metaflow-stubs/plugins/events_decorator.pyi +1 -1
  118. metaflow-stubs/plugins/frameworks/__init__.pyi +1 -1
  119. metaflow-stubs/plugins/frameworks/pytorch.pyi +1 -1
  120. metaflow-stubs/plugins/gcp/__init__.pyi +1 -1
  121. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +3 -3
  122. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +1 -1
  123. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +1 -1
  124. metaflow-stubs/plugins/gcp/gs_utils.pyi +1 -1
  125. metaflow-stubs/plugins/gcp/includefile_support.pyi +1 -1
  126. metaflow-stubs/plugins/kubernetes/__init__.pyi +1 -1
  127. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +1 -1
  128. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +2 -2
  129. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +1 -1
  130. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +1 -1
  131. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +1 -1
  132. metaflow-stubs/plugins/parallel_decorator.pyi +1 -1
  133. metaflow-stubs/plugins/perimeters.pyi +1 -1
  134. metaflow-stubs/plugins/project_decorator.pyi +1 -1
  135. metaflow-stubs/plugins/pypi/__init__.pyi +2 -2
  136. metaflow-stubs/plugins/pypi/conda_decorator.pyi +1 -1
  137. metaflow-stubs/plugins/pypi/conda_environment.pyi +3 -3
  138. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +1 -1
  139. metaflow-stubs/plugins/pypi/pypi_environment.pyi +1 -1
  140. metaflow-stubs/plugins/pypi/utils.pyi +1 -1
  141. metaflow-stubs/plugins/resources_decorator.pyi +1 -1
  142. metaflow-stubs/plugins/retry_decorator.pyi +1 -1
  143. metaflow-stubs/plugins/secrets/__init__.pyi +2 -2
  144. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +2 -2
  145. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +1 -1
  146. metaflow-stubs/plugins/snowflake/__init__.pyi +1 -1
  147. metaflow-stubs/plugins/storage_executor.pyi +1 -1
  148. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +1 -1
  149. metaflow-stubs/plugins/timeout_decorator.pyi +2 -2
  150. metaflow-stubs/profilers/__init__.pyi +1 -1
  151. metaflow-stubs/pylint_wrapper.pyi +1 -1
  152. metaflow-stubs/runner/__init__.pyi +1 -1
  153. metaflow-stubs/runner/deployer.pyi +4 -4
  154. metaflow-stubs/runner/deployer_impl.pyi +2 -2
  155. metaflow-stubs/runner/metaflow_runner.pyi +1 -1
  156. metaflow-stubs/runner/nbdeploy.pyi +1 -1
  157. metaflow-stubs/runner/nbrun.pyi +1 -1
  158. metaflow-stubs/runner/subprocess_manager.pyi +1 -1
  159. metaflow-stubs/runner/utils.pyi +3 -3
  160. metaflow-stubs/system/__init__.pyi +1 -1
  161. metaflow-stubs/system/system_logger.pyi +2 -2
  162. metaflow-stubs/system/system_monitor.pyi +1 -1
  163. metaflow-stubs/tagging_util.pyi +1 -1
  164. metaflow-stubs/tuple_util.pyi +1 -1
  165. metaflow-stubs/user_configs/__init__.pyi +1 -1
  166. metaflow-stubs/user_configs/config_decorators.pyi +5 -5
  167. metaflow-stubs/user_configs/config_options.pyi +3 -3
  168. metaflow-stubs/user_configs/config_parameters.pyi +6 -6
  169. {ob_metaflow_stubs-6.0.3.126.dist-info → ob_metaflow_stubs-6.0.3.127.dist-info}/METADATA +1 -1
  170. ob_metaflow_stubs-6.0.3.127.dist-info/RECORD +173 -0
  171. ob_metaflow_stubs-6.0.3.126.dist-info/RECORD +0 -173
  172. {ob_metaflow_stubs-6.0.3.126.dist-info → ob_metaflow_stubs-6.0.3.127.dist-info}/WHEEL +0 -0
  173. {ob_metaflow_stubs-6.0.3.126.dist-info → ob_metaflow_stubs-6.0.3.127.dist-info}/top_level.txt +0 -0
@@ -1,18 +1,18 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.777810 #
4
+ # Generated on 2024-12-17T21:56:50.923994 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import typing
10
9
  import metaflow
10
+ import typing
11
11
  if typing.TYPE_CHECKING:
12
12
  import datetime
13
- import tarfile
14
13
  import metaflow.client.core
15
14
  import typing
15
+ import tarfile
16
16
  import metaflow.events
17
17
 
18
18
  from ..metaflow_current import current as current
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.803314 #
4
+ # Generated on 2024-12-17T21:56:50.950083 #
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
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.770393 #
4
+ # Generated on 2024-12-17T21:56:50.916997 #
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.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.762575 #
4
+ # Generated on 2024-12-17T21:56:50.908634 #
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.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.767148 #
4
+ # Generated on 2024-12-17T21:56:50.913258 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import typing
10
9
  import metaflow
10
+ import typing
11
11
  if typing.TYPE_CHECKING:
12
- import metaflow.datastore.inputs
13
- import metaflow.flowspec
14
- import typing
15
12
  import metaflow.exception
16
13
  import metaflow.unbounded_foreach
14
+ import metaflow.datastore.inputs
15
+ import typing
16
+ import metaflow.flowspec
17
17
 
18
18
  from . import parameters as parameters
19
19
  from .parameters import DelayedEvaluationParameter as DelayedEvaluationParameter
@@ -1 +1 @@
1
- 2.12.39.1+obcheckpoint(0.1.4);ob(v1) 2024-12-17T01:10:55.759379
1
+ 2.12.39.1+obcheckpoint(0.1.4);ob(v1) 2024-12-17T21:56:50.905462
@@ -1,17 +1,17 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.773234 #
4
+ # Generated on 2024-12-17T21:56:50.919346 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import typing
10
9
  import metaflow
10
+ import typing
11
11
  if typing.TYPE_CHECKING:
12
+ import metaflow._vendor.click.types
12
13
  import typing
13
14
  import metaflow.parameters
14
- import metaflow._vendor.click.types
15
15
 
16
16
  from ._vendor import click as click
17
17
  from .exception import MetaflowException as MetaflowException
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.761723 #
4
+ # Generated on 2024-12-17T21:56:50.907836 #
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.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.766075 #
4
+ # Generated on 2024-12-17T21:56:50.912122 #
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.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.787714 #
4
+ # Generated on 2024-12-17T21:56:50.934178 #
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.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.787220 #
4
+ # Generated on 2024-12-17T21:56:50.933672 #
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.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.787451 #
4
+ # Generated on 2024-12-17T21:56:50.933911 #
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.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.763608 #
4
+ # Generated on 2024-12-17T21:56:50.909666 #
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.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.901107 #
4
+ # Generated on 2024-12-17T21:56:51.046031 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
12
- import metaflow.events
11
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
13
12
  import metaflow
14
13
  import metaflow.metaflow_current
14
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
15
15
  import metaflow.plugins.cards.component_serializer
16
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
17
16
  import typing
18
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
17
+ import metaflow.events
18
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
19
19
 
20
20
 
21
21
  TYPE_CHECKING: bool
@@ -228,32 +228,21 @@ class Current(object, metaclass=type):
228
228
  def graph(self):
229
229
  ...
230
230
  @property
231
- def parallel(self) -> "metaflow.metaflow_current.Parallel":
231
+ def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
232
232
  """
233
- (only in the presence of the @parallel decorator)
233
+ (only in the presence of the @card decorator)
234
234
 
235
- Returns a namedtuple with relevant information about the parallel task.
235
+ The `@card` decorator makes the cards available through the `current.card`
236
+ object. If multiple `@card` decorators are present, you can add an `ID` to
237
+ distinguish between them using `@card(id=ID)` as the decorator. You will then
238
+ be able to access that specific card using `current.card[ID].
239
+
240
+ Methods available are `append` and `extend`
236
241
 
237
242
  Returns
238
243
  -------
239
- Parallel
240
- `namedtuple` with the following fields:
241
- - main_ip (`str`)
242
- The IP address of the control task.
243
- - num_nodes (`int`)
244
- The total number of tasks created by @parallel
245
- - node_index (`int`)
246
- The index of the current task in all the @parallel tasks.
247
- - control_task_id (`Optional[str]`)
248
- The task ID of the control task. Available to all tasks.
249
- """
250
- ...
251
- @property
252
- def is_parallel(self) -> bool:
253
- """
254
- (only in the presence of the @parallel decorator)
255
-
256
- True if the current step is a @parallel step.
244
+ CardComponentCollector
245
+ The or one of the cards attached to this step.
257
246
  """
258
247
  ...
259
248
  @property
@@ -318,72 +307,32 @@ class Current(object, metaclass=type):
318
307
  """
319
308
  ...
320
309
  @property
321
- def huggingface_hub(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
310
+ def parallel(self) -> "metaflow.metaflow_current.Parallel":
322
311
  """
323
- (only in the presence of the @huggingface_hub decorator)
324
-
325
- The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
326
- over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
327
- [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
328
- The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
329
- `<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.
330
-
331
-
332
- Usage:
333
- ------
334
-
335
- **Usage: creating references of models from huggingface that may be loaded in downstream steps**
336
- ```python
337
- @huggingface_hub
338
- @step
339
- def pull_model_from_huggingface(self):
340
- # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
341
- # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
342
- # with the same `repo_id` in the backend storage, it will not download the model again. The return
343
- # value of the function is a reference to the model in the backend storage.
344
- # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
345
-
346
- self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
347
- self.llama_model = current.huggingface_hub.snapshot_download(
348
- repo_id=self.model_id,
349
- allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
350
- )
351
- self.next(self.train)
352
- ```
312
+ (only in the presence of the @parallel decorator)
353
313
 
354
- **Usage: loading models directly from huggingface hub or from cache (from metaflow's datastore)**
355
- ```python
356
- @huggingface_hub(load=["mistralai/Mistral-7B-Instruct-v0.1"])
357
- @step
358
- def pull_model_from_huggingface(self):
359
- path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
360
- ```
314
+ Returns a namedtuple with relevant information about the parallel task.
361
315
 
362
- ```python
363
- @huggingface_hub(load=[("mistralai/Mistral-7B-Instruct-v0.1", "/my-directory"), ("myorg/mistral-lora, "/my-lora-directory")])
364
- @step
365
- def finetune_model(self):
366
- path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
367
- # path_to_model will be /my-directory
368
- ```
316
+ Returns
317
+ -------
318
+ Parallel
319
+ `namedtuple` with the following fields:
320
+ - main_ip (`str`)
321
+ The IP address of the control task.
322
+ - num_nodes (`int`)
323
+ The total number of tasks created by @parallel
324
+ - node_index (`int`)
325
+ The index of the current task in all the @parallel tasks.
326
+ - control_task_id (`Optional[str]`)
327
+ The task ID of the control task. Available to all tasks.
328
+ """
329
+ ...
330
+ @property
331
+ def is_parallel(self) -> bool:
332
+ """
333
+ (only in the presence of the @parallel decorator)
369
334
 
370
- ```python
371
- # Takes all the arguments passed to `snapshot_download`
372
- # except for `local_dir`
373
- @huggingface_hub(load=[
374
- {
375
- "repo_id": "mistralai/Mistral-7B-Instruct-v0.1",
376
- },
377
- {
378
- "repo_id": "myorg/mistral-lora",
379
- "repo_type": "model",
380
- },
381
- ])
382
- @step
383
- def finetune_model(self):
384
- path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
385
- # path_to_model will be /my-directory
386
- ```
335
+ True if the current step is a @parallel step.
387
336
  """
388
337
  ...
389
338
  @property
@@ -448,21 +397,85 @@ class Current(object, metaclass=type):
448
397
  """
449
398
  ...
450
399
  @property
451
- def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
400
+ def huggingface_hub(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
452
401
  """
453
- (only in the presence of the @card decorator)
402
+ (only in the presence of the @huggingface_hub decorator)
454
403
 
455
- The `@card` decorator makes the cards available through the `current.card`
456
- object. If multiple `@card` decorators are present, you can add an `ID` to
457
- distinguish between them using `@card(id=ID)` as the decorator. You will then
458
- be able to access that specific card using `current.card[ID].
404
+ The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
405
+ over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
406
+ [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
407
+ The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
408
+ `<repo_type>/<repo_id>` name. The `repo_type` is by default `model` and can be overriden by passing the `repo_type` parameter to the `snapshot_download` function.
459
409
 
460
- Methods available are `append` and `extend`
410
+
411
+ Usage:
412
+ ------
413
+
414
+ **Usage: creating references of models from huggingface that may be loaded in downstream steps**
415
+ ```python
416
+ @huggingface_hub
417
+ @step
418
+ def pull_model_from_huggingface(self):
419
+ # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
420
+ # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
421
+ # with the same `repo_id` in the backend storage, it will not download the model again. The return
422
+ # value of the function is a reference to the model in the backend storage.
423
+ # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
424
+
425
+ self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
426
+ self.llama_model = current.huggingface_hub.snapshot_download(
427
+ repo_id=self.model_id,
428
+ allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
429
+ )
430
+ self.next(self.train)
431
+ ```
432
+
433
+ **Usage: loading models directly from huggingface hub or from cache (from metaflow's datastore)**
434
+ ```python
435
+ @huggingface_hub(load=["mistralai/Mistral-7B-Instruct-v0.1"])
436
+ @step
437
+ def pull_model_from_huggingface(self):
438
+ path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
439
+ ```
440
+
441
+ ```python
442
+ @huggingface_hub(load=[("mistralai/Mistral-7B-Instruct-v0.1", "/my-directory"), ("myorg/mistral-lora, "/my-lora-directory")])
443
+ @step
444
+ def finetune_model(self):
445
+ path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
446
+ # path_to_model will be /my-directory
447
+ ```
448
+
449
+ ```python
450
+ # Takes all the arguments passed to `snapshot_download`
451
+ # except for `local_dir`
452
+ @huggingface_hub(load=[
453
+ {
454
+ "repo_id": "mistralai/Mistral-7B-Instruct-v0.1",
455
+ },
456
+ {
457
+ "repo_id": "myorg/mistral-lora",
458
+ "repo_type": "model",
459
+ },
460
+ ])
461
+ @step
462
+ def finetune_model(self):
463
+ path_to_model = current.huggingface_hub.loaded["mistralai/Mistral-7B-Instruct-v0.1"]
464
+ # path_to_model will be /my-directory
465
+ ```
466
+ """
467
+ ...
468
+ @property
469
+ def trigger(self) -> "metaflow.events.Trigger":
470
+ """
471
+ (only in the presence of the @trigger_on_finish, or @trigger decorators)
472
+
473
+ Returns `Trigger` if the current run is triggered by an event
461
474
 
462
475
  Returns
463
476
  -------
464
- CardComponentCollector
465
- The or one of the cards attached to this step.
477
+ Trigger
478
+ `Trigger` if triggered by an event
466
479
  """
467
480
  ...
468
481
  @property
@@ -532,19 +545,6 @@ class Current(object, metaclass=type):
532
545
  True if the flow is deployed with `--production`.
533
546
  """
534
547
  ...
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,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.771989 #
4
+ # Generated on 2024-12-17T21:56:50.918249 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.780600 #
4
+ # Generated on 2024-12-17T21:56:50.926884 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.780664 #
4
+ # Generated on 2024-12-17T21:56:50.926948 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.780723 #
4
+ # Generated on 2024-12-17T21:56:50.927008 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.780781 #
4
+ # Generated on 2024-12-17T21:56:50.927066 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.865060 #
4
+ # Generated on 2024-12-17T21:56:51.013938 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,10 +9,10 @@ from __future__ import annotations
9
9
  import metaflow
10
10
  import typing
11
11
  if typing.TYPE_CHECKING:
12
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
12
13
  import metaflow.datastore.datastore_storage
13
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
14
15
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
15
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
16
16
 
17
17
  from ..exceptions import KeyNotCompatibleWithObjectException as KeyNotCompatibleWithObjectException
18
18
  from ..utils.identity_utils import pathspec_hash as pathspec_hash
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.803612 #
4
+ # Generated on 2024-12-17T21:56:50.950387 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,17 +1,17 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.826477 #
4
+ # Generated on 2024-12-17T21:56:50.974016 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
12
11
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
12
  import metaflow
14
13
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.core
14
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
15
15
 
16
16
  from ......metaflow_current import current as current
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.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.803826 #
4
+ # Generated on 2024-12-17T21:56:50.950605 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,15 +1,15 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.780827 #
4
+ # Generated on 2024-12-17T21:56:50.927112 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
12
11
  import metaflow
12
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
13
 
14
14
  from ..datastructures import CheckpointArtifact as CheckpointArtifact
15
15
  from .constructors import load_checkpoint as load_checkpoint
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.804429 #
4
+ # Generated on 2024-12-17T21:56:50.951215 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.827688 #
4
+ # Generated on 2024-12-17T21:56:50.975275 #
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.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.880630 #
4
+ # Generated on 2024-12-17T21:56:51.030083 #
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.12.39.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-12-17T01:10:55.804479 #
4
+ # Generated on 2024-12-17T21:56:50.951266 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
- import typing
10
9
  import metaflow
10
+ import typing
11
11
  if typing.TYPE_CHECKING:
12
12
  import metaflow.exception
13
13
  import metaflow