ob-metaflow-stubs 6.0.3.120__py2.py3-none-any.whl → 6.0.3.121__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (174) hide show
  1. metaflow-stubs/__init__.pyi +192 -192
  2. metaflow-stubs/cards.pyi +2 -2
  3. metaflow-stubs/cli.pyi +2 -2
  4. metaflow-stubs/client/__init__.pyi +2 -2
  5. metaflow-stubs/client/core.pyi +4 -4
  6. metaflow-stubs/client/filecache.pyi +3 -3
  7. metaflow-stubs/clone_util.pyi +2 -2
  8. metaflow-stubs/events.pyi +2 -2
  9. metaflow-stubs/exception.pyi +2 -2
  10. metaflow-stubs/flowspec.pyi +3 -3
  11. metaflow-stubs/generated_for.txt +1 -1
  12. metaflow-stubs/includefile.pyi +3 -3
  13. metaflow-stubs/info_file.pyi +2 -2
  14. metaflow-stubs/metadata_provider/__init__.pyi +2 -2
  15. metaflow-stubs/metadata_provider/heartbeat.pyi +2 -2
  16. metaflow-stubs/metadata_provider/metadata.pyi +2 -2
  17. metaflow-stubs/metadata_provider/util.pyi +2 -2
  18. metaflow-stubs/metaflow_config.pyi +2 -2
  19. metaflow-stubs/metaflow_current.pyi +90 -90
  20. metaflow-stubs/mf_extensions/__init__.pyi +2 -2
  21. metaflow-stubs/mf_extensions/obcheckpoint/__init__.pyi +2 -2
  22. metaflow-stubs/mf_extensions/obcheckpoint/plugins/__init__.pyi +2 -2
  23. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/__init__.pyi +2 -2
  24. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/__init__.pyi +2 -2
  25. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/checkpoint_storage.pyi +4 -4
  26. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/constructors.pyi +2 -2
  27. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/core.pyi +3 -3
  28. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/exceptions.pyi +2 -2
  29. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/final_api.pyi +2 -2
  30. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/__init__.pyi +2 -2
  31. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/core.pyi +3 -3
  32. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/exceptions.pyi +2 -2
  33. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/task_utils.pyi +3 -3
  34. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/utils.pyi +2 -2
  35. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastructures.pyi +2 -2
  36. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/exceptions.pyi +2 -2
  37. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/__init__.pyi +2 -2
  38. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/flowspec_utils.pyi +2 -2
  39. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/general.pyi +2 -2
  40. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/identity_utils.pyi +3 -3
  41. metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/tar_utils.pyi +2 -2
  42. metaflow-stubs/mf_extensions/outerbounds/__init__.pyi +2 -2
  43. metaflow-stubs/mf_extensions/outerbounds/profilers/__init__.pyi +2 -2
  44. metaflow-stubs/mf_extensions/outerbounds/profilers/gpu.pyi +2 -2
  45. metaflow-stubs/mf_extensions/outerbounds/remote_config.pyi +2 -2
  46. metaflow-stubs/mf_extensions/outerbounds/toplevel/__init__.pyi +2 -2
  47. metaflow-stubs/mf_extensions/outerbounds/toplevel/global_aliases_for_metaflow_package.pyi +2 -2
  48. metaflow-stubs/mflog/__init__.pyi +2 -2
  49. metaflow-stubs/mflog/mflog.pyi +2 -2
  50. metaflow-stubs/multicore_utils.pyi +2 -2
  51. metaflow-stubs/parameters.pyi +3 -3
  52. metaflow-stubs/plugins/__init__.pyi +12 -12
  53. metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
  54. metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
  55. metaflow-stubs/plugins/airflow/exception.pyi +2 -2
  56. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
  57. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
  58. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +2 -2
  59. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +2 -2
  60. metaflow-stubs/plugins/argo/__init__.pyi +2 -2
  61. metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
  62. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  63. metaflow-stubs/plugins/argo/argo_workflows.pyi +2 -2
  64. metaflow-stubs/plugins/argo/argo_workflows_cli.pyi +2 -2
  65. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +3 -3
  66. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +4 -4
  67. metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +2 -2
  68. metaflow-stubs/plugins/aws/__init__.pyi +2 -2
  69. metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
  70. metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
  71. metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
  72. metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
  73. metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
  74. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +2 -2
  75. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
  76. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +4 -4
  77. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +2 -2
  78. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +2 -2
  79. metaflow-stubs/plugins/aws/step_functions/production_token.pyi +2 -2
  80. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +2 -2
  81. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +2 -2
  82. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +2 -2
  83. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +3 -3
  84. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +3 -3
  85. metaflow-stubs/plugins/azure/__init__.pyi +2 -2
  86. metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
  87. metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
  88. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +4 -4
  89. metaflow-stubs/plugins/azure/azure_utils.pyi +2 -2
  90. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +2 -2
  91. metaflow-stubs/plugins/azure/includefile_support.pyi +2 -2
  92. metaflow-stubs/plugins/cards/__init__.pyi +2 -2
  93. metaflow-stubs/plugins/cards/card_cli.pyi +2 -2
  94. metaflow-stubs/plugins/cards/card_client.pyi +3 -3
  95. metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
  96. metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
  97. metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
  98. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
  99. metaflow-stubs/plugins/cards/card_modules/basic.pyi +3 -3
  100. metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
  101. metaflow-stubs/plugins/cards/card_modules/components.pyi +3 -3
  102. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
  103. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
  104. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +2 -2
  105. metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
  106. metaflow-stubs/plugins/cards/component_serializer.pyi +2 -2
  107. metaflow-stubs/plugins/cards/exception.pyi +2 -2
  108. metaflow-stubs/plugins/catch_decorator.pyi +3 -3
  109. metaflow-stubs/plugins/datatools/__init__.pyi +2 -2
  110. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  111. metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
  112. metaflow-stubs/plugins/datatools/s3/s3.pyi +4 -4
  113. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
  114. metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
  115. metaflow-stubs/plugins/debug_logger.pyi +2 -2
  116. metaflow-stubs/plugins/debug_monitor.pyi +2 -2
  117. metaflow-stubs/plugins/environment_decorator.pyi +2 -2
  118. metaflow-stubs/plugins/events_decorator.pyi +2 -12
  119. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  120. metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
  121. metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
  122. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +4 -4
  123. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +2 -2
  124. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +2 -2
  125. metaflow-stubs/plugins/gcp/gs_utils.pyi +2 -2
  126. metaflow-stubs/plugins/gcp/includefile_support.pyi +2 -2
  127. metaflow-stubs/plugins/kubernetes/__init__.pyi +3 -3
  128. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +2 -2
  129. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +2 -2
  130. metaflow-stubs/plugins/kubernetes/kubernetes_cli.pyi +2 -2
  131. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  132. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +2 -2
  133. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
  134. metaflow-stubs/plugins/logs_cli.pyi +2 -2
  135. metaflow-stubs/plugins/package_cli.pyi +2 -2
  136. metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
  137. metaflow-stubs/plugins/perimeters.pyi +2 -2
  138. metaflow-stubs/plugins/project_decorator.pyi +2 -2
  139. metaflow-stubs/plugins/pypi/__init__.pyi +2 -2
  140. metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
  141. metaflow-stubs/plugins/pypi/conda_environment.pyi +6 -6
  142. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
  143. metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
  144. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  145. metaflow-stubs/plugins/resources_decorator.pyi +2 -2
  146. metaflow-stubs/plugins/retry_decorator.pyi +2 -2
  147. metaflow-stubs/plugins/secrets/__init__.pyi +3 -3
  148. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +3 -3
  149. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
  150. metaflow-stubs/plugins/storage_executor.pyi +2 -2
  151. metaflow-stubs/plugins/tag_cli.pyi +2 -2
  152. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +3 -3
  153. metaflow-stubs/plugins/timeout_decorator.pyi +3 -3
  154. metaflow-stubs/procpoll.pyi +2 -2
  155. metaflow-stubs/profilers/__init__.pyi +2 -2
  156. metaflow-stubs/pylint_wrapper.pyi +2 -2
  157. metaflow-stubs/runner/__init__.pyi +2 -2
  158. metaflow-stubs/runner/deployer.pyi +4 -4
  159. metaflow-stubs/runner/deployer_impl.pyi +3 -3
  160. metaflow-stubs/runner/metaflow_runner.pyi +3 -3
  161. metaflow-stubs/runner/nbdeploy.pyi +2 -2
  162. metaflow-stubs/runner/nbrun.pyi +2 -2
  163. metaflow-stubs/runner/subprocess_manager.pyi +2 -2
  164. metaflow-stubs/runner/utils.pyi +4 -4
  165. metaflow-stubs/system/__init__.pyi +2 -2
  166. metaflow-stubs/system/system_logger.pyi +3 -3
  167. metaflow-stubs/system/system_monitor.pyi +2 -2
  168. metaflow-stubs/tagging_util.pyi +2 -2
  169. metaflow-stubs/tuple_util.pyi +2 -2
  170. {ob_metaflow_stubs-6.0.3.120.dist-info → ob_metaflow_stubs-6.0.3.121.dist-info}/METADATA +1 -1
  171. ob_metaflow_stubs-6.0.3.121.dist-info/RECORD +174 -0
  172. ob_metaflow_stubs-6.0.3.120.dist-info/RECORD +0 -174
  173. {ob_metaflow_stubs-6.0.3.120.dist-info → ob_metaflow_stubs-6.0.3.121.dist-info}/WHEEL +0 -0
  174. {ob_metaflow_stubs-6.0.3.120.dist-info → ob_metaflow_stubs-6.0.3.121.dist-info}/top_level.txt +0 -0
