ob-metaflow-stubs 6.0.3.113__py2.py3-none-any.whl → 6.0.3.115__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 +602 -599
  2. metaflow-stubs/cards.pyi +5 -5
  3. metaflow-stubs/cli.pyi +3 -3
  4. metaflow-stubs/client/__init__.pyi +5 -5
  5. metaflow-stubs/client/core.pyi +11 -9
  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 +6 -6
  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 +5 -2
  15. metaflow-stubs/metadata/util.pyi +2 -2
  16. metaflow-stubs/metaflow_config.pyi +2 -2
  17. metaflow-stubs/metaflow_current.pyi +91 -90
  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 +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 +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 +11 -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 +7 -4
  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 +4 -4
  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 +3 -3
  61. metaflow-stubs/plugins/cards/card_client.pyi +3 -3
  62. metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
  63. metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
  64. metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
  65. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
  66. metaflow-stubs/plugins/cards/card_modules/basic.pyi +2 -2
  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 +2 -2
  72. metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
  73. metaflow-stubs/plugins/cards/component_serializer.pyi +3 -3
  74. metaflow-stubs/plugins/cards/exception.pyi +2 -2
  75. metaflow-stubs/plugins/catch_decorator.pyi +3 -3
  76. metaflow-stubs/plugins/datatools/__init__.pyi +3 -3
  77. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  78. metaflow-stubs/plugins/datatools/s3/__init__.pyi +3 -3
  79. metaflow-stubs/plugins/datatools/s3/s3.pyi +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 +7 -6
  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 +3 -3
  97. metaflow-stubs/plugins/kubernetes/kubernetes_cli.pyi +6 -3
  98. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  99. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +7 -4
  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 +7 -6
  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 +3 -3
  111. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  112. metaflow-stubs/plugins/resources_decorator.pyi +3 -3
  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 -35
  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 +3 -3
  133. metaflow-stubs/system/system_monitor.pyi +3 -3
  134. metaflow-stubs/tagging_util.pyi +2 -2
  135. metaflow-stubs/tuple_util.pyi +2 -2
  136. {ob_metaflow_stubs-6.0.3.113.dist-info → ob_metaflow_stubs-6.0.3.115.dist-info}/METADATA +1 -1
  137. ob_metaflow_stubs-6.0.3.115.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.115.dist-info}/WHEEL +0 -0
  140. {ob_metaflow_stubs-6.0.3.113.dist-info → ob_metaflow_stubs-6.0.3.115.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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.745053 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
+ import typing
11
12
  import metaflow.plugins.cards.card_modules.basic
13
+ import metaflow.plugins.cards.card_client
12
14
  import metaflow
13
- import metaflow.plugins.cards.card_modules.card
14
15
  import metaflow.plugins.cards.card_modules.components
15
- import typing
16
- import metaflow.plugins.cards.card_client
16
+ import metaflow.plugins.cards.card_modules.card
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.25.2+obcheckpoint(0.1.1);ob(v1) #
4
- # Generated on 2024-10-22T22:37:22.404735 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.761596 #
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,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.395020 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.751982 #
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.events
11
13
  import datetime
12
14
  import metaflow.client.core
13
- import metaflow.events
14
- import typing
15
15
 
16
16
  def namespace(ns: typing.Optional[str]) -> typing.Optional[str]:
17
17
  """
@@ -132,7 +132,7 @@ class Metaflow(object, metaclass=type):
132
132
  flows present in the current namespace will be returned. A `Flow` is present in a namespace
133
133
  if it has at least one run in the namespace.
134
134
  """
135
- def __init__(self):
135
+ def __init__(self, _current_metadata: typing.Optional[str] = None):
136
136
  ...
137
137
  @property
138
138
  def flows(self) -> typing.List[metaflow.client.core.Flow]:
@@ -1,21 +1,23 @@
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.741608 #
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
11
  import typing
14
- import tarfile
15
- import metaflow.exception
16
- import metaflow.client.core
17
12
  import metaflow.metaflow_current
13
+ import datetime
18
14
  import metaflow.events
15
+ import metaflow.exception
16
+ import metaflow.client.core
17
+ import tarfile
18
+ import metaflow
19
+
20
+ TYPE_CHECKING: bool
19
21
 
20
22
  current: metaflow.metaflow_current.Current
21
23
 
@@ -349,7 +351,7 @@ class MetaflowObject(object, metaclass=type):
349
351
  Pathspec of the original object this object was cloned from (in the case of a resume).
350
352
  None if not applicable.
351
353
  """
352
- def __init__(self, pathspec: typing.Optional[str] = None, attempt: typing.Optional[int] = None, _object: typing.Optional["MetaflowObject"] = None, _parent: typing.Optional["MetaflowObject"] = None, _namespace_check: bool = True, _current_namespace: typing.Optional[str] = None):
354
+ def __init__(self, pathspec: typing.Optional[str] = None, attempt: typing.Optional[int] = None, _object: typing.Optional["MetaflowObject"] = None, _parent: typing.Optional["MetaflowObject"] = None, _namespace_check: bool = True, _metaflow: typing.Optional["Metaflow"] = None, _current_namespace: typing.Optional[str] = None, _current_metadata: typing.Optional[str] = None):
353
355
  ...
354
356
  def __iter__(self) -> typing.Iterator["MetaflowObject"]:
355
357
  """
@@ -1593,7 +1595,7 @@ class Metaflow(object, metaclass=type):
1593
1595
  flows present in the current namespace will be returned. A `Flow` is present in a namespace
1594
1596
  if it has at least one run in the namespace.
1595
1597
  """
1596
- def __init__(self):
1598
+ def __init__(self, _current_metadata: typing.Optional[str] = None):
1597
1599
  ...
1598
1600
  @property
1599
1601
  def flows(self) -> typing.List[Flow]:
@@ -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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.762456 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.760436 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.745670 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.732561 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.742986 #
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 metaflow.flowspec
13
- import metaflow.parameters
14
11
  import typing
15
- import metaflow.exception
16
12
  import metaflow.unbounded_foreach
13
+ import metaflow.parameters
14
+ import metaflow.exception
15
+ import metaflow.datastore.inputs
16
+ import metaflow.flowspec
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.27.1+obcheckpoint(0.1.1);ob(v1) 2024-10-25T21:39:54.716202
@@ -1,16 +1,16 @@
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.748434 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.parameters
12
- import metaflow._vendor.click.types
13
11
  import typing
12
+ import metaflow._vendor.click.types
13
+ import metaflow.parameters
14
14
  import metaflow.plugins.datatools.s3.s3
15
15
  import io
16
16
 
@@ -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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.731461 #
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.429080 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.786249 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -99,6 +99,9 @@ class ObjectOrder(object, metaclass=type):
99
99
 
100
100
  class MetadataProvider(object, metaclass=MetadataProviderMeta):
101
101
  @classmethod
102
+ def metadata_str(cls):
103
+ ...
104
+ @classmethod
102
105
  def compute_info(cls, val):
103
106
  """
104
107
  Compute the new information for this provider
@@ -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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.833493 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.734509 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.836176 #
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
12
- import metaflow
13
- import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
14
11
  import typing
15
- import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
16
- import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
17
12
  import metaflow.metaflow_current
18
13
  import metaflow.events
14
+ import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
15
+ import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
16
+ import metaflow.plugins.cards.component_serializer
17
+ import metaflow
18
+ import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
19
19
 
20
20
  TYPE_CHECKING: bool
21
21
 
@@ -227,49 +227,64 @@ class Current(object, metaclass=type):
227
227
  def graph(_):
228
228
  ...
229
229
  @property
230
- def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
230
+ def checkpoint(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
231
231
  """
232
- (only in the presence of the @card decorator)
232
+ (only in the presence of the @checkpoint decorator)
233
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].
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.
238
236
 
239
- Methods available are `append` and `extend`
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
240
 
241
- Returns
241
+ Usage (Saving Checkpoints):
242
242
  -------
243
- CardComponentCollector
244
- The or one of the cards attached to this step.
245
- """
246
- ...
247
- @property
248
- def parallel(self) -> "metaflow.metaflow_current.Parallel":
249
- """
250
- (only in the presence of the @parallel decorator)
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
251
278
 
279
+ model = create_model(self.parameters, checkpoint_path = checkpoint_path)
280
+ for i in range(self.epochs):
281
+ ...
282
+ ```
252
283
 
253
284
  Returns
254
285
  -------
255
- Parallel
256
- `namedtuple` with the following fields:
257
- - main_ip : str
258
- The IP address of the control task.
259
- - num_nodes : int
260
- The total number of tasks created by @parallel
261
- - node_index : int
262
- The index of the current task in all the @parallel tasks.
263
- - control_task_id : Optional[str]
264
- The task ID of the control task. Available to all tasks.
265
- """
266
- ...
267
- @property
268
- def is_parallel(self) -> bool:
269
- """
270
- (only in the presence of the @parallel decorator)
271
-
272
- True if the current step is a @parallel step.
286
+ CurrentCheckpointer
287
+ The object for handling checkpointing within a step.
273
288
  """
274
289
  ...
275
290
  @property
@@ -334,64 +349,50 @@ class Current(object, metaclass=type):
334
349
  """
335
350
  ...
336
351
  @property
337
- def checkpoint(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
352
+ def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
338
353
  """
339
- (only in the presence of the @checkpoint decorator)
354
+ (only in the presence of the @card decorator)
340
355
 
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.
356
+ The `@card` decorator makes the cards available through the `current.card`
357
+ object. If multiple `@card` decorators are present, you can add an `ID` to
358
+ distinguish between them using `@card(id=ID)` as the decorator. You will then
359
+ be able to access that specific card using `current.card[ID].
343
360
 
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.
361
+ Methods available are `append` and `extend`
347
362
 
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):
363
+ Returns
373
364
  -------
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
365
+ CardComponentCollector
366
+ The or one of the cards attached to this step.
367
+ """
368
+ ...
369
+ @property
370
+ def parallel(self) -> "metaflow.metaflow_current.Parallel":
371
+ """
372
+ (only in the presence of the @parallel decorator)
385
373
 
386
- model = create_model(self.parameters, checkpoint_path = checkpoint_path)
387
- for i in range(self.epochs):
388
- ...
389
- ```
374
+ Returns a namedtuple with relevant information about the parallel task.
390
375
 
391
376
  Returns
392
377
  -------
393
- CurrentCheckpointer
394
- The object for handling checkpointing within a step.
378
+ Parallel
379
+ `namedtuple` with the following fields:
380
+ - main_ip (`str`)
381
+ The IP address of the control task.
382
+ - num_nodes (`int`)
383
+ The total number of tasks created by @parallel
384
+ - node_index (`int`)
385
+ The index of the current task in all the @parallel tasks.
386
+ - control_task_id (`Optional[str]`)
387
+ The task ID of the control task. Available to all tasks.
388
+ """
389
+ ...
390
+ @property
391
+ def is_parallel(self) -> bool:
392
+ """
393
+ (only in the presence of the @parallel decorator)
394
+
395
+ True if the current step is a @parallel step.
395
396
  """
396
397
  ...
397
398
  @property
@@ -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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.786741 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.735169 #
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.379308 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.736490 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
11
  import typing
12
- import metaflow.exception
13
12
  import metaflow.parameters
13
+ import metaflow.exception
14
14
  import metaflow._vendor.click.types
15
15
 
16
16
  class ParameterFieldFailed(metaflow.exception.MetaflowException, metaclass=type):
@@ -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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.753757 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.780145 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.823226 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.822259 #
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.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.823525 #
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.473205 #
3
+ # MF version: 2.12.27.1+obcheckpoint(0.1.1);ob(v1) #
4
+ # Generated on 2024-10-25T21:39:54.834025 #
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):