ob-metaflow-stubs 6.0.3.113__py2.py3-none-any.whl → 6.0.3.114__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 +676 -673
  2. metaflow-stubs/cards.pyi +5 -5
  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 +5 -5
  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 +3 -3
  15. metaflow-stubs/metadata/util.pyi +2 -2
  16. metaflow-stubs/metaflow_config.pyi +2 -2
  17. metaflow-stubs/metaflow_current.pyi +106 -105
  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 +2 -2
  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 +2 -2
  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 +11 -2
  31. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  32. metaflow-stubs/plugins/argo/argo_workflows.pyi +3 -3
  33. metaflow-stubs/plugins/argo/argo_workflows_cli.pyi +8 -5
  34. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +6 -6
  35. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  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 +3 -3
  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 +3 -3
  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 +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 +3 -3
  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 +3 -3
  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 +2 -2
  77. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  78. metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
  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 +3 -3
  86. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  87. metaflow-stubs/plugins/frameworks/pytorch.pyi +8 -7
  88. metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
  89. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +3 -3
  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 +5 -2
  98. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  99. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +6 -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 +8 -7
  104. metaflow-stubs/plugins/perimeters.pyi +2 -2
  105. metaflow-stubs/plugins/project_decorator.pyi +3 -3
  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 +2 -2
  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 +2 -2
  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 +5 -8
  127. metaflow-stubs/runner/nbdeploy.pyi +5 -7
  128. metaflow-stubs/runner/nbrun.pyi +5 -7
  129. metaflow-stubs/runner/subprocess_manager.pyi +2 -2
  130. metaflow-stubs/runner/utils.pyi +2 -6
  131. metaflow-stubs/system/__init__.pyi +3 -3
  132. metaflow-stubs/system/system_logger.pyi +2 -2
  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.113.dist-info → ob_metaflow_stubs-6.0.3.114.dist-info}/METADATA +1 -1
  137. ob_metaflow_stubs-6.0.3.114.dist-info/RECORD +140 -0
  138. ob_metaflow_stubs-6.0.3.113.dist-info/RECORD +0 -140
  139. {ob_metaflow_stubs-6.0.3.113.dist-info → ob_metaflow_stubs-6.0.3.114.dist-info}/WHEEL +0 -0
  140. {ob_metaflow_stubs-6.0.3.113.dist-info → ob_metaflow_stubs-6.0.3.114.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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.387703 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.137003 #
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.basic
12
11
  import metaflow
13
- import metaflow.plugins.cards.card_modules.card
14
12
  import metaflow.plugins.cards.card_modules.components
15
- import typing
13
+ import metaflow.plugins.cards.card_modules.basic
16
14
  import metaflow.plugins.cards.card_client
15
+ import metaflow.plugins.cards.card_modules.card
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,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.404735 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.153873 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.395020 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.143901 #
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 datetime
12
- import metaflow.client.core
13
12
  import metaflow.events
14
13
  import typing
14
+ import metaflow.client.core
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.384288 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.132836 #
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
12
- import metaflow
13
- import typing
14
11
  import tarfile
12
+ import metaflow
13
+ import metaflow.events
15
14
  import metaflow.exception
16
15
  import metaflow.client.core
17
16
  import metaflow.metaflow_current
18
- import metaflow.events
17
+ import datetime
18
+ import typing
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.405609 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.154756 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.403572 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.152712 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.388296 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.134915 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.376614 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.124998 #
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.25.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.385685 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.134316 #
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.unbounded_foreach
13
+ import metaflow.datastore.inputs
13
14
  import metaflow.parameters
14
- import typing
15
15
  import metaflow.exception
16
- import metaflow.unbounded_foreach
16
+ import typing
17
17
 
18
18
  class DelayedEvaluationParameter(object, metaclass=type):
19
19
  """
@@ -1 +1 @@
1
- 2.12.25.2+obcheckpoint(0.1.1);ob(v1) 2024-10-22T22:37:22.361070
1
+ 2.12.26.1+obcheckpoint(0.1.1);ob(v1) 2024-10-23T20:57:01.109645
@@ -1,18 +1,18 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.391054 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.139910 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
+ import io
11
12
  import metaflow.parameters
13
+ import metaflow.plugins.datatools.s3.s3
12
14
  import metaflow._vendor.click.types
13
15
  import typing
14
- import metaflow.plugins.datatools.s3.s3
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.375808 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.124316 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.429080 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.179096 #
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.25.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.472674 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.216115 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.377721 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.126055 #
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.25.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.475348 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.226367 #
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.component_serializer
11
+ import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
12
12
  import metaflow
13
+ import metaflow.events
14
+ import metaflow.metaflow_current
15
+ import metaflow.plugins.cards.component_serializer
13
16
  import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
14
- import typing
15
17
  import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
16
- import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
17
- import metaflow.metaflow_current
18
- import metaflow.events
18
+ import typing
19
19
 
20
20
  TYPE_CHECKING: bool
21
21
 
@@ -227,6 +227,67 @@ class Current(object, metaclass=type):
227
227
  def graph(_):
228
228
  ...
229
229
  @property
230
+ def checkpoint(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
231
+ """
232
+ (only in the presence of the @checkpoint decorator)
233
+
234
+ The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
235
+ The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
236
+
237
+ You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
238
+ by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
239
+ where the checkpoint maybe loaded or saved.
240
+
241
+ Usage (Saving Checkpoints):
242
+ -------
243
+ ```
244
+ @checkpoint
245
+ @step
246
+ def train(self):
247
+ model = create_model(self.parameters, checkpoint_path = None)
248
+ for i in range(self.epochs):
249
+ # some training logic
250
+ loss = model.train(self.dataset)
251
+ if i % 10 == 0:
252
+ model.save(
253
+ current.checkpoint.directory,
254
+ )
255
+ # saves the contents of the `current.checkpoint.directory` as a checkpoint
256
+ # and returns a reference dictionary to the checkpoint saved in the datastore
257
+ self.latest_checkpoint = current.checkpoint.save(
258
+ name="epoch_checkpoint",
259
+ metadata={
260
+ "epoch": i,
261
+ "loss": loss,
262
+ }
263
+ )
264
+ ```
265
+ Usage (Using Loaded Checkpoints):
266
+ -------
267
+ ```
268
+ @retry(times=3)
269
+ @checkpoint
270
+ @step
271
+ def train(self):
272
+ # Assume that the task has restarted and the previous attempt of the task
273
+ # saved a checkpoint
274
+ checkpoint_path = None
275
+ if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
276
+ print("Loaded checkpoint from the previous attempt")
277
+ checkpoint_path = current.checkpoint.directory
278
+
279
+ model = create_model(self.parameters, checkpoint_path = checkpoint_path)
280
+ for i in range(self.epochs):
281
+ ...
282
+ ```
283
+
284
+ Returns
285
+ -------
286
+ CurrentCheckpointer
287
+ The object for handling checkpointing within a step.
288
+ """
289
+ ...
290
+ @property
230
291
  def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
231
292
  """
232
293
  (only in the presence of the @card decorator)
@@ -249,18 +310,19 @@ class Current(object, metaclass=type):
249
310
  """
250
311
  (only in the presence of the @parallel decorator)
251
312
 
313
+ Returns a namedtuple with relevant information about the parallel task.
252
314
 
253
315
  Returns
254
316
  -------
255
317
  Parallel
256
318
  `namedtuple` with the following fields:
257
- - main_ip : str
319
+ - main_ip (`str`)
258
320
  The IP address of the control task.
259
- - num_nodes : int
321
+ - num_nodes (`int`)
260
322
  The total number of tasks created by @parallel
261
- - node_index : int
323
+ - node_index (`int`)
262
324
  The index of the current task in all the @parallel tasks.
263
- - control_task_id : Optional[str]
325
+ - control_task_id (`Optional[str]`)
264
326
  The task ID of the control task. Available to all tasks.
265
327
  """
266
328
  ...
@@ -273,6 +335,39 @@ class Current(object, metaclass=type):
273
335
  """
274
336
  ...
275
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
276
371
  def model(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
277
372
  """
278
373
  (only in the presence of the @model decorator)
@@ -334,100 +429,6 @@ class Current(object, metaclass=type):
334
429
  """
335
430
  ...
336
431
  @property
337
- def checkpoint(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
338
- """
339
- (only in the presence of the @checkpoint decorator)
340
-
341
- The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
342
- The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
343
-
344
- You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
345
- by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
346
- where the checkpoint maybe loaded or saved.
347
-
348
- Usage (Saving Checkpoints):
349
- -------
350
- ```
351
- @checkpoint
352
- @step
353
- def train(self):
354
- model = create_model(self.parameters, checkpoint_path = None)
355
- for i in range(self.epochs):
356
- # some training logic
357
- loss = model.train(self.dataset)
358
- if i % 10 == 0:
359
- model.save(
360
- current.checkpoint.directory,
361
- )
362
- # saves the contents of the `current.checkpoint.directory` as a checkpoint
363
- # and returns a reference dictionary to the checkpoint saved in the datastore
364
- self.latest_checkpoint = current.checkpoint.save(
365
- name="epoch_checkpoint",
366
- metadata={
367
- "epoch": i,
368
- "loss": loss,
369
- }
370
- )
371
- ```
372
- Usage (Using Loaded Checkpoints):
373
- -------
374
- ```
375
- @retry(times=3)
376
- @checkpoint
377
- @step
378
- def train(self):
379
- # Assume that the task has restarted and the previous attempt of the task
380
- # saved a checkpoint
381
- checkpoint_path = None
382
- if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
383
- print("Loaded checkpoint from the previous attempt")
384
- checkpoint_path = current.checkpoint.directory
385
-
386
- model = create_model(self.parameters, checkpoint_path = checkpoint_path)
387
- for i in range(self.epochs):
388
- ...
389
- ```
390
-
391
- Returns
392
- -------
393
- CurrentCheckpointer
394
- The object for handling checkpointing within a step.
395
- """
396
- ...
397
- @property
398
- def huggingface_hub(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
399
- """
400
- (only in the presence of the @huggingface_hub decorator)
401
-
402
- The `@huggingface_hub` injects a `huggingface_hub` object into the `current` object. This object provides syntactic sugar
403
- over [huggingface_hub](https://github.com/huggingface/huggingface_hub)'s
404
- [snapshot_download](https://huggingface.co/docs/huggingface_hub/main/en/package_reference/file_download#huggingface_hub.snapshot_download) function.
405
- The `current.huggingface_hub.snapshot_download` function downloads objects from huggingface hub and saves them to the Metaflow's datastore under the
406
- `<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.
407
-
408
-
409
- Usage:
410
- ------
411
- ```python
412
- @huggingface_hub
413
- @step
414
- def pull_model_from_huggingface(self):
415
- # `current.huggingface_hub.snapshot_download` downloads the model from the Hugging Face Hub
416
- # and saves it in the backend storage based on the model's `repo_id`. If there exists a model
417
- # with the same `repo_id` in the backend storage, it will not download the model again. The return
418
- # value of the function is a reference to the model in the backend storage.
419
- # This reference can be used to load the model in the subsequent steps via `@model(load=["llama_model"])`
420
-
421
- self.model_id = "mistralai/Mistral-7B-Instruct-v0.1"
422
- self.llama_model = current.huggingface_hub.snapshot_download(
423
- repo_id=self.model_id,
424
- allow_patterns=["*.safetensors", "*.json", "tokenizer.*"],
425
- )
426
- self.next(self.train)
427
- ```
428
- """
429
- ...
430
- @property
431
432
  def trigger(self) -> "metaflow.events.Trigger":
432
433
  """
433
434
  (only in the presence of the @trigger_on_finish, or @trigger decorators)
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.429403 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.179460 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.378128 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.126552 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.379308 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.127789 #
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
- import metaflow.exception
13
11
  import metaflow.parameters
12
+ import metaflow.exception
14
13
  import metaflow._vendor.click.types
14
+ import typing
15
15
 
16
16
  class ParameterFieldFailed(metaflow.exception.MetaflowException, metaclass=type):
17
17
  def __init__(self, name, field):
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.25.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.396846 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.145685 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.423180 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.173472 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.462510 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.213283 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.461572 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.212332 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.462857 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.213580 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.473205 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.224209 #
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.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.473726 #
3
+ # MF version: 2.12.26.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-23T20:57:01.224629 #
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.plugins.airflow.sensors.base_sensor
12
+ import metaflow.exception
13
13
  import metaflow.decorators
14
14
 
15
15
  class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):