metaflow-stubs/events.pyi CHANGED
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.185527 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.375977 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.180214 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.370703 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.184512 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.374979 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,11 +9,11 @@ from __future__ import annotations
9
9
  import metaflow
10
10
  import typing
11
11
  if typing.TYPE_CHECKING:
12
+ import metaflow.datastore.inputs
12
13
  import metaflow.exception
13
14
  import typing
14
15
  import metaflow.flowspec
15
16
  import metaflow.unbounded_foreach
16
- import metaflow.datastore.inputs
17
17
 
18
18
  from . import parameters as parameters
19
19
  from .parameters import DelayedEvaluationParameter as DelayedEvaluationParameter
@@ -1 +1 @@
1
- 2.12.32.1+obcheckpoint(0.1.4);ob(v1) 2024-11-26T19:30:33.177413
1
+ 2.12.33.1+obcheckpoint(0.1.4);ob(v1) 2024-12-02T17:17:46.367779
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.187981 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.378340 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,9 +9,9 @@ from __future__ import annotations
9
9
  import metaflow
10
10
  import typing
11
11
  if typing.TYPE_CHECKING:
12
- import metaflow._vendor.click.types
13
12
  import metaflow.parameters
14
13
  import typing
14
+ import metaflow._vendor.click.types
15
15
 
16
16
  from ._vendor import click as click
17
17
  from .exception import MetaflowException as MetaflowException
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.179477 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.369946 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.183479 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.373940 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.201803 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.391923 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.201282 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.391384 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.201520 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.391641 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.181293 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.371722 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.286135 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.478392 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
12
- import typing
13
- import metaflow.plugins.cards.component_serializer
14
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
15
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
11
+ import metaflow.events
16
12
  import metaflow.metaflow_current
17
13
  import metaflow
18
- import metaflow.events
14
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
15
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
16
+ import typing
17
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
18
+ import metaflow.plugins.cards.component_serializer
19
19
 
20
20
 
21
21
  TYPE_CHECKING: bool
@@ -228,64 +228,32 @@ class Current(object, metaclass=type):
228
228
  def graph(self):
229
229
  ...
230
230
  @property
231
- def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
231
+ def parallel(self) -> "metaflow.metaflow_current.Parallel":
232
232
  """
233
- (only in the presence of the @checkpoint decorator)
234
-
235
- The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
236
- The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
237
-
238
- You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
239
- by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
240
- where the checkpoint maybe loaded or saved.
241
-
242
- Usage (Saving Checkpoints):
243
- -------
244
- ```
245
- @checkpoint
246
- @step
247
- def train(self):
248
- model = create_model(self.parameters, checkpoint_path = None)
249
- for i in range(self.epochs):
250
- # some training logic
251
- loss = model.train(self.dataset)
252
- if i % 10 == 0:
253
- model.save(
254
- current.checkpoint.directory,
255
- )
256
- # saves the contents of the `current.checkpoint.directory` as a checkpoint
257
- # and returns a reference dictionary to the checkpoint saved in the datastore
258
- self.latest_checkpoint = current.checkpoint.save(
259
- name="epoch_checkpoint",
260
- metadata={
261
- "epoch": i,
262
- "loss": loss,
263
- }
264
- )
265
- ```
266
- Usage (Using Loaded Checkpoints):
267
- -------
268
- ```
269
- @retry(times=3)
270
- @checkpoint
271
- @step
272
- def train(self):
273
- # Assume that the task has restarted and the previous attempt of the task
274
- # saved a checkpoint
275
- checkpoint_path = None
276
- if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
277
- print("Loaded checkpoint from the previous attempt")
278
- checkpoint_path = current.checkpoint.directory
233
+ (only in the presence of the @parallel decorator)
279
234
 
280
- model = create_model(self.parameters, checkpoint_path = checkpoint_path)
281
- for i in range(self.epochs):
282
- ...
283
- ```
235
+ Returns a namedtuple with relevant information about the parallel task.
284
236
 
285
237
  Returns
286
238
  -------
287
- CurrentCheckpointer
288
- The object for handling checkpointing within a step.
239
+ Parallel
240
+ `namedtuple` with the following fields:
241
+ - main_ip (`str`)
242
+ The IP address of the control task.
243
+ - num_nodes (`int`)
244
+ The total number of tasks created by @parallel
245
+ - node_index (`int`)
246
+ The index of the current task in all the @parallel tasks.
247
+ - control_task_id (`Optional[str]`)
248
+ The task ID of the control task. Available to all tasks.
249
+ """
250
+ ...
251
+ @property
252
+ def is_parallel(self) -> bool:
253
+ """
254
+ (only in the presence of the @parallel decorator)
255
+
256
+ True if the current step is a @parallel step.
289
257
  """
