ob-metaflow-stubs 6.0.3.132__py2.py3-none-any.whl → 6.0.3.133__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- metaflow-stubs/__init__.pyi +289 -289
- metaflow-stubs/cards.pyi +2 -2
- metaflow-stubs/cli.pyi +2 -2
- metaflow-stubs/cli_components/__init__.pyi +2 -2
- metaflow-stubs/cli_components/utils.pyi +2 -2
- metaflow-stubs/client/__init__.pyi +2 -2
- metaflow-stubs/client/core.pyi +4 -4
- metaflow-stubs/client/filecache.pyi +3 -3
- metaflow-stubs/events.pyi +2 -2
- metaflow-stubs/exception.pyi +2 -2
- metaflow-stubs/flowspec.pyi +5 -5
- metaflow-stubs/generated_for.txt +1 -1
- metaflow-stubs/includefile.pyi +2 -2
- metaflow-stubs/info_file.pyi +2 -2
- metaflow-stubs/metadata_provider/__init__.pyi +2 -2
- metaflow-stubs/metadata_provider/heartbeat.pyi +2 -2
- metaflow-stubs/metadata_provider/metadata.pyi +2 -2
- metaflow-stubs/metadata_provider/util.pyi +2 -2
- metaflow-stubs/metaflow_config.pyi +2 -2
- metaflow-stubs/metaflow_current.pyi +89 -89
- metaflow-stubs/mf_extensions/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/async_cards.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/deco_injection_mixin.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/extra_components.pyi +3 -3
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/checkpoint_lister.pyi +3 -3
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/cards/lineage_card.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/checkpoint_storage.pyi +4 -4
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/constructors.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/core.pyi +4 -4
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/decorator.pyi +4 -4
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/exceptions.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/final_api.pyi +3 -3
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/checkpoints/lineage.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/core.pyi +3 -3
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/exceptions.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/task_utils.pyi +3 -3
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastore/utils.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/datastructures.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/exceptions.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/hf_hub/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/hf_hub/decorator.pyi +3 -3
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/core.pyi +3 -3
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/exceptions.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/modeling_utils/model_storage.pyi +4 -4
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/flowspec_utils.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/general.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/identity_utils.pyi +3 -3
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/serialization_handler/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/serialization_handler/base.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/serialization_handler/tar.pyi +2 -2
- metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/utils/tar_utils.pyi +2 -2
- metaflow-stubs/mf_extensions/outerbounds/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/outerbounds/plugins/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/outerbounds/plugins/snowflake/snowflake.pyi +2 -2
- metaflow-stubs/mf_extensions/outerbounds/profilers/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/outerbounds/profilers/gpu.pyi +2 -2
- metaflow-stubs/mf_extensions/outerbounds/remote_config.pyi +2 -2
- metaflow-stubs/mf_extensions/outerbounds/toplevel/__init__.pyi +2 -2
- metaflow-stubs/mf_extensions/outerbounds/toplevel/global_aliases_for_metaflow_package.pyi +2 -2
- metaflow-stubs/multicore_utils.pyi +2 -2
- metaflow-stubs/parameters.pyi +2 -2
- metaflow-stubs/plugins/__init__.pyi +11 -11
- metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
- metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
- metaflow-stubs/plugins/airflow/exception.pyi +2 -2
- metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
- metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
- metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +2 -2
- metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +2 -2
- metaflow-stubs/plugins/argo/__init__.pyi +2 -2
- metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
- metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
- metaflow-stubs/plugins/argo/argo_workflows.pyi +3 -3
- metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +4 -4
- metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +2 -2
- metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +2 -2
- metaflow-stubs/plugins/aws/__init__.pyi +2 -2
- metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
- metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
- metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
- metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
- metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
- metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +2 -2
- metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
- metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +3 -3
- metaflow-stubs/plugins/aws/step_functions/__init__.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +3 -3
- metaflow-stubs/plugins/azure/__init__.pyi +2 -2
- metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
- metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
- metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +3 -3
- metaflow-stubs/plugins/azure/azure_utils.pyi +2 -2
- metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +2 -2
- metaflow-stubs/plugins/azure/includefile_support.pyi +2 -2
- metaflow-stubs/plugins/cards/__init__.pyi +2 -2
- metaflow-stubs/plugins/cards/card_client.pyi +2 -2
- metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
- metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
- metaflow-stubs/plugins/cards/card_decorator.pyi +4 -2
- metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/basic.pyi +3 -3
- metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/components.pyi +3 -3
- metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +2 -2
- metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
- metaflow-stubs/plugins/cards/component_serializer.pyi +2 -2
- metaflow-stubs/plugins/cards/exception.pyi +2 -2
- metaflow-stubs/plugins/catch_decorator.pyi +3 -3
- metaflow-stubs/plugins/datatools/__init__.pyi +2 -2
- metaflow-stubs/plugins/datatools/local.pyi +2 -2
- metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
- metaflow-stubs/plugins/datatools/s3/s3.pyi +4 -4
- metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
- metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
- metaflow-stubs/plugins/debug_logger.pyi +2 -2
- metaflow-stubs/plugins/debug_monitor.pyi +2 -2
- metaflow-stubs/plugins/environment_decorator.pyi +2 -2
- metaflow-stubs/plugins/events_decorator.pyi +2 -2
- metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
- metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
- metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
- metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +3 -3
- metaflow-stubs/plugins/gcp/gs_exceptions.pyi +2 -2
- metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +2 -2
- metaflow-stubs/plugins/gcp/gs_utils.pyi +2 -2
- metaflow-stubs/plugins/gcp/includefile_support.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/__init__.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kube_utils.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kubernetes.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
- metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
- metaflow-stubs/plugins/perimeters.pyi +2 -2
- metaflow-stubs/plugins/project_decorator.pyi +2 -2
- metaflow-stubs/plugins/pypi/__init__.pyi +3 -3
- metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
- metaflow-stubs/plugins/pypi/conda_environment.pyi +6 -6
- metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
- metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
- metaflow-stubs/plugins/pypi/utils.pyi +2 -2
- metaflow-stubs/plugins/resources_decorator.pyi +2 -2
- metaflow-stubs/plugins/retry_decorator.pyi +2 -2
- metaflow-stubs/plugins/secrets/__init__.pyi +3 -3
- metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +4 -4
- metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
- metaflow-stubs/plugins/snowflake/__init__.pyi +2 -2
- metaflow-stubs/plugins/storage_executor.pyi +2 -2
- metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +2 -2
- metaflow-stubs/plugins/timeout_decorator.pyi +3 -3
- metaflow-stubs/profilers/__init__.pyi +2 -2
- metaflow-stubs/pylint_wrapper.pyi +2 -2
- metaflow-stubs/runner/__init__.pyi +2 -2
- metaflow-stubs/runner/deployer.pyi +5 -5
- metaflow-stubs/runner/deployer_impl.pyi +2 -2
- metaflow-stubs/runner/metaflow_runner.pyi +3 -3
- metaflow-stubs/runner/nbdeploy.pyi +2 -2
- metaflow-stubs/runner/nbrun.pyi +2 -2
- metaflow-stubs/runner/subprocess_manager.pyi +2 -2
- metaflow-stubs/runner/utils.pyi +2 -2
- metaflow-stubs/system/__init__.pyi +2 -2
- metaflow-stubs/system/system_logger.pyi +3 -3
- metaflow-stubs/system/system_monitor.pyi +2 -2
- metaflow-stubs/tagging_util.pyi +2 -2
- metaflow-stubs/tuple_util.pyi +2 -2
- metaflow-stubs/user_configs/__init__.pyi +2 -2
- metaflow-stubs/user_configs/config_decorators.pyi +5 -5
- metaflow-stubs/user_configs/config_options.pyi +2 -2
- metaflow-stubs/user_configs/config_parameters.pyi +6 -6
- {ob_metaflow_stubs-6.0.3.132.dist-info → ob_metaflow_stubs-6.0.3.133.dist-info}/METADATA +1 -1
- ob_metaflow_stubs-6.0.3.133.dist-info/RECORD +191 -0
- ob_metaflow_stubs-6.0.3.132.dist-info/RECORD +0 -191
- {ob_metaflow_stubs-6.0.3.132.dist-info → ob_metaflow_stubs-6.0.3.133.dist-info}/WHEEL +0 -0
- {ob_metaflow_stubs-6.0.3.132.dist-info → ob_metaflow_stubs-6.0.3.133.dist-info}/top_level.txt +0 -0
metaflow-stubs/__init__.pyi
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
######################################################################################################
|
2
2
|
# Auto-generated Metaflow stub file #
|
3
|
-
# MF version: 2.13.
|
4
|
-
# Generated on 2025-01-
|
3
|
+
# MF version: 2.13.4.1+obcheckpoint(0.1.6);ob(v1) #
|
4
|
+
# Generated on 2025-01-15T20:56:03.760807 #
|
5
5
|
######################################################################################################
|
6
6
|
|
7
7
|
from __future__ import annotations
|
@@ -147,165 +147,73 @@ def step(f: typing.Union[typing.Callable[[FlowSpecDerived], None], typing.Callab
|
|
147
147
|
...
|
148
148
|
|
149
149
|
@typing.overload
|
150
|
-
def
|
151
|
-
"""
|
152
|
-
Decorator prototype for all step decorators. This function gets specialized
|
153
|
-
and imported for all decorators types by _import_plugin_decorators().
|
154
|
-
"""
|
155
|
-
...
|
156
|
-
|
157
|
-
@typing.overload
|
158
|
-
def parallel(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
159
|
-
...
|
160
|
-
|
161
|
-
def parallel(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None):
|
162
|
-
"""
|
163
|
-
Decorator prototype for all step decorators. This function gets specialized
|
164
|
-
and imported for all decorators types by _import_plugin_decorators().
|
165
|
-
"""
|
166
|
-
...
|
167
|
-
|
168
|
-
@typing.overload
|
169
|
-
def environment(*, vars: typing.Dict[str, str] = {}) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
170
|
-
"""
|
171
|
-
Specifies environment variables to be set prior to the execution of a step.
|
172
|
-
"""
|
173
|
-
...
|
174
|
-
|
175
|
-
@typing.overload
|
176
|
-
def environment(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
177
|
-
...
|
178
|
-
|
179
|
-
@typing.overload
|
180
|
-
def environment(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
181
|
-
...
|
182
|
-
|
183
|
-
def environment(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, vars: typing.Dict[str, str] = {}):
|
184
|
-
"""
|
185
|
-
Specifies environment variables to be set prior to the execution of a step.
|
186
|
-
"""
|
187
|
-
...
|
188
|
-
|
189
|
-
@typing.overload
|
190
|
-
def checkpoint(*, load_policy: str = 'fresh', temp_dir_root: str = None) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
191
|
-
"""
|
192
|
-
Enables checkpointing for a step.
|
193
|
-
"""
|
194
|
-
...
|
195
|
-
|
196
|
-
@typing.overload
|
197
|
-
def checkpoint(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
198
|
-
...
|
199
|
-
|
200
|
-
@typing.overload
|
201
|
-
def checkpoint(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
202
|
-
...
|
203
|
-
|
204
|
-
def checkpoint(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, load_policy: str = 'fresh', temp_dir_root: str = None):
|
205
|
-
"""
|
206
|
-
Enables checkpointing for a step.
|
207
|
-
"""
|
208
|
-
...
|
209
|
-
|
210
|
-
@typing.overload
|
211
|
-
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
212
|
-
"""
|
213
|
-
Internal decorator to support Fast bakery
|
214
|
-
"""
|
215
|
-
...
|
216
|
-
|
217
|
-
@typing.overload
|
218
|
-
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
219
|
-
...
|
220
|
-
|
221
|
-
def fast_bakery_internal(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None):
|
222
|
-
"""
|
223
|
-
Internal decorator to support Fast bakery
|
224
|
-
"""
|
225
|
-
...
|
226
|
-
|
227
|
-
@typing.overload
|
228
|
-
def conda(*, packages: typing.Dict[str, str] = {}, libraries: typing.Dict[str, str] = {}, python: typing.Optional[str] = None, disabled: bool = False) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
150
|
+
def pypi(*, packages: typing.Dict[str, str] = {}, python: typing.Optional[str] = None) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
229
151
|
"""
|
230
|
-
Specifies the
|
152
|
+
Specifies the PyPI packages for the step.
|
231
153
|
|
232
154
|
Information in this decorator will augment any
|
233
|
-
attributes set in the `@
|
234
|
-
you can use `@
|
235
|
-
steps and use `@
|
155
|
+
attributes set in the `@pyi_base` flow-level decorator. Hence,
|
156
|
+
you can use `@pypi_base` to set packages required by all
|
157
|
+
steps and use `@pypi` to specify step-specific overrides.
|
236
158
|
"""
|
237
159
|
...
|
238
160
|
|
239
161
|
@typing.overload
|
240
|
-
def
|
162
|
+
def pypi(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
241
163
|
...
|
242
164
|
|
243
165
|
@typing.overload
|
244
|
-
def
|
166
|
+
def pypi(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
245
167
|
...
|
246
168
|
|
247
|
-
def
|
169
|
+
def pypi(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, packages: typing.Dict[str, str] = {}, python: typing.Optional[str] = None):
|
248
170
|
"""
|
249
|
-
Specifies the
|
171
|
+
Specifies the PyPI packages for the step.
|
250
172
|
|
251
173
|
Information in this decorator will augment any
|
252
|
-
attributes set in the `@
|
253
|
-
you can use `@
|
254
|
-
steps and use `@
|
174
|
+
attributes set in the `@pyi_base` flow-level decorator. Hence,
|
175
|
+
you can use `@pypi_base` to set packages required by all
|
176
|
+
steps and use `@pypi` to specify step-specific overrides.
|
255
177
|
"""
|
256
178
|
...
|
257
179
|
|
258
180
|
@typing.overload
|
259
|
-
def
|
181
|
+
def model(*, load: typing.Union[typing.List[str], str, typing.List[typing.Tuple[str, typing.Optional[str]]]] = None, temp_dir_root: str = None) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
260
182
|
"""
|
261
|
-
|
262
|
-
the execution of a step.
|
183
|
+
Enables loading / saving of models within a step.
|
263
184
|
"""
|
264
185
|
...
|
265
186
|
|
266
187
|
@typing.overload
|
267
|
-
def
|
188
|
+
def model(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
268
189
|
...
|
269
190
|
|
270
191
|
@typing.overload
|
271
|
-
def
|
192
|
+
def model(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
272
193
|
...
|
273
194
|
|
274
|
-
def
|
195
|
+
def model(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, load: typing.Union[typing.List[str], str, typing.List[typing.Tuple[str, typing.Optional[str]]]] = None, temp_dir_root: str = None):
|
275
196
|
"""
|
276
|
-
|
277
|
-
the execution of a step.
|
197
|
+
Enables loading / saving of models within a step.
|
278
198
|
"""
|
279
199
|
...
|
280
200
|
|
281
201
|
@typing.overload
|
282
|
-
def
|
202
|
+
def parallel(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
283
203
|
"""
|
284
|
-
|
285
|
-
|
286
|
-
The decorator will create an optional artifact, specified by `var`, which
|
287
|
-
contains the exception raised. You can use it to detect the presence
|
288
|
-
of errors, indicating that all happy-path artifacts produced by the step
|
289
|
-
are missing.
|
204
|
+
Decorator prototype for all step decorators. This function gets specialized
|
205
|
+
and imported for all decorators types by _import_plugin_decorators().
|
290
206
|
"""
|
291
207
|
...
|
292
208
|
|
293
209
|
@typing.overload
|
294
|
-
def
|
295
|
-
...
|
296
|
-
|
297
|
-
@typing.overload
|
298
|
-
def catch(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
210
|
+
def parallel(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
299
211
|
...
|
300
212
|
|
301
|
-
def
|
213
|
+
def parallel(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None):
|
302
214
|
"""
|
303
|
-
|
304
|
-
|
305
|
-
The decorator will create an optional artifact, specified by `var`, which
|
306
|
-
contains the exception raised. You can use it to detect the presence
|
307
|
-
of errors, indicating that all happy-path artifacts produced by the step
|
308
|
-
are missing.
|
215
|
+
Decorator prototype for all step decorators. This function gets specialized
|
216
|
+
and imported for all decorators types by _import_plugin_decorators().
|
309
217
|
"""
|
310
218
|
...
|
311
219
|
|
@@ -349,45 +257,71 @@ def retry(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], ty
|
|
349
257
|
...
|
350
258
|
|
351
259
|
@typing.overload
|
352
|
-
def
|
260
|
+
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
353
261
|
"""
|
354
|
-
|
355
|
-
|
356
|
-
Note that you may add multiple `@card` decorators in a step with different parameters.
|
262
|
+
Internal decorator to support Fast bakery
|
357
263
|
"""
|
358
264
|
...
|
359
265
|
|
360
266
|
@typing.overload
|
361
|
-
def
|
267
|
+
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
362
268
|
...
|
363
269
|
|
364
|
-
|
365
|
-
|
270
|
+
def fast_bakery_internal(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None):
|
271
|
+
"""
|
272
|
+
Internal decorator to support Fast bakery
|
273
|
+
"""
|
366
274
|
...
|
367
275
|
|
368
|
-
|
276
|
+
@typing.overload
|
277
|
+
def environment(*, vars: typing.Dict[str, str] = {}) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
369
278
|
"""
|
370
|
-
|
371
|
-
|
372
|
-
Note that you may add multiple `@card` decorators in a step with different parameters.
|
279
|
+
Specifies environment variables to be set prior to the execution of a step.
|
373
280
|
"""
|
374
281
|
...
|
375
282
|
|
376
|
-
|
283
|
+
@typing.overload
|
284
|
+
def environment(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
285
|
+
...
|
286
|
+
|
287
|
+
@typing.overload
|
288
|
+
def environment(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
289
|
+
...
|
290
|
+
|
291
|
+
def environment(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, vars: typing.Dict[str, str] = {}):
|
377
292
|
"""
|
378
|
-
|
293
|
+
Specifies environment variables to be set prior to the execution of a step.
|
379
294
|
"""
|
380
295
|
...
|
381
296
|
|
382
|
-
|
297
|
+
@typing.overload
|
298
|
+
def catch(*, var: typing.Optional[str] = None, print_exception: bool = True) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
383
299
|
"""
|
384
|
-
Specifies that
|
300
|
+
Specifies that the step will success under all circumstances.
|
301
|
+
|
302
|
+
The decorator will create an optional artifact, specified by `var`, which
|
303
|
+
contains the exception raised. You can use it to detect the presence
|
304
|
+
of errors, indicating that all happy-path artifacts produced by the step
|
305
|
+
are missing.
|
385
306
|
"""
|
386
307
|
...
|
387
308
|
|
388
|
-
|
309
|
+
@typing.overload
|
310
|
+
def catch(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
311
|
+
...
|
312
|
+
|
313
|
+
@typing.overload
|
314
|
+
def catch(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
315
|
+
...
|
316
|
+
|
317
|
+
def catch(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, var: typing.Optional[str] = None, print_exception: bool = True):
|
389
318
|
"""
|
390
|
-
Specifies that
|
319
|
+
Specifies that the step will success under all circumstances.
|
320
|
+
|
321
|
+
The decorator will create an optional artifact, specified by `var`, which
|
322
|
+
contains the exception raised. You can use it to detect the presence
|
323
|
+
of errors, indicating that all happy-path artifacts produced by the step
|
324
|
+
are missing.
|
391
325
|
"""
|
392
326
|
...
|
393
327
|
|
@@ -440,58 +374,6 @@ def resources(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None]
|
|
440
374
|
"""
|
441
375
|
...
|
442
376
|
|
443
|
-
@typing.overload
|
444
|
-
def model(*, load: typing.Union[typing.List[str], str, typing.List[typing.Tuple[str, typing.Optional[str]]]] = None, temp_dir_root: str = None) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
445
|
-
"""
|
446
|
-
Enables loading / saving of models within a step.
|
447
|
-
"""
|
448
|
-
...
|
449
|
-
|
450
|
-
@typing.overload
|
451
|
-
def model(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
452
|
-
...
|
453
|
-
|
454
|
-
@typing.overload
|
455
|
-
def model(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
456
|
-
...
|
457
|
-
|
458
|
-
def model(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, load: typing.Union[typing.List[str], str, typing.List[typing.Tuple[str, typing.Optional[str]]]] = None, temp_dir_root: str = None):
|
459
|
-
"""
|
460
|
-
Enables loading / saving of models within a step.
|
461
|
-
"""
|
462
|
-
...
|
463
|
-
|
464
|
-
@typing.overload
|
465
|
-
def pypi(*, packages: typing.Dict[str, str] = {}, python: typing.Optional[str] = None) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
466
|
-
"""
|
467
|
-
Specifies the PyPI packages for the step.
|
468
|
-
|
469
|
-
Information in this decorator will augment any
|
470
|
-
attributes set in the `@pyi_base` flow-level decorator. Hence,
|
471
|
-
you can use `@pypi_base` to set packages required by all
|
472
|
-
steps and use `@pypi` to specify step-specific overrides.
|
473
|
-
"""
|
474
|
-
...
|
475
|
-
|
476
|
-
@typing.overload
|
477
|
-
def pypi(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
478
|
-
...
|
479
|
-
|
480
|
-
@typing.overload
|
481
|
-
def pypi(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
482
|
-
...
|
483
|
-
|
484
|
-
def pypi(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, packages: typing.Dict[str, str] = {}, python: typing.Optional[str] = None):
|
485
|
-
"""
|
486
|
-
Specifies the PyPI packages for the step.
|
487
|
-
|
488
|
-
Information in this decorator will augment any
|
489
|
-
attributes set in the `@pyi_base` flow-level decorator. Hence,
|
490
|
-
you can use `@pypi_base` to set packages required by all
|
491
|
-
steps and use `@pypi` to specify step-specific overrides.
|
492
|
-
"""
|
493
|
-
...
|
494
|
-
|
495
377
|
@typing.overload
|
496
378
|
def timeout(*, seconds: int = 0, minutes: int = 0, hours: int = 0) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
497
379
|
"""
|
@@ -532,155 +414,129 @@ def timeout(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None],
|
|
532
414
|
...
|
533
415
|
|
534
416
|
@typing.overload
|
535
|
-
def
|
417
|
+
def secrets(*, sources: typing.List[typing.Union[str, typing.Dict[str, typing.Any]]] = []) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
536
418
|
"""
|
537
|
-
Specifies
|
538
|
-
|
539
|
-
```
|
540
|
-
@trigger_on_finish(flow='FooFlow')
|
541
|
-
```
|
542
|
-
or
|
543
|
-
```
|
544
|
-
@trigger_on_finish(flows=['FooFlow', 'BarFlow'])
|
545
|
-
```
|
546
|
-
This decorator respects the @project decorator and triggers the flow
|
547
|
-
when upstream runs within the same namespace complete successfully
|
548
|
-
|
549
|
-
Additionally, you can specify project aware upstream flow dependencies
|
550
|
-
by specifying the fully qualified project_flow_name.
|
551
|
-
```
|
552
|
-
@trigger_on_finish(flow='my_project.branch.my_branch.FooFlow')
|
553
|
-
```
|
554
|
-
or
|
555
|
-
```
|
556
|
-
@trigger_on_finish(flows=['my_project.branch.my_branch.FooFlow', 'BarFlow'])
|
557
|
-
```
|
558
|
-
|
559
|
-
You can also specify just the project or project branch (other values will be
|
560
|
-
inferred from the current project or project branch):
|
561
|
-
```
|
562
|
-
@trigger_on_finish(flow={"name": "FooFlow", "project": "my_project", "project_branch": "branch"})
|
563
|
-
```
|
564
|
-
|
565
|
-
Note that `branch` is typically one of:
|
566
|
-
- `prod`
|
567
|
-
- `user.bob`
|
568
|
-
- `test.my_experiment`
|
569
|
-
- `prod.staging`
|
419
|
+
Specifies secrets to be retrieved and injected as environment variables prior to
|
420
|
+
the execution of a step.
|
570
421
|
"""
|
571
422
|
...
|
572
423
|
|
573
424
|
@typing.overload
|
574
|
-
def
|
425
|
+
def secrets(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
575
426
|
...
|
576
427
|
|
577
|
-
|
428
|
+
@typing.overload
|
429
|
+
def secrets(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
430
|
+
...
|
431
|
+
|
432
|
+
def secrets(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, sources: typing.List[typing.Union[str, typing.Dict[str, typing.Any]]] = []):
|
578
433
|
"""
|
579
|
-
Specifies
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
587
|
-
```
|
588
|
-
This decorator respects the @project decorator and triggers the flow
|
589
|
-
when upstream runs within the same namespace complete successfully
|
590
|
-
|
591
|
-
Additionally, you can specify project aware upstream flow dependencies
|
592
|
-
by specifying the fully qualified project_flow_name.
|
593
|
-
```
|
594
|
-
@trigger_on_finish(flow='my_project.branch.my_branch.FooFlow')
|
595
|
-
```
|
596
|
-
or
|
597
|
-
```
|
598
|
-
@trigger_on_finish(flows=['my_project.branch.my_branch.FooFlow', 'BarFlow'])
|
599
|
-
```
|
600
|
-
|
601
|
-
You can also specify just the project or project branch (other values will be
|
602
|
-
inferred from the current project or project branch):
|
603
|
-
```
|
604
|
-
@trigger_on_finish(flow={"name": "FooFlow", "project": "my_project", "project_branch": "branch"})
|
605
|
-
```
|
606
|
-
|
607
|
-
Note that `branch` is typically one of:
|
608
|
-
- `prod`
|
609
|
-
- `user.bob`
|
610
|
-
- `test.my_experiment`
|
611
|
-
- `prod.staging`
|
434
|
+
Specifies secrets to be retrieved and injected as environment variables prior to
|
435
|
+
the execution of a step.
|
436
|
+
"""
|
437
|
+
...
|
438
|
+
|
439
|
+
def kubernetes(*, cpu: int = 1, memory: int = 4096, disk: int = 10240, image: typing.Optional[str] = None, image_pull_policy: str = 'KUBERNETES_IMAGE_PULL_POLICY', service_account: str = 'METAFLOW_KUBERNETES_SERVICE_ACCOUNT', secrets: typing.Optional[typing.List[str]] = None, node_selector: typing.Union[typing.Dict[str, str], str, None] = None, namespace: str = 'METAFLOW_KUBERNETES_NAMESPACE', gpu: typing.Optional[int] = None, gpu_vendor: str = 'KUBERNETES_GPU_VENDOR', tolerations: typing.List[str] = [], labels: typing.Dict[str, str] = 'METAFLOW_KUBERNETES_LABELS', annotations: typing.Dict[str, str] = 'METAFLOW_KUBERNETES_ANNOTATIONS', use_tmpfs: bool = False, tmpfs_tempdir: bool = True, tmpfs_size: typing.Optional[int] = None, tmpfs_path: typing.Optional[str] = '/metaflow_temp', persistent_volume_claims: typing.Optional[typing.Dict[str, str]] = None, shared_memory: typing.Optional[int] = None, port: typing.Optional[int] = None, compute_pool: typing.Optional[str] = None, hostname_resolution_timeout: int = 600, qos: str = 'Burstable') -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
440
|
+
"""
|
441
|
+
Specifies that this step should execute on Kubernetes.
|
612
442
|
"""
|
613
443
|
...
|
614
444
|
|
615
445
|
@typing.overload
|
616
|
-
def
|
446
|
+
def checkpoint(*, load_policy: str = 'fresh', temp_dir_root: str = None) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
617
447
|
"""
|
618
|
-
|
619
|
-
production scheduler.
|
448
|
+
Enables checkpointing for a step.
|
620
449
|
"""
|
621
450
|
...
|
622
451
|
|
623
452
|
@typing.overload
|
624
|
-
def
|
453
|
+
def checkpoint(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
625
454
|
...
|
626
455
|
|
627
|
-
|
456
|
+
@typing.overload
|
457
|
+
def checkpoint(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
458
|
+
...
|
459
|
+
|
460
|
+
def checkpoint(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, load_policy: str = 'fresh', temp_dir_root: str = None):
|
628
461
|
"""
|
629
|
-
|
630
|
-
production scheduler.
|
462
|
+
Enables checkpointing for a step.
|
631
463
|
"""
|
632
464
|
...
|
633
465
|
|
634
|
-
def
|
466
|
+
def huggingface_hub(*, temp_dir_root: typing.Optional[str] = None, load: typing.Union[typing.List[str], typing.List[typing.Tuple[typing.Dict, str]], typing.List[typing.Tuple[str, str]], typing.List[typing.Dict], None]) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
635
467
|
"""
|
636
|
-
|
637
|
-
This decorator only works when a flow is scheduled on Airflow and is compiled using `airflow create`. More than one `@airflow_external_task_sensor` can be added as a flow decorators. Adding more than one decorator will ensure that `start` step starts only after all sensors finish.
|
468
|
+
Decorator that helps cache, version and store models/datasets from huggingface hub.
|
638
469
|
"""
|
639
470
|
...
|
640
471
|
|
641
472
|
@typing.overload
|
642
|
-
def
|
473
|
+
def conda(*, packages: typing.Dict[str, str] = {}, libraries: typing.Dict[str, str] = {}, python: typing.Optional[str] = None, disabled: bool = False) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
643
474
|
"""
|
644
|
-
Specifies the
|
475
|
+
Specifies the Conda environment for the step.
|
645
476
|
|
646
|
-
|
647
|
-
|
477
|
+
Information in this decorator will augment any
|
478
|
+
attributes set in the `@conda_base` flow-level decorator. Hence,
|
479
|
+
you can use `@conda_base` to set packages required by all
|
480
|
+
steps and use `@conda` to specify step-specific overrides.
|
648
481
|
"""
|
649
482
|
...
|
650
483
|
|
651
484
|
@typing.overload
|
652
|
-
def
|
485
|
+
def conda(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
653
486
|
...
|
654
487
|
|
655
|
-
|
488
|
+
@typing.overload
|
489
|
+
def conda(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
490
|
+
...
|
491
|
+
|
492
|
+
def conda(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, packages: typing.Dict[str, str] = {}, libraries: typing.Dict[str, str] = {}, python: typing.Optional[str] = None, disabled: bool = False):
|
656
493
|
"""
|
657
|
-
Specifies the
|
494
|
+
Specifies the Conda environment for the step.
|
658
495
|
|
659
|
-
|
660
|
-
|
496
|
+
Information in this decorator will augment any
|
497
|
+
attributes set in the `@conda_base` flow-level decorator. Hence,
|
498
|
+
you can use `@conda_base` to set packages required by all
|
499
|
+
steps and use `@conda` to specify step-specific overrides.
|
661
500
|
"""
|
662
501
|
...
|
663
502
|
|
664
503
|
@typing.overload
|
665
|
-
def
|
504
|
+
def card(*, type: str = 'default', id: typing.Optional[str] = None, options: typing.Dict[str, typing.Any] = {}, timeout: int = 45) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
666
505
|
"""
|
667
|
-
|
506
|
+
Creates a human-readable report, a Metaflow Card, after this step completes.
|
668
507
|
|
669
|
-
|
670
|
-
steps and use `@conda` to specify step-specific additions.
|
508
|
+
Note that you may add multiple `@card` decorators in a step with different parameters.
|
671
509
|
"""
|
672
510
|
...
|
673
511
|
|
674
512
|
@typing.overload
|
675
|
-
def
|
513
|
+
def card(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
676
514
|
...
|
677
515
|
|
678
|
-
|
516
|
+
@typing.overload
|
517
|
+
def card(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
518
|
+
...
|
519
|
+
|
520
|
+
def card(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, type: str = 'default', id: typing.Optional[str] = None, options: typing.Dict[str, typing.Any] = {}, timeout: int = 45):
|
679
521
|
"""
|
680
|
-
|
522
|
+
Creates a human-readable report, a Metaflow Card, after this step completes.
|
681
523
|
|
682
|
-
|
683
|
-
|
524
|
+
Note that you may add multiple `@card` decorators in a step with different parameters.
|
525
|
+
"""
|
526
|
+
...
|
527
|
+
|
528
|
+
def nvidia(*, gpu: int, gpu_type: str) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
529
|
+
"""
|
530
|
+
Specifies that this step should execute on DGX cloud.
|
531
|
+
"""
|
532
|
+
...
|
533
|
+
|
534
|
+
def project(*, name: str) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
535
|
+
"""
|
536
|
+
Specifies what flows belong to the same project.
|
537
|
+
|
538
|
+
A project-specific namespace is created for all flows that
|
539
|
+
use the same `@project(name)`.
|
684
540
|
"""
|
685
541
|
...
|
686
542
|
|
@@ -757,12 +613,45 @@ def trigger(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, event: t
|
|
757
613
|
"""
|
758
614
|
...
|
759
615
|
|
760
|
-
|
616
|
+
@typing.overload
|
617
|
+
def schedule(*, hourly: bool = False, daily: bool = True, weekly: bool = False, cron: typing.Optional[str] = None, timezone: typing.Optional[str] = None) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
761
618
|
"""
|
762
|
-
Specifies
|
619
|
+
Specifies the times when the flow should be run when running on a
|
620
|
+
production scheduler.
|
621
|
+
"""
|
622
|
+
...
|
623
|
+
|
624
|
+
@typing.overload
|
625
|
+
def schedule(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
626
|
+
...
|
627
|
+
|
628
|
+
def schedule(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, hourly: bool = False, daily: bool = True, weekly: bool = False, cron: typing.Optional[str] = None, timezone: typing.Optional[str] = None):
|
629
|
+
"""
|
630
|
+
Specifies the times when the flow should be run when running on a
|
631
|
+
production scheduler.
|
632
|
+
"""
|
633
|
+
...
|
634
|
+
|
635
|
+
@typing.overload
|
636
|
+
def pypi_base(*, packages: typing.Dict[str, str] = {}, python: typing.Optional[str] = None) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
637
|
+
"""
|
638
|
+
Specifies the PyPI packages for all steps of the flow.
|
763
639
|
|
764
|
-
|
765
|
-
use
|
640
|
+
Use `@pypi_base` to set common packages required by all
|
641
|
+
steps and use `@pypi` to specify step-specific overrides.
|
642
|
+
"""
|
643
|
+
...
|
644
|
+
|
645
|
+
@typing.overload
|
646
|
+
def pypi_base(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
647
|
+
...
|
648
|
+
|
649
|
+
def pypi_base(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, packages: typing.Dict[str, str] = {}, python: typing.Optional[str] = None):
|
650
|
+
"""
|
651
|
+
Specifies the PyPI packages for all steps of the flow.
|
652
|
+
|
653
|
+
Use `@pypi_base` to set common packages required by all
|
654
|
+
steps and use `@pypi` to specify step-specific overrides.
|
766
655
|
"""
|
767
656
|
...
|
768
657
|
|
@@ -776,6 +665,117 @@ def airflow_s3_key_sensor(*, timeout: int, poke_interval: int, mode: str, expone
|
|
776
665
|
"""
|
777
666
|
...
|
778
667
|
|
668
|
+
@typing.overload
|
669
|
+
def trigger_on_finish(*, flow: typing.Union[typing.Dict[str, str], str, None] = None, flows: typing.List[typing.Union[str, typing.Dict[str, str]]] = [], options: typing.Dict[str, typing.Any] = {}) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
670
|
+
"""
|
671
|
+
Specifies the flow(s) that this flow depends on.
|
672
|
+
|
673
|
+
```
|
674
|
+
@trigger_on_finish(flow='FooFlow')
|
675
|
+
```
|
676
|
+
or
|
677
|
+
```
|
678
|
+
@trigger_on_finish(flows=['FooFlow', 'BarFlow'])
|
679
|
+
```
|
680
|
+
This decorator respects the @project decorator and triggers the flow
|
681
|
+
when upstream runs within the same namespace complete successfully
|
682
|
+
|
683
|
+
Additionally, you can specify project aware upstream flow dependencies
|
684
|
+
by specifying the fully qualified project_flow_name.
|
685
|
+
```
|
686
|
+
@trigger_on_finish(flow='my_project.branch.my_branch.FooFlow')
|
687
|
+
```
|
688
|
+
or
|
689
|
+
```
|
690
|
+
@trigger_on_finish(flows=['my_project.branch.my_branch.FooFlow', 'BarFlow'])
|
691
|
+
```
|
692
|
+
|
693
|
+
You can also specify just the project or project branch (other values will be
|
694
|
+
inferred from the current project or project branch):
|
695
|
+
```
|
696
|
+
@trigger_on_finish(flow={"name": "FooFlow", "project": "my_project", "project_branch": "branch"})
|
697
|
+
```
|
698
|
+
|
699
|
+
Note that `branch` is typically one of:
|
700
|
+
- `prod`
|
701
|
+
- `user.bob`
|
702
|
+
- `test.my_experiment`
|
703
|
+
- `prod.staging`
|
704
|
+
"""
|
705
|
+
...
|
706
|
+
|
707
|
+
@typing.overload
|
708
|
+
def trigger_on_finish(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
709
|
+
...
|
710
|
+
|
711
|
+
def trigger_on_finish(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, flow: typing.Union[typing.Dict[str, str], str, None] = None, flows: typing.List[typing.Union[str, typing.Dict[str, str]]] = [], options: typing.Dict[str, typing.Any] = {}):
|
712
|
+
"""
|
713
|
+
Specifies the flow(s) that this flow depends on.
|
714
|
+
|
715
|
+
```
|
716
|
+
@trigger_on_finish(flow='FooFlow')
|
717
|
+
```
|
718
|
+
or
|
719
|
+
```
|
720
|
+
@trigger_on_finish(flows=['FooFlow', 'BarFlow'])
|
721
|
+
```
|
722
|
+
This decorator respects the @project decorator and triggers the flow
|
723
|
+
when upstream runs within the same namespace complete successfully
|
724
|
+
|
725
|
+
Additionally, you can specify project aware upstream flow dependencies
|
726
|
+
by specifying the fully qualified project_flow_name.
|
727
|
+
```
|
728
|
+
@trigger_on_finish(flow='my_project.branch.my_branch.FooFlow')
|
729
|
+
```
|
730
|
+
or
|
731
|
+
```
|
732
|
+
@trigger_on_finish(flows=['my_project.branch.my_branch.FooFlow', 'BarFlow'])
|
733
|
+
```
|
734
|
+
|
735
|
+
You can also specify just the project or project branch (other values will be
|
736
|
+
inferred from the current project or project branch):
|
737
|
+
```
|
738
|
+
@trigger_on_finish(flow={"name": "FooFlow", "project": "my_project", "project_branch": "branch"})
|
739
|
+
```
|
740
|
+
|
741
|
+
Note that `branch` is typically one of:
|
742
|
+
- `prod`
|
743
|
+
- `user.bob`
|
744
|
+
- `test.my_experiment`
|
745
|
+
- `prod.staging`
|
746
|
+
"""
|
747
|
+
...
|
748
|
+
|
749
|
+
@typing.overload
|
750
|
+
def conda_base(*, packages: typing.Dict[str, str] = {}, libraries: typing.Dict[str, str] = {}, python: typing.Optional[str] = None, disabled: bool = False) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
751
|
+
"""
|
752
|
+
Specifies the Conda environment for all steps of the flow.
|
753
|
+
|
754
|
+
Use `@conda_base` to set common libraries required by all
|
755
|
+
steps and use `@conda` to specify step-specific additions.
|
756
|
+
"""
|
757
|
+
...
|
758
|
+
|
759
|
+
@typing.overload
|
760
|
+
def conda_base(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
761
|
+
...
|
762
|
+
|
763
|
+
def conda_base(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, packages: typing.Dict[str, str] = {}, libraries: typing.Dict[str, str] = {}, python: typing.Optional[str] = None, disabled: bool = False):
|
764
|
+
"""
|
765
|
+
Specifies the Conda environment for all steps of the flow.
|
766
|
+
|
767
|
+
Use `@conda_base` to set common libraries required by all
|
768
|
+
steps and use `@conda` to specify step-specific additions.
|
769
|
+
"""
|
770
|
+
...
|
771
|
+
|
772
|
+
def airflow_external_task_sensor(*, timeout: int, poke_interval: int, mode: str, exponential_backoff: bool, pool: str, soft_fail: bool, name: str, description: str, external_dag_id: str, external_task_ids: typing.List[str], allowed_states: typing.List[str], failed_states: typing.List[str], execution_delta: "datetime.timedelta", check_existence: bool) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
773
|
+
"""
|
774
|
+
The `@airflow_external_task_sensor` decorator attaches a Airflow [ExternalTaskSensor](https://airflow.apache.org/docs/apache-airflow/stable/_api/airflow/sensors/external_task/index.html#airflow.sensors.external_task.ExternalTaskSensor) before the start step of the flow.
|
775
|
+
This decorator only works when a flow is scheduled on Airflow and is compiled using `airflow create`. More than one `@airflow_external_task_sensor` can be added as a flow decorators. Adding more than one decorator will ensure that `start` step starts only after all sensors finish.
|
776
|
+
"""
|
777
|
+
...
|
778
|
+
|
779
779
|
def nim(*, models: "list[NIM]", backend: str) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
780
780
|
"""
|
781
781
|
This decorator is used to run NIM containers in Metaflow tasks as sidecars.
|