ob-metaflow-stubs 6.0.3.102rc7__py2.py3-none-any.whl → 6.0.3.103__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 +594 -594
  2. metaflow-stubs/cards.pyi +5 -5
  3. metaflow-stubs/cli.pyi +2 -2
  4. metaflow-stubs/client/__init__.pyi +4 -4
  5. metaflow-stubs/client/core.pyi +7 -7
  6. metaflow-stubs/client/filecache.pyi +2 -2
  7. metaflow-stubs/clone_util.pyi +2 -2
  8. metaflow-stubs/events.pyi +3 -3
  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 +3 -3
  15. metaflow-stubs/metadata/util.pyi +2 -2
  16. metaflow-stubs/metaflow_config.pyi +2 -2
  17. metaflow-stubs/metaflow_current.pyi +89 -89
  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 +3 -3
  22. metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
  23. metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
  24. metaflow-stubs/plugins/airflow/exception.pyi +2 -2
  25. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
  26. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
  27. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +2 -2
  28. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +2 -2
  29. metaflow-stubs/plugins/argo/__init__.pyi +2 -2
  30. metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
  31. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  32. metaflow-stubs/plugins/argo/argo_workflows.pyi +4 -4
  33. metaflow-stubs/plugins/argo/argo_workflows_cli.pyi +7 -7
  34. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +7 -7
  35. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +4 -4
  36. metaflow-stubs/plugins/aws/__init__.pyi +2 -2
  37. metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
  38. metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
  39. metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
  40. metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
  41. metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
  42. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +2 -2
  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 +3 -3
  52. metaflow-stubs/plugins/azure/__init__.pyi +2 -2
  53. metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
  54. metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
  55. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +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 +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 +2 -2
  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 +4 -4
  79. metaflow-stubs/plugins/datatools/s3/s3.pyi +6 -6
  80. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
  81. metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
  82. metaflow-stubs/plugins/debug_logger.pyi +2 -2
  83. metaflow-stubs/plugins/debug_monitor.pyi +2 -2
  84. metaflow-stubs/plugins/environment_decorator.pyi +2 -2
  85. metaflow-stubs/plugins/events_decorator.pyi +2 -2
  86. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  87. metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
  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 +3 -3
  98. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  99. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +2 -2
  100. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
  101. metaflow-stubs/plugins/logs_cli.pyi +3 -3
  102. metaflow-stubs/plugins/package_cli.pyi +2 -2
  103. metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
  104. metaflow-stubs/plugins/perimeters.pyi +2 -2
  105. metaflow-stubs/plugins/project_decorator.pyi +2 -2
  106. metaflow-stubs/plugins/pypi/__init__.pyi +2 -2
  107. metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
  108. metaflow-stubs/plugins/pypi/conda_environment.pyi +4 -4
  109. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
  110. metaflow-stubs/plugins/pypi/pypi_environment.pyi +3 -3
  111. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  112. metaflow-stubs/plugins/resources_decorator.pyi +2 -2
  113. metaflow-stubs/plugins/retry_decorator.pyi +2 -2
  114. metaflow-stubs/plugins/secrets/__init__.pyi +2 -2
  115. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +3 -3
  116. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
  117. metaflow-stubs/plugins/storage_executor.pyi +2 -2
  118. metaflow-stubs/plugins/tag_cli.pyi +4 -4
  119. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +2 -2
  120. metaflow-stubs/plugins/timeout_decorator.pyi +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 +4 -4
  126. metaflow-stubs/runner/metaflow_runner.pyi +5 -5
  127. metaflow-stubs/runner/nbdeploy.pyi +2 -2
  128. metaflow-stubs/runner/nbrun.pyi +2 -2
  129. metaflow-stubs/runner/subprocess_manager.pyi +2 -2
  130. metaflow-stubs/runner/utils.pyi +2 -2
  131. metaflow-stubs/system/__init__.pyi +4 -4
  132. metaflow-stubs/system/system_logger.pyi +3 -3
  133. metaflow-stubs/system/system_monitor.pyi +3 -3
  134. metaflow-stubs/tagging_util.pyi +2 -2
  135. metaflow-stubs/tuple_util.pyi +2 -2
  136. {ob_metaflow_stubs-6.0.3.102rc7.dist-info → ob_metaflow_stubs-6.0.3.103.dist-info}/METADATA +1 -1
  137. ob_metaflow_stubs-6.0.3.103.dist-info/RECORD +140 -0
  138. ob_metaflow_stubs-6.0.3.102rc7.dist-info/RECORD +0 -140
  139. {ob_metaflow_stubs-6.0.3.102rc7.dist-info → ob_metaflow_stubs-6.0.3.103.dist-info}/WHEEL +0 -0
  140. {ob_metaflow_stubs-6.0.3.102rc7.dist-info → ob_metaflow_stubs-6.0.3.103.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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.323935 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.475147 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
+ import metaflow.plugins.cards.card_client
12
+ import metaflow.plugins.cards.card_modules.basic
11
13
  import metaflow.plugins.cards.card_modules.components
12
- import typing
13
14
  import metaflow
14
15
  import metaflow.plugins.cards.card_modules.card
15
- import metaflow.plugins.cards.card_client
16
- import metaflow.plugins.cards.card_modules.basic
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.339620 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.491133 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,16 +1,16 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.331528 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.482175 #
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.client.core
13
11
  import metaflow.events
12
+ import metaflow.client.core
13
+ import typing
14
14
  import datetime
15
15
 
16
16
  def namespace(ns: typing.Optional[str]) -> typing.Optional[str]:
@@ -1,21 +1,21 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.320602 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.471190 #
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
13
- import metaflow.events
11
+ import tarfile
14
12
  import datetime
13
+ import metaflow.events
15
14
  import metaflow.exception
16
- import tarfile
17
- import metaflow.client.core
18
15
  import metaflow.metaflow_current
16
+ import metaflow
17
+ import metaflow.client.core
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.340497 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.492006 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.338510 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.490024 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
metaflow-stubs/events.pyi CHANGED
@@ -1,15 +1,15 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.324508 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.473221 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow
12
11
  import metaflow.events
12
+ import metaflow
13
13
 
14
14
  TYPE_CHECKING: bool
15
15
 
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.313014 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.461903 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.322005 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.472652 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.unbounded_foreach
12
- import typing
11
+ import metaflow.datastore.inputs
13
12
  import metaflow.flowspec
14
- import metaflow.parameters
15
13
  import metaflow.exception
16
- import metaflow.datastore.inputs
14
+ import metaflow.unbounded_foreach
15
+ import metaflow.parameters
16
+ import typing
17
17
 
18
18
  class DelayedEvaluationParameter(object, metaclass=type):
19
19
  def __init__(self, name, field, fun):
@@ -1 +1 @@
1
- 2.12.22.1+obcheckpoint(0.0.10);ob(v1) 2024-09-20T19:26:01.297881
1
+ 2.12.22.1+obcheckpoint(0.0.11);ob(v1) 2024-09-20T20:42:33.446770
@@ -1,17 +1,17 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.327245 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.478035 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import typing
12
11
  import metaflow._vendor.click.types
13
- import metaflow.parameters
14
12
  import io
13
+ import metaflow.parameters
14
+ import typing
15
15
  import metaflow.plugins.datatools.s3.s3
16
16
 
17
17
  class MetaflowException(Exception, metaclass=type):
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.312314 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.461208 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.364118 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.515300 #
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.metadata.metadata
12
11
  import metaflow.exception
12
+ import metaflow.metadata.metadata
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.406213 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.549937 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.314070 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.462960 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,20 +1,20 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.408777 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.559943 #
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.plugins.cards.component_serializer
13
11
  import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
14
- import metaflow
12
+ import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
15
13
  import metaflow.events
14
+ import metaflow.plugins.cards.component_serializer
16
15
  import metaflow.metaflow_current
17
- import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
16
+ import metaflow
17
+ import typing
18
18
 
19
19
  TYPE_CHECKING: bool
20
20
 
@@ -223,24 +223,6 @@ class Current(object, metaclass=type):
223
223
  def graph(_):
224
224
  ...
225
225
  @property
226
- def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
227
- """
228
- (only in the presence of the @card decorator)
229
-
230
- The `@card` decorator makes the cards available through the `current.card`
231
- object. If multiple `@card` decorators are present, you can add an `ID` to
232
- distinguish between them using `@card(id=ID)` as the decorator. You will then
233
- be able to access that specific card using `current.card[ID].
234
-
235
- Methods available are `append` and `extend`
236
-
237
- Returns
238
- -------
239
- CardComponentCollector
240
- The or one of the cards attached to this step.
241
- """
242
- ...
243
- @property
244
226
  def parallel(self) -> "metaflow.metaflow_current.Parallel":
245
227
  """
246
228
  (only in the presence of the @parallel decorator)
@@ -269,6 +251,67 @@ class Current(object, metaclass=type):
269
251
  """
270
252
  ...
271
253
  @property
254
+ def checkpoint(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
255
+ """
256
+ (only in the presence of the @checkpoint decorator)
257
+
258
+ The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
259
+ The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
260
+
261
+ You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
262
+ by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
263
+ where the checkpoint maybe loaded or saved.
264
+
265
+ Usage (Saving Checkpoints):
266
+ -------
267
+ ```
268
+ @checkpoint
269
+ @step
270
+ def train(self):
271
+ model = create_model(self.parameters, checkpoint_path = None)
272
+ for i in range(self.epochs):
273
+ # some training logic
274
+ loss = model.train(self.dataset)
275
+ if i % 10 == 0:
276
+ model.save(
277
+ current.checkpoint.directory,
278
+ )
279
+ # saves the contents of the `current.checkpoint.directory` as a checkpoint
280
+ # and returns a reference dictionary to the checkpoint saved in the datastore
281
+ self.latest_checkpoint = current.checkpoint.save(
282
+ name="epoch_checkpoint",
283
+ metadata={
284
+ "epoch": i,
285
+ "loss": loss,
286
+ }
287
+ )
288
+ ```
289
+ Usage (Using Loaded Checkpoints):
290
+ -------
291
+ ```
292
+ @retry(times=3)
293
+ @checkpoint
294
+ @step
295
+ def train(self):
296
+ # Assume that the task has restarted and the previous attempt of the task
297
+ # saved a checkpoint
298
+ checkpoint_path = None
299
+ if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
300
+ print("Loaded checkpoint from the previous attempt")
301
+ checkpoint_path = current.checkpoint.directory
302
+
303
+ model = create_model(self.parameters, checkpoint_path = checkpoint_path)
304
+ for i in range(self.epochs):
305
+ ...
306
+ ```
307
+
308
+ Returns
309
+ -------
310
+ CurrentCheckpointer
311
+ The object for handling checkpointing within a step.
312
+ """
313
+ ...
314
+ @property
272
315
  def model(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
273
316
  """
274
317
  (only in the presence of the @model decorator)
@@ -330,77 +373,21 @@ class Current(object, metaclass=type):
330
373
  """
331
374
  ...
332
375
  @property
333
- def checkpoint(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
376
+ def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
334
377
  """
335
- (only in the presence of the @checkpoint decorator)
336
-
337
- The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
338
- The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
339
-
340
- You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
341
- by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
342
- where the checkpoint maybe loaded or saved.
343
-
344
- Usage (Saving Checkpoints):
345
- -------
346
- ```
347
- @checkpoint
348
- @step
349
- def train(self):
350
- model = create_model(self.parameters, checkpoint_path = None)
351
- for i in range(self.epochs):
352
- # some training logic
353
- loss = model.train(self.dataset)
354
- if i % 10 == 0:
355
- model.save(
356
- current.checkpoint.directory,
357
- )
358
- # saves the contents of the `current.checkpoint.directory` as a checkpoint
359
- # and returns a reference dictionary to the checkpoint saved in the datastore
360
- self.latest_checkpoint = current.checkpoint.save(
361
- name="epoch_checkpoint",
362
- metadata={
363
- "epoch": i,
364
- "loss": loss,
365
- }
366
- )
367
- ```
368
- Usage (Using Loaded Checkpoints):
369
- -------
370
- ```
371
- @retry(times=3)
372
- @checkpoint
373
- @step
374
- def train(self):
375
- # Assume that the task has restarted and the previous attempt of the task
376
- # saved a checkpoint
377
- checkpoint_path = None
378
- if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
379
- print("Loaded checkpoint from the previous attempt")
380
- checkpoint_path = current.checkpoint.directory
381
-
382
- model = create_model(self.parameters, checkpoint_path = checkpoint_path)
383
- for i in range(self.epochs):
384
- ...
385
- ```
378
+ (only in the presence of the @card decorator)
386
379
 
387
- Returns
388
- -------
389
- CurrentCheckpointer
390
- The object for handling checkpointing within a step.
391
- """
392
- ...
393
- @property
394
- def trigger(self) -> "metaflow.events.Trigger":
395
- """
396
- (only in the presence of the @trigger, or @trigger_on_finish decorators)
380
+ The `@card` decorator makes the cards available through the `current.card`
381
+ object. If multiple `@card` decorators are present, you can add an `ID` to
382
+ distinguish between them using `@card(id=ID)` as the decorator. You will then
383
+ be able to access that specific card using `current.card[ID].
397
384
 
398
- Returns `Trigger` if the current run is triggered by an event
385
+ Methods available are `append` and `extend`
399
386
 
400
387
  Returns
401
388
  -------
402
- Trigger
403
- `Trigger` if triggered by an event
389
+ CardComponentCollector
390
+ The or one of the cards attached to this step.
404
391
  """
405
392
  ...
406
393
  @property
@@ -470,6 +457,19 @@ class Current(object, metaclass=type):
470
457
  True if the flow is deployed with `--production`.
471
458
  """
472
459
  ...
460
+ @property
461
+ def trigger(self) -> "metaflow.events.Trigger":
462
+ """
463
+ (only in the presence of the @trigger_on_finish, or @trigger decorators)
464
+
465
+ Returns `Trigger` if the current run is triggered by an event
466
+
467
+ Returns
468
+ -------
469
+ Trigger
470
+ `Trigger` if triggered by an event
471
+ """
472
+ ...
473
473
  ...
474
474
 
475
475
  current: Current
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.364424 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.515629 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.314556 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.463480 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.315699 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.464633 #
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._vendor.click.types
12
+ import metaflow.exception
14
13
  import metaflow.parameters
14
+ import typing
15
15
 
16
16
  class ParameterFieldFailed(metaflow.exception.MetaflowException, metaclass=type):
17
17
  def __init__(self, name, field):
@@ -1,15 +1,15 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.329078 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.479712 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.unbounded_foreach
12
11
  import metaflow.plugins.cards.card_modules.card
12
+ import metaflow.unbounded_foreach
13
13
 
14
14
  CLIS_DESC: list
15
15
 
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.358324 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.509134 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.396308 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.547594 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.395332 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.546630 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.396551 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.547831 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.406739 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.557931 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.407140 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.558304 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.407484 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.558658 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.357352 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.504883 #
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.22.1+obcheckpoint(0.0.10);ob(v1) #
4
- # Generated on 2024-09-20T19:26:01.386830 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.11);ob(v1) #
4
+ # Generated on 2024-09-20T20:42:33.520791 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations