ob-metaflow-stubs 5.10__py2.py3-none-any.whl → 6.0.3.102__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. metaflow-stubs/__init__.pyi +742 -546
  2. metaflow-stubs/cards.pyi +4 -4
  3. metaflow-stubs/cli.pyi +2 -2
  4. metaflow-stubs/client/__init__.pyi +3 -3
  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 +5 -5
  11. metaflow-stubs/generated_for.txt +1 -1
  12. metaflow-stubs/includefile.pyi +4 -4
  13. metaflow-stubs/info_file.pyi +2 -2
  14. metaflow-stubs/metadata/metadata.pyi +2 -2
  15. metaflow-stubs/metadata/util.pyi +2 -2
  16. metaflow-stubs/metaflow_config.pyi +2 -2
  17. metaflow-stubs/metaflow_current.pyi +129 -5
  18. metaflow-stubs/mflog/mflog.pyi +2 -2
  19. metaflow-stubs/multicore_utils.pyi +2 -2
  20. metaflow-stubs/parameters.pyi +2 -2
  21. metaflow-stubs/plugins/__init__.pyi +2 -2
  22. metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
  23. metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
  24. metaflow-stubs/plugins/airflow/exception.pyi +2 -2
  25. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
  26. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
  27. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +3 -3
  28. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +3 -3
  29. metaflow-stubs/plugins/argo/__init__.pyi +2 -2
  30. metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
  31. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  32. metaflow-stubs/plugins/argo/argo_workflows.pyi +5 -5
  33. metaflow-stubs/plugins/argo/argo_workflows_cli.pyi +7 -7
  34. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +5 -5
  35. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  36. metaflow-stubs/plugins/aws/__init__.pyi +2 -2
  37. metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
  38. metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
  39. metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
  40. metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
  41. metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
  42. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +3 -3
  43. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
  44. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +2 -2
  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 +2 -2
  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 +2 -2
  62. metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
  63. metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
  64. metaflow-stubs/plugins/cards/card_decorator.pyi +3 -3
  65. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
  66. metaflow-stubs/plugins/cards/card_modules/basic.pyi +3 -3
  67. metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
  68. metaflow-stubs/plugins/cards/card_modules/components.pyi +3 -3
  69. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
  70. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
  71. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +3 -3
  72. metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
  73. metaflow-stubs/plugins/cards/component_serializer.pyi +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 +2 -2
  77. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  78. metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
  79. metaflow-stubs/plugins/datatools/s3/s3.pyi +5 -5
  80. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
  81. metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
  82. metaflow-stubs/plugins/debug_logger.pyi +2 -2
  83. metaflow-stubs/plugins/debug_monitor.pyi +2 -2
  84. metaflow-stubs/plugins/environment_decorator.pyi +2 -2
  85. metaflow-stubs/plugins/events_decorator.pyi +3 -3
  86. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  87. metaflow-stubs/plugins/frameworks/pytorch.pyi +4 -4
  88. metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
  89. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +2 -2
  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 +2 -2
  98. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  99. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +3 -3
  100. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
  101. metaflow-stubs/plugins/logs_cli.pyi +3 -3
  102. metaflow-stubs/plugins/package_cli.pyi +2 -2
  103. metaflow-stubs/plugins/parallel_decorator.pyi +3 -3
  104. metaflow-stubs/plugins/perimeters.pyi +2 -2
  105. metaflow-stubs/plugins/project_decorator.pyi +3 -3
  106. metaflow-stubs/plugins/pypi/__init__.pyi +2 -2
  107. metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
  108. metaflow-stubs/plugins/pypi/conda_environment.pyi +4 -4
  109. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
  110. metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
  111. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  112. metaflow-stubs/plugins/resources_decorator.pyi +2 -2
  113. metaflow-stubs/plugins/retry_decorator.pyi +2 -2
  114. metaflow-stubs/plugins/secrets/__init__.pyi +2 -2
  115. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +2 -2
  116. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
  117. metaflow-stubs/plugins/storage_executor.pyi +2 -2
  118. metaflow-stubs/plugins/tag_cli.pyi +4 -4
  119. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +2 -2
  120. metaflow-stubs/plugins/timeout_decorator.pyi +2 -2
  121. metaflow-stubs/procpoll.pyi +2 -2
  122. metaflow-stubs/profilers/__init__.pyi +2 -2
  123. metaflow-stubs/pylint_wrapper.pyi +2 -2
  124. metaflow-stubs/runner/__init__.pyi +2 -2
  125. metaflow-stubs/runner/deployer.pyi +3 -3
  126. metaflow-stubs/runner/metaflow_runner.pyi +5 -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 +3 -3
  132. metaflow-stubs/system/system_logger.pyi +3 -3
  133. metaflow-stubs/system/system_monitor.pyi +2 -2
  134. metaflow-stubs/tagging_util.pyi +2 -2
  135. metaflow-stubs/tuple_util.pyi +2 -2
  136. {ob_metaflow_stubs-5.10.dist-info → ob_metaflow_stubs-6.0.3.102.dist-info}/METADATA +1 -1
  137. ob_metaflow_stubs-6.0.3.102.dist-info/RECORD +140 -0
  138. {ob_metaflow_stubs-5.10.dist-info → ob_metaflow_stubs-6.0.3.102.dist-info}/WHEEL +1 -1
  139. ob_metaflow_stubs-5.10.dist-info/RECORD +0 -140
  140. {ob_metaflow_stubs-5.10.dist-info → ob_metaflow_stubs-6.0.3.102.dist-info}/top_level.txt +0 -0
metaflow-stubs/cards.pyi CHANGED
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.839985 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.156450 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,11 +9,11 @@ from __future__ import annotations
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
11
  import metaflow.plugins.cards.card_client
12
- import metaflow.plugins.cards.card_modules.basic
13
- import metaflow.plugins.cards.card_modules.card
14
12
  import metaflow.plugins.cards.card_modules.components
13
+ import metaflow.plugins.cards.card_modules.basic
15
14
  import typing
16
15
  import metaflow
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,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.853498 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.172237 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.842474 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.164118 #
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
11
12
  import typing
12
13
  import metaflow.events
13
- import datetime
14
14
  import metaflow.client.core
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.831387 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.153116 #
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.events
12
- import metaflow.metaflow_current
13
- import tarfile
14
- import datetime
15
- import metaflow.client.core
16
11
  import metaflow.exception
12
+ import datetime
17
13
  import typing
14
+ import metaflow.client.core
18
15
  import metaflow
16
+ import metaflow.metaflow_current
17
+ import metaflow.events
18
+ import tarfile
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.854440 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.173114 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.851662 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.171115 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.833342 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.157043 #
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.events
12
11
  import metaflow
12
+ import metaflow.events
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.820998 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.145487 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.832728 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.154520 #
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.datastore.inputs
12
+ import metaflow.parameters
13
+ import typing
13
14
  import metaflow.flowspec
14
15
  import metaflow.exception
15
- import typing
16
- import metaflow.parameters
16
+ import metaflow.unbounded_foreach
17
17
 
18
18
  class DelayedEvaluationParameter(object, metaclass=type):
19
19
  def __init__(self, name, field, fun):
@@ -1 +1 @@
1
- 2.12.22.1+ob(v1) 2024-09-20T00:12:02.806894
1
+ 2.12.22.1+obcheckpoint(0.0.10);ob(v1) 2024-09-20T19:48:37.130497
@@ -1,18 +1,18 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.836562 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.159816 #
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
11
12
  import metaflow.plugins.datatools.s3.s3
12
- import metaflow._vendor.click.types
13
13
  import typing
14
- import metaflow.parameters
15
14
  import io
15
+ import metaflow._vendor.click.types
16
16
 
17
17
  class MetaflowException(Exception, metaclass=type):
18
18
  def __init__(self, msg = "", lineno = None):
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.820302 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.144794 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.880041 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.197121 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.923976 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.232395 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.822079 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.146657 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,18 +1,20 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.926694 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.242611 #
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.events
12
- import metaflow.metaflow_current
13
11
  import metaflow.plugins.cards.component_serializer
12
+ import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
14
13
  import typing
14
+ import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
15
15
  import metaflow
16
+ import metaflow.metaflow_current
17
+ import metaflow.events
16
18
 
17
19
  TYPE_CHECKING: bool
18
20
 
@@ -221,6 +223,67 @@ class Current(object, metaclass=type):
221
223
  def graph(_):
222
224
  ...
223
225
  @property
226
+ def checkpoint(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator.CurrentCheckpointer":
227
+ """
228
+ (only in the presence of the @checkpoint decorator)
229
+
230
+ The `@checkpoint` decorator makes saving/loading checkpoints available through the `current.checkpoint`.
231
+ The object exposes `save`/`load`/`list` methods for saving/loading checkpoints.
232
+
233
+ You can check if a checkpoint is loaded by `current.checkpoint.is_loaded` and get the checkpoint information
234
+ by using `current.checkpoint.info`. The `current.checkpoint.directory` returns the path to the checkpoint directory
235
+ where the checkpoint maybe loaded or saved.
236
+
237
+ Usage (Saving Checkpoints):
238
+ -------
239
+ ```
240
+ @checkpoint
241
+ @step
242
+ def train(self):
243
+ model = create_model(self.parameters, checkpoint_path = None)
244
+ for i in range(self.epochs):
245
+ # some training logic
246
+ loss = model.train(self.dataset)
247
+ if i % 10 == 0:
248
+ model.save(
249
+ current.checkpoint.directory,
250
+ )
251
+ # saves the contents of the `current.checkpoint.directory` as a checkpoint
252
+ # and returns a reference dictionary to the checkpoint saved in the datastore
253
+ self.latest_checkpoint = current.checkpoint.save(
254
+ name="epoch_checkpoint",
255
+ metadata={
256
+ "epoch": i,
257
+ "loss": loss,
258
+ }
259
+ )
260
+ ```
261
+ Usage (Using Loaded Checkpoints):
262
+ -------
263
+ ```
264
+ @retry(times=3)
265
+ @checkpoint
266
+ @step
267
+ def train(self):
268
+ # Assume that the task has restarted and the previous attempt of the task
269
+ # saved a checkpoint
270
+ checkpoint_path = None
271
+ if current.checkpoint.is_loaded: # Check if a checkpoint is loaded
272
+ print("Loaded checkpoint from the previous attempt")
273
+ checkpoint_path = current.checkpoint.directory
274
+
275
+ model = create_model(self.parameters, checkpoint_path = checkpoint_path)
276
+ for i in range(self.epochs):
277
+ ...
278
+ ```
279
+
280
+ Returns
281
+ -------
282
+ CurrentCheckpointer
283
+ The object for handling checkpointing within a step.
284
+ """
285
+ ...
286
+ @property
224
287
  def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
225
288
  """
226
289
  (only in the presence of the @card decorator)
@@ -239,6 +302,67 @@ class Current(object, metaclass=type):
239
302
  """
240
303
  ...
241
304
  @property
305
+ def model(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
306
+ """
307
+ (only in the presence of the @model decorator)
308
+
309
+ The object used for loading / saving models.
310
+ `current.model` exposes a `save` method to save models and a `load` method to load models.
311
+ `current.model.loaded` exposes the paths to the models loaded via the `load` argument in the @model decorator
312
+ or models loaded via `current.model.load`.
313
+
314
+ Usage (Saving a model):
315
+ -------
316
+
317
+ ```
318
+ @model
319
+ @step
320
+ def train(self):
321
+ # current.model.save returns a dictionary reference to the model saved
322
+ self.my_model = current.model.save(
323
+ path_to_my_model,
324
+ label="my_model",
325
+ metadata={
326
+ "epochs": 10,
327
+ "batch-size": 32,
328
+ "learning-rate": 0.001,
329
+ }
330
+ )
331
+ self.next(self.test)
332
+
333
+ @model(load="my_model")
334
+ @step
335
+ def test(self):
336
+ # `current.model.loaded` returns a dictionary of the loaded models
337
+ # where the key is the name of the artifact and the value is the path to the model
338
+ print(os.listdir(current.model.loaded["my_model"]))
339
+ self.next(self.end)
340
+ ```
341
+
342
+ Usage (Loading models):
343
+ -------
344
+
345
+ ```
346
+ @step
347
+ def train(self):
348
+ # current.model.load returns the path to the model loaded
349
+ checkpoint_path = current.model.load(
350
+ self.checkpoint_key,
351
+ )
352
+ model_path = current.model.load(
353
+ self.model,
354
+ )
355
+ self.next(self.test)
356
+ ```
357
+
358
+
359
+ Returns
360
+ -------
361
+ ModelSerializer
362
+ The object used for loading / saving models.
363
+ """
364
+ ...
365
+ @property
242
366
  def parallel(self) -> "metaflow.metaflow_current.Parallel":
243
367
  """
244
368
  (only in the presence of the @parallel decorator)
@@ -269,7 +393,7 @@ class Current(object, metaclass=type):
269
393
  @property
270
394
  def trigger(self) -> "metaflow.events.Trigger":
271
395
  """
272
- (only in the presence of the @trigger, or @trigger_on_finish decorators)
396
+ (only in the presence of the @trigger_on_finish, or @trigger decorators)
273
397
 
274
398
  Returns `Trigger` if the current run is triggered by an event
275
399
 
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.880368 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.197422 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.822505 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.147064 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.824469 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.148216 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.838200 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.161635 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.866429 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.191598 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.910143 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.229854 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.909174 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.228869 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.910390 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.230109 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.924487 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.240517 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.924875 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.240921 #
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 metaflow.exception
12
- import metaflow.decorators
13
12
  import metaflow.plugins.airflow.sensors.base_sensor
13
+ import metaflow.decorators
14
14
 
15
15
  class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
16
16
  def __init__(self, *args, **kwargs):
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.925246 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.241272 #
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 metaflow.exception
12
- import metaflow.decorators
13
12
  import metaflow.plugins.airflow.sensors.base_sensor
13
+ import metaflow.decorators
14
14
 
15
15
  class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
16
16
  def __init__(self, *args, **kwargs):
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.864717 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.190835 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.894433 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.220152 #
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+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.892409 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.218270 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,18 +1,18 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.899194 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.224828 #
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.metaflow_current
12
- import metaflow.exception
11
+ import metaflow.parameters
13
12
  import metaflow.graph
14
13
  import metaflow._vendor.click.types
15
- import metaflow.parameters
14
+ import metaflow.exception
15
+ import metaflow.metaflow_current
16
16
 
17
17
  inf: float
18
18
 
@@ -1,21 +1,21 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.22.1+ob(v1) #
4
- # Generated on 2024-09-20T00:12:02.902839 #
3
+ # MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
4
+ # Generated on 2024-09-20T19:48:37.228585 #
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.events
12
- import metaflow.metaflow_current
11
+ import metaflow.decorators
13
12
  import datetime
13
+ import metaflow.parameters
14
+ import metaflow.graph
14
15
  import metaflow.client.core
15
16
  import metaflow.exception
16
- import metaflow.decorators
17
- import metaflow.graph
18
- import metaflow.parameters
17
+ import metaflow.metaflow_current
18
+ import metaflow.events
19
19
 
20
20
  JSONType: metaflow.parameters.JSONTypeClass
21
21