290
258
  ...
291
259
  @property
@@ -358,6 +326,67 @@ class Current(object, metaclass=type):
358
326
  """
359
327
  ...
360
328
  @property
329
+ def checkpoint(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
330
+ """
331
+ (only in the presence of the @checkpoint decorator)
332
+
333
+ The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
334
+ The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
335
+
336
+ You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
337
+ by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
338
+ where the checkpoint maybe loaded or saved.
339
+
340
+ Usage (Saving Checkpoints):
341
+ -------
342
+ ```
343
+ @checkpoint
344
+ @step
345
+ def train(self):
346
+ model = create_model(self.parameters, checkpoint_path = None)
347
+ for i in range(self.epochs):
348
+ # some training logic
349
+ loss = model.train(self.dataset)
350
+ if i % 10 == 0:
351
+ model.save(
352
+ current.checkpoint.directory,
353
+ )
354
+ # saves the contents of the `current.checkpoint.directory` as a checkpoint
355
+ # and returns a reference dictionary to the checkpoint saved in the datastore
356
+ self.latest_checkpoint = current.checkpoint.save(
357
+ name="epoch_checkpoint",
358
+ metadata={
359
+ "epoch": i,
360
+ "loss": loss,
361
+ }
362
+ )
363
+ ```
364
+ Usage (Using Loaded Checkpoints):
365
+ -------
366
+ ```
367
+ @retry(times=3)
368
+ @checkpoint
369
+ @step
370
+ def train(self):
371
+ # Assume that the task has restarted and the previous attempt of the task
372
+ # saved a checkpoint
373
+ checkpoint_path = None
374
+ if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
375
+ print("Loaded checkpoint from the previous attempt")
376
+ checkpoint_path = current.checkpoint.directory
377
+
378
+ model = create_model(self.parameters, checkpoint_path = checkpoint_path)
379
+ for i in range(self.epochs):
380
+ ...
381
+ ```
382
+
383
+ Returns
384
+ -------
385
+ CurrentCheckpointer
386
+ The object for handling checkpointing within a step.
387
+ """
388
+ ...
389
+ @property
361
390
  def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
362
391
  """
