ob-metaflow-stubs 6.0.3.106__py2.py3-none-any.whl → 6.0.3.106rc1__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 +570 -570
  2. metaflow-stubs/cards.pyi +4 -4
  3. metaflow-stubs/cli.pyi +2 -2
  4. metaflow-stubs/client/__init__.pyi +2 -2
  5. metaflow-stubs/client/core.pyi +6 -6
  6. metaflow-stubs/client/filecache.pyi +2 -2
  7. metaflow-stubs/clone_util.pyi +1 -1
  8. metaflow-stubs/events.pyi +2 -2
  9. metaflow-stubs/exception.pyi +1 -1
  10. metaflow-stubs/flowspec.pyi +2 -2
  11. metaflow-stubs/generated_for.txt +1 -1
  12. metaflow-stubs/includefile.pyi +1 -1
  13. metaflow-stubs/info_file.pyi +1 -1
  14. metaflow-stubs/metadata/metadata.pyi +1 -1
  15. metaflow-stubs/metadata/util.pyi +1 -1
  16. metaflow-stubs/metaflow_config.pyi +1 -1
  17. metaflow-stubs/metaflow_current.pyi +84 -84
  18. metaflow-stubs/mflog/mflog.pyi +1 -1
  19. metaflow-stubs/multicore_utils.pyi +1 -1
  20. metaflow-stubs/parameters.pyi +3 -3
  21. metaflow-stubs/plugins/__init__.pyi +1 -1
  22. metaflow-stubs/plugins/airflow/__init__.pyi +1 -1
  23. metaflow-stubs/plugins/airflow/airflow_utils.pyi +1 -1
  24. metaflow-stubs/plugins/airflow/exception.pyi +1 -1
  25. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +1 -1
  26. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +1 -1
  27. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +1 -1
  28. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +1 -1
  29. metaflow-stubs/plugins/argo/__init__.pyi +1 -1
  30. metaflow-stubs/plugins/argo/argo_client.pyi +1 -1
  31. metaflow-stubs/plugins/argo/argo_events.pyi +1 -1
  32. metaflow-stubs/plugins/argo/argo_workflows.pyi +2 -2
  33. metaflow-stubs/plugins/argo/argo_workflows_cli.pyi +5 -5
  34. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +5 -5
  35. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +2 -2
  36. metaflow-stubs/plugins/aws/__init__.pyi +1 -1
  37. metaflow-stubs/plugins/aws/aws_client.pyi +1 -1
  38. metaflow-stubs/plugins/aws/aws_utils.pyi +1 -1
  39. metaflow-stubs/plugins/aws/batch/__init__.pyi +1 -1
  40. metaflow-stubs/plugins/aws/batch/batch.pyi +1 -1
  41. metaflow-stubs/plugins/aws/batch/batch_client.pyi +1 -1
  42. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +3 -3
  43. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +1 -1
  44. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +2 -2
  45. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +1 -1
  46. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +1 -1
  47. metaflow-stubs/plugins/aws/step_functions/production_token.pyi +1 -1
  48. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +1 -1
  49. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +1 -1
  50. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +1 -1
  51. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +1 -1
  52. metaflow-stubs/plugins/azure/__init__.pyi +1 -1
  53. metaflow-stubs/plugins/azure/azure_credential.pyi +1 -1
  54. metaflow-stubs/plugins/azure/azure_exceptions.pyi +1 -1
  55. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +2 -2
  56. metaflow-stubs/plugins/azure/azure_utils.pyi +1 -1
  57. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +1 -1
  58. metaflow-stubs/plugins/azure/includefile_support.pyi +1 -1
  59. metaflow-stubs/plugins/cards/__init__.pyi +1 -1
  60. metaflow-stubs/plugins/cards/card_cli.pyi +3 -3
  61. metaflow-stubs/plugins/cards/card_client.pyi +2 -2
  62. metaflow-stubs/plugins/cards/card_creator.pyi +1 -1
  63. metaflow-stubs/plugins/cards/card_datastore.pyi +1 -1
  64. metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
  65. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +1 -1
  66. metaflow-stubs/plugins/cards/card_modules/basic.pyi +2 -2
  67. metaflow-stubs/plugins/cards/card_modules/card.pyi +1 -1
  68. metaflow-stubs/plugins/cards/card_modules/components.pyi +4 -4
  69. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +1 -1
  70. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +1 -1
  71. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +1 -1
  72. metaflow-stubs/plugins/cards/card_resolver.pyi +1 -1
  73. metaflow-stubs/plugins/cards/component_serializer.pyi +3 -3
  74. metaflow-stubs/plugins/cards/exception.pyi +1 -1
  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 +1 -1
  78. metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
  79. metaflow-stubs/plugins/datatools/s3/s3.pyi +3 -3
  80. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +1 -1
  81. metaflow-stubs/plugins/datatools/s3/s3util.pyi +1 -1
  82. metaflow-stubs/plugins/debug_logger.pyi +1 -1
  83. metaflow-stubs/plugins/debug_monitor.pyi +1 -1
  84. metaflow-stubs/plugins/environment_decorator.pyi +1 -1
  85. metaflow-stubs/plugins/events_decorator.pyi +2 -2
  86. metaflow-stubs/plugins/frameworks/__init__.pyi +1 -1
  87. metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
  88. metaflow-stubs/plugins/gcp/__init__.pyi +1 -1
  89. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +2 -2
  90. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +1 -1
  91. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +1 -1
  92. metaflow-stubs/plugins/gcp/gs_utils.pyi +1 -1
  93. metaflow-stubs/plugins/gcp/includefile_support.pyi +1 -1
  94. metaflow-stubs/plugins/kubernetes/__init__.pyi +1 -1
  95. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +1 -1
  96. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +2 -2
  97. metaflow-stubs/plugins/kubernetes/kubernetes_cli.pyi +1 -1
  98. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +1 -1
  99. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +3 -3
  100. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +1 -1
  101. metaflow-stubs/plugins/logs_cli.pyi +1 -1
  102. metaflow-stubs/plugins/package_cli.pyi +1 -1
  103. metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
  104. metaflow-stubs/plugins/perimeters.pyi +1 -1
  105. metaflow-stubs/plugins/project_decorator.pyi +2 -2
  106. metaflow-stubs/plugins/pypi/__init__.pyi +1 -1
  107. metaflow-stubs/plugins/pypi/conda_decorator.pyi +1 -1
  108. metaflow-stubs/plugins/pypi/conda_environment.pyi +3 -3
  109. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +1 -1
  110. metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
  111. metaflow-stubs/plugins/pypi/utils.pyi +1 -1
  112. metaflow-stubs/plugins/resources_decorator.pyi +1 -1
  113. metaflow-stubs/plugins/retry_decorator.pyi +1 -1
  114. metaflow-stubs/plugins/secrets/__init__.pyi +1 -1
  115. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +1 -1
  116. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +1 -1
  117. metaflow-stubs/plugins/storage_executor.pyi +1 -1
  118. metaflow-stubs/plugins/tag_cli.pyi +4 -4
  119. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +1 -1
  120. metaflow-stubs/plugins/timeout_decorator.pyi +1 -1
  121. metaflow-stubs/procpoll.pyi +1 -1
  122. metaflow-stubs/profilers/__init__.pyi +1 -1
  123. metaflow-stubs/pylint_wrapper.pyi +1 -1
  124. metaflow-stubs/runner/__init__.pyi +1 -1
  125. metaflow-stubs/runner/deployer.pyi +2 -2
  126. metaflow-stubs/runner/metaflow_runner.pyi +4 -4
  127. metaflow-stubs/runner/nbdeploy.pyi +1 -1
  128. metaflow-stubs/runner/nbrun.pyi +1 -1
  129. metaflow-stubs/runner/subprocess_manager.pyi +1 -1
  130. metaflow-stubs/runner/utils.pyi +1 -1
  131. metaflow-stubs/system/__init__.pyi +2 -2
  132. metaflow-stubs/system/system_logger.pyi +1 -1
  133. metaflow-stubs/system/system_monitor.pyi +2 -2
  134. metaflow-stubs/tagging_util.pyi +1 -1
  135. metaflow-stubs/tuple_util.pyi +1 -1
  136. {ob_metaflow_stubs-6.0.3.106.dist-info → ob_metaflow_stubs-6.0.3.106rc1.dist-info}/METADATA +1 -1
  137. ob_metaflow_stubs-6.0.3.106rc1.dist-info/RECORD +140 -0
  138. ob_metaflow_stubs-6.0.3.106.dist-info/RECORD +0 -140
  139. {ob_metaflow_stubs-6.0.3.106.dist-info → ob_metaflow_stubs-6.0.3.106rc1.dist-info}/WHEEL +0 -0
  140. {ob_metaflow_stubs-6.0.3.106.dist-info → ob_metaflow_stubs-6.0.3.106rc1.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
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.898172 #
4
+ # Generated on 2024-10-07T18:32:56.958326 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.plugins.cards.card_modules.basic
12
- import metaflow.plugins.cards.card_client
13
- import typing
14
11
  import metaflow
12
+ import metaflow.plugins.cards.card_modules.basic
15
13
  import metaflow.plugins.cards.card_modules.components
16
14
  import metaflow.plugins.cards.card_modules.card
15
+ import typing
16
+ import metaflow.plugins.cards.card_client
17
17
 
18
18
  def get_cards(task: typing.Union[str, "metaflow.Task"], id: typing.Optional[str] = None, type: typing.Optional[str] = None, follow_resumed: bool = True) -> metaflow.plugins.cards.card_client.CardContainer:
19
19
  """
metaflow-stubs/cli.pyi CHANGED
@@ -1,15 +1,15 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.913978 #
4
+ # Generated on 2024-10-07T18:32:56.975223 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.exception
12
11
  import metaflow.metaflow_current
12
+ import metaflow.exception
13
13
 
14
14
  def get_metadata() -> str:
15
15
  """
@@ -1,15 +1,15 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.905422 #
4
+ # Generated on 2024-10-07T18:32:56.966221 #
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.client.core
12
+ import typing
13
13
  import datetime
14
14
  import metaflow.events
15
15
 
@@ -1,21 +1,21 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.894048 #
4
+ # Generated on 2024-10-07T18:32:56.954876 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import metaflow.exception
11
+ import metaflow
12
12
  import metaflow.metaflow_current
13
- import datetime
14
- import tarfile
13
+ import metaflow.client.core
15
14
  import typing
15
+ import metaflow.exception
16
16
  import metaflow.events
17
- import metaflow
18
- import metaflow.client.core
17
+ import tarfile
18
+ import datetime
19
19
 
20
20
  current: metaflow.metaflow_current.Current
21
21
 
@@ -1,15 +1,15 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.914844 #
4
+ # Generated on 2024-10-07T18:32:56.976089 #
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.content_addressed_store
12
11
  import metaflow.exception
12
+ import metaflow.datastore.content_addressed_store
13
13
 
14
14
  class MetaflowException(Exception, metaclass=type):
15
15
  def __init__(self, msg = "", lineno = None):
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.912829 #
4
+ # Generated on 2024-10-07T18:32:56.974058 #
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
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.896121 #
4
+ # Generated on 2024-10-07T18:32:56.958923 #
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
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.886258 #
4
+ # Generated on 2024-10-07T18:32:56.946980 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.895514 #
4
+ # Generated on 2024-10-07T18:32:56.956269 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,9 +9,9 @@ from __future__ import annotations
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
11
  import metaflow.parameters
12
- import metaflow.exception
13
12
  import typing
14
13
  import metaflow.unbounded_foreach
14
+ import metaflow.exception
15
15
  import metaflow.datastore.inputs
16
16
  import metaflow.flowspec
17
17
 
@@ -1 +1 @@
1
- 2.12.24.1+obcheckpoint(0.0.11);ob(v1) 2024-10-04T19:10:58.870995
1
+ 2.12.24.1+obcheckpoint(0.0.11);ob(v1) 2024-10-07T18:32:56.931293
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.901210 #
4
+ # Generated on 2024-10-07T18:32:56.961892 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.885560 #
4
+ # Generated on 2024-10-07T18:32:56.946197 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.938563 #
4
+ # Generated on 2024-10-07T18:32:56.999940 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.981902 #
4
+ # Generated on 2024-10-07T18:32:57.036268 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.887406 #
4
+ # Generated on 2024-10-07T18:32:56.948070 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.984472 #
4
+ # Generated on 2024-10-07T18:32:57.046671 #
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_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
12
+ import metaflow
12
13
  import metaflow.metaflow_current
13
14
  import typing
14
- import metaflow.events
15
- import metaflow
16
15
  import metaflow.plugins.cards.component_serializer
16
+ import metaflow.events
17
17
  import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
18
18
 
19
19
  TYPE_CHECKING: bool
@@ -226,82 +226,31 @@ class Current(object, metaclass=type):
226
226
  def graph(_):
227
227
  ...
228
228
  @property
229
- def model(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
229
+ def parallel(self) -> "metaflow.metaflow_current.Parallel":
230
230
  """
231
- (only in the presence of the @model decorator)
232
-
233
- The object used for loading / saving models.
234
- `current.model` exposes a `save` method to save models and a `load` method to load models.
235
- `current.model.loaded` exposes the paths to the models loaded via the `load` argument in the @model decorator
236
- or models loaded via `current.model.load`.
237
-
238
- Usage (Saving a model):
239
- -------
240
-
241
- ```
242
- @model
243
- @step
244
- def train(self):
245
- # current.model.save returns a dictionary reference to the model saved
246
- self.my_model = current.model.save(
247
- path_to_my_model,
248
- label="my_model",
249
- metadata={
250
- "epochs": 10,
251
- "batch-size": 32,
252
- "learning-rate": 0.001,
253
- }
254
- )
255
- self.next(self.test)
256
-
257
- @model(load="my_model")
258
- @step
259
- def test(self):
260
- # `current.model.loaded` returns a dictionary of the loaded models
261
- # where the key is the name of the artifact and the value is the path to the model
262
- print(os.listdir(current.model.loaded["my_model"]))
263
- self.next(self.end)
264
- ```
265
-
266
- Usage (Loading models):
267
- -------
268
-
269
- ```
270
- @step
271
- def train(self):
272
- # current.model.load returns the path to the model loaded
273
- checkpoint_path = current.model.load(
274
- self.checkpoint_key,
275
- )
276
- model_path = current.model.load(
277
- self.model,
278
- )
279
- self.next(self.test)
280
- ```
231
+ (only in the presence of the @parallel decorator)
281
232
 
282
233
 
283
234
  Returns
284
235
  -------
285
- ModelSerializer
286
- The object used for loading / saving models.
236
+ Parallel
237
+ `namedtuple` with the following fields:
238
+ - main_ip : str
239
+ The IP address of the control task.
240
+ - num_nodes : int
241
+ The total number of tasks created by @parallel
242
+ - node_index : int
243
+ The index of the current task in all the @parallel tasks.
244
+ - control_task_id : Optional[str]
245
+ The task ID of the control task. Available to all tasks.
287
246
  """
288
247
  ...
289
248
  @property
290
- def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
249
+ def is_parallel(self) -> bool:
291
250
  """
292
- (only in the presence of the @card decorator)
293
-
294
- The `@card` decorator makes the cards available through the `current.card`
295
- object. If multiple `@card` decorators are present, you can add an `ID` to
296
- distinguish between them using `@card(id=ID)` as the decorator. You will then
297
- be able to access that specific card using `current.card[ID].
298
-
299
- Methods available are `append` and `extend`
251
+ (only in the presence of the @parallel decorator)
300
252
 
301
- Returns
302
- -------
303
- CardComponentCollector
304
- The or one of the cards attached to this step.
253
+ True if the current step is a @parallel step.
305
254
  """
306
255
  ...
307
256
  @property
@@ -366,31 +315,82 @@ class Current(object, metaclass=type):
366
315
  """
367
316
  ...
368
317
  @property
369
- def parallel(self) -> "metaflow.metaflow_current.Parallel":
318
+ def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
370
319
  """
371
- (only in the presence of the @parallel decorator)
320
+ (only in the presence of the @card decorator)
372
321
 
322
+ The `@card` decorator makes the cards available through the `current.card`
323
+ object. If multiple `@card` decorators are present, you can add an `ID` to
324
+ distinguish between them using `@card(id=ID)` as the decorator. You will then
325
+ be able to access that specific card using `current.card[ID].
326
+
327
+ Methods available are `append` and `extend`
373
328
 
374
329
  Returns
375
330
  -------
376
- Parallel
377
- `namedtuple` with the following fields:
378
- - main_ip : str
379
- The IP address of the control task.
380
- - num_nodes : int
381
- The total number of tasks created by @parallel
382
- - node_index : int
383
- The index of the current task in all the @parallel tasks.
384
- - control_task_id : Optional[str]
385
- The task ID of the control task. Available to all tasks.
331
+ CardComponentCollector
332
+ The or one of the cards attached to this step.
386
333
  """
387
334
  ...
388
335
  @property
389
- def is_parallel(self) -> bool:
336
+ def model(self) -> "metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
390
337
  """
391
- (only in the presence of the @parallel decorator)
338
+ (only in the presence of the @model decorator)
392
339
 
393
- True if the current step is a @parallel step.
340
+ The object used for loading / saving models.
341
+ `current.model` exposes a `save` method to save models and a `load` method to load models.
342
+ `current.model.loaded` exposes the paths to the models loaded via the `load` argument in the @model decorator
343
+ or models loaded via `current.model.load`.
344
+
345
+ Usage (Saving a model):
346
+ -------
347
+
348
+ ```
349
+ @model
350
+ @step
351
+ def train(self):
352
+ # current.model.save returns a dictionary reference to the model saved
353
+ self.my_model = current.model.save(
354
+ path_to_my_model,
355
+ label="my_model",
356
+ metadata={
357
+ "epochs": 10,
358
+ "batch-size": 32,
359
+ "learning-rate": 0.001,
360
+ }
361
+ )
362
+ self.next(self.test)
363
+
364
+ @model(load="my_model")
365
+ @step
366
+ def test(self):
367
+ # `current.model.loaded` returns a dictionary of the loaded models
368
+ # where the key is the name of the artifact and the value is the path to the model
369
+ print(os.listdir(current.model.loaded["my_model"]))
370
+ self.next(self.end)
371
+ ```
372
+
373
+ Usage (Loading models):
374
+ -------
375
+
376
+ ```
377
+ @step
378
+ def train(self):
379
+ # current.model.load returns the path to the model loaded
380
+ checkpoint_path = current.model.load(
381
+ self.checkpoint_key,
382
+ )
383
+ model_path = current.model.load(
384
+ self.model,
385
+ )
386
+ self.next(self.test)
387
+ ```
388
+
389
+
390
+ Returns
391
+ -------
392
+ ModelSerializer
393
+ The object used for loading / saving models.
394
394
  """
395
395
  ...
396
396
  @property
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.938888 #
4
+ # Generated on 2024-10-07T18:32:57.000287 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.887835 #
4
+ # Generated on 2024-10-07T18:32:56.948501 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,17 +1,17 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.889048 #
4
+ # Generated on 2024-10-07T18:32:56.949707 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import typing
11
+ import metaflow.parameters
12
12
  import metaflow.exception
13
13
  import metaflow._vendor.click.types
14
- 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,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.902926 #
4
+ # Generated on 2024-10-07T18:32:56.963648 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.932293 #
4
+ # Generated on 2024-10-07T18:32:56.993597 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.971723 #
4
+ # Generated on 2024-10-07T18:32:57.033640 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.970765 #
4
+ # Generated on 2024-10-07T18:32:57.032679 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.972014 #
4
+ # Generated on 2024-10-07T18:32:57.033952 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.982392 #
4
+ # Generated on 2024-10-07T18:32:57.044537 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.982823 #
4
+ # Generated on 2024-10-07T18:32:57.044944 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.983195 #
4
+ # Generated on 2024-10-07T18:32:57.045357 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.927475 #
4
+ # Generated on 2024-10-07T18:32:56.993219 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.944051 #
4
+ # Generated on 2024-10-07T18:32:57.023656 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.942156 #
4
+ # Generated on 2024-10-07T18:32:57.021707 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -1,7 +1,7 @@
1
1
  ##################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
3
  # MF version: 2.12.24.1+obcheckpoint(0.0.11);ob(v1) #
4
- # Generated on 2024-10-04T19:10:58.948802 #
4
+ # Generated on 2024-10-07T18:32:57.028474 #
5
5
  ##################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -10,8 +10,8 @@ import typing
10
10
  if typing.TYPE_CHECKING:
11
11
  import metaflow._vendor.click.types
12
12
  import metaflow.parameters
13
- import metaflow.exception
14
13
  import metaflow.metaflow_current
14
+ import metaflow.exception
15
15
  import metaflow.graph
16
16
 
17
17
  inf: float