363
392
  (only in the presence of the @card decorator)
@@ -376,35 +405,6 @@ class Current(object, metaclass=type):
376
405
  """
377
406
  ...
378
407
  @property
379
- def parallel(self) -> "metaflow.metaflow_current.Parallel":
380
- """
381
- (only in the presence of the @parallel decorator)
382
-
383
- Returns a namedtuple with relevant information about the parallel task.
384
-
385
- Returns
386
- -------
387
- Parallel
388
- `namedtuple` with the following fields:
389
- - main_ip (`str`)
390
- The IP address of the control task.
391
- - num_nodes (`int`)
392
- The total number of tasks created by @parallel
393
- - node_index (`int`)
394
- The index of the current task in all the @parallel tasks.
395
- - control_task_id (`Optional[str]`)
396
- The task ID of the control task. Available to all tasks.
397
- """
398
- ...
399
- @property
400
- def is_parallel(self) -> bool:
401
- """
402
- (only in the presence of the @parallel decorator)
403
-
404
- True if the current step is a @parallel step.
405
- """
406
- ...
407
- @property
408
408
  def model(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
409
409
  """
410
410
  (only in the presence of the @model decorator)
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.186788 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.377287 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.195779 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.385803 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.195843 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.385867 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.195904 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.385926 #
5
5
  ######################################################################################################
6
6
 
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.195961 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.385983 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.262445 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.453567 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,10 +9,10 @@ from __future__ import annotations
9
9
  import metaflow
10
10
  import typing
11
11
  if typing.TYPE_CHECKING:
12
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
13
- import metaflow.datastore.datastore_storage
14
12
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
13
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
15
14
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
15
+ import metaflow.datastore.datastore_storage
16
16
 
17
17
  from ..exceptions import KeyNotCompatibleWithObjectException as KeyNotCompatibleWithObjectException
18
18
  from ..utils.identity_utils import pathspec_hash as pathspec_hash
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.219326 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.409441 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.250941 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.442041 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.core
12
11
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.checkpoint_storage
13
12
  import metaflow
14
13
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
14
+ import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.core
15
15
 
16
16
  from ......metaflow_current import current as current
17
17
  from ......exception import MetaflowException as MetaflowException
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.219555 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.409661 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.196006 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.386028 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.220201 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.410319 #
5
5
  ######################################################################################################
6
6
 
@@ -1,15 +1,15 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.252326 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.443287 #
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.datastore_storage
12
11
  import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.datastore.core
12
+ import metaflow.datastore.datastore_storage
13
13
 
14
14
  from ......exception import MetaflowException as MetaflowException
15
15
  from ..utils.tar_utils import create_tarball_on_disk as create_tarball_on_disk
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.273599 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.466287 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.220253 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.410374 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
9
9
  import metaflow
10
10
  import typing
11
11
  if typing.TYPE_CHECKING:
12
- import metaflow.exception
13
12
  import metaflow
13
+ import metaflow.exception
14
14
 
15
15
  from ......exception import MetaflowException as MetaflowException
16
16
  from .core import resolve_root as resolve_root
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.273795 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.466481 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.196972 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.386946 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.219890 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.409984 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,6 +1,6 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.261342 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.452458 #
5
5
  ######################################################################################################
6
6
 
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.261395 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.452513 #
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.32.1+obcheckpoint(0.1.4);ob(v1) #
4
- # Generated on 2024-11-26T19:30:33.263440 #
3
+ # MF version: 2.12.33.1+obcheckpoint(0.1.4);ob(v1) #
4
+ # Generated on 2024-12-02T17:17:46.454547 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations