ob-metaflow-stubs 6.0.3.135__py2.py3-none-any.whl → 6.0.3.136__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 +272 -272
- 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 +5 -5
- metaflow-stubs/client/filecache.pyi +2 -2
- metaflow-stubs/events.pyi +3 -3
- metaflow-stubs/exception.pyi +2 -2
- metaflow-stubs/flowspec.pyi +4 -4
- 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 +3 -3
- 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 +4 -4
- 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 +3 -3
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- 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 +4 -4
- 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 +3 -3
- 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 +2 -2
- 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 +3 -3
- metaflow-stubs/plugins/__init__.pyi +10 -10
- 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 +2 -2
- metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
- metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +3 -3
- 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 +3 -3
- 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 +3 -3
- 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 +2 -2
- metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/basic.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/components.pyi +2 -2
- 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 +2 -2
- 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 +2 -2
- 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/kubernetes/spot_monitor_sidecar.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 +2 -2
- metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
- metaflow-stubs/plugins/pypi/conda_environment.pyi +3 -3
- 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 +2 -2
- metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +2 -2
- 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 +2 -2
- 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 +4 -4
- metaflow-stubs/runner/deployer_impl.pyi +3 -3
- 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 +6 -6
- metaflow-stubs/user_configs/config_options.pyi +3 -3
- metaflow-stubs/user_configs/config_parameters.pyi +5 -5
- {ob_metaflow_stubs-6.0.3.135.dist-info → ob_metaflow_stubs-6.0.3.136.dist-info}/METADATA +1 -1
- ob_metaflow_stubs-6.0.3.136.dist-info/RECORD +192 -0
- ob_metaflow_stubs-6.0.3.135.dist-info/RECORD +0 -192
- {ob_metaflow_stubs-6.0.3.135.dist-info → ob_metaflow_stubs-6.0.3.136.dist-info}/WHEEL +0 -0
- {ob_metaflow_stubs-6.0.3.135.dist-info → ob_metaflow_stubs-6.0.3.136.dist-info}/top_level.txt +0 -0
metaflow-stubs/__init__.pyi
CHANGED
@@ -1,15 +1,15 @@
|
|
1
1
|
######################################################################################################
|
2
2
|
# Auto-generated Metaflow stub file #
|
3
|
-
# MF version: 2.13.
|
4
|
-
# Generated on 2025-01-
|
3
|
+
# MF version: 2.13.9.1+obcheckpoint(0.1.6);ob(v1) #
|
4
|
+
# Generated on 2025-01-31T18:07:50.935996 #
|
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 datetime
|
12
|
+
import typing
|
13
13
|
FlowSpecDerived = typing.TypeVar("FlowSpecDerived", bound="FlowSpec", contravariant=False, covariant=False)
|
14
14
|
StepFlag = typing.NewType("StepFlag", bool)
|
15
15
|
|
@@ -35,9 +35,9 @@ from .user_configs.config_parameters import ConfigValue as ConfigValue
|
|
35
35
|
from .user_configs.config_parameters import config_expr as config_expr
|
36
36
|
from .user_configs.config_decorators import CustomFlowDecorator as CustomFlowDecorator
|
37
37
|
from .user_configs.config_decorators import CustomStepDecorator as CustomStepDecorator
|
38
|
-
from . import events as events
|
39
38
|
from . import tuple_util as tuple_util
|
40
39
|
from . import cards as cards
|
40
|
+
from . import events as events
|
41
41
|
from . import runner as runner
|
42
42
|
from . import plugins as plugins
|
43
43
|
from .mf_extensions.outerbounds.toplevel.global_aliases_for_metaflow_package import S3 as S3
|
@@ -146,6 +146,93 @@ def step(f: typing.Union[typing.Callable[[FlowSpecDerived], None], typing.Callab
|
|
146
146
|
"""
|
147
147
|
...
|
148
148
|
|
149
|
+
@typing.overload
|
150
|
+
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]]]:
|
151
|
+
"""
|
152
|
+
Enables loading / saving of models within a step.
|
153
|
+
"""
|
154
|
+
...
|
155
|
+
|
156
|
+
@typing.overload
|
157
|
+
def model(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
158
|
+
...
|
159
|
+
|
160
|
+
@typing.overload
|
161
|
+
def model(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
162
|
+
...
|
163
|
+
|
164
|
+
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):
|
165
|
+
"""
|
166
|
+
Enables loading / saving of models within a step.
|
167
|
+
"""
|
168
|
+
...
|
169
|
+
|
170
|
+
@typing.overload
|
171
|
+
def resources(*, cpu: int = 1, gpu: typing.Optional[int] = None, disk: typing.Optional[int] = None, memory: int = 4096, shared_memory: typing.Optional[int] = 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]]]:
|
172
|
+
"""
|
173
|
+
Specifies the resources needed when executing this step.
|
174
|
+
|
175
|
+
Use `@resources` to specify the resource requirements
|
176
|
+
independently of the specific compute layer (`@batch`, `@kubernetes`).
|
177
|
+
|
178
|
+
You can choose the compute layer on the command line by executing e.g.
|
179
|
+
```
|
180
|
+
python myflow.py run --with batch
|
181
|
+
```
|
182
|
+
or
|
183
|
+
```
|
184
|
+
python myflow.py run --with kubernetes
|
185
|
+
```
|
186
|
+
which executes the flow on the desired system using the
|
187
|
+
requirements specified in `@resources`.
|
188
|
+
"""
|
189
|
+
...
|
190
|
+
|
191
|
+
@typing.overload
|
192
|
+
def resources(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
193
|
+
...
|
194
|
+
|
195
|
+
@typing.overload
|
196
|
+
def resources(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
197
|
+
...
|
198
|
+
|
199
|
+
def resources(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, cpu: int = 1, gpu: typing.Optional[int] = None, disk: typing.Optional[int] = None, memory: int = 4096, shared_memory: typing.Optional[int] = None):
|
200
|
+
"""
|
201
|
+
Specifies the resources needed when executing this step.
|
202
|
+
|
203
|
+
Use `@resources` to specify the resource requirements
|
204
|
+
independently of the specific compute layer (`@batch`, `@kubernetes`).
|
205
|
+
|
206
|
+
You can choose the compute layer on the command line by executing e.g.
|
207
|
+
```
|
208
|
+
python myflow.py run --with batch
|
209
|
+
```
|
210
|
+
or
|
211
|
+
```
|
212
|
+
python myflow.py run --with kubernetes
|
213
|
+
```
|
214
|
+
which executes the flow on the desired system using the
|
215
|
+
requirements specified in `@resources`.
|
216
|
+
"""
|
217
|
+
...
|
218
|
+
|
219
|
+
@typing.overload
|
220
|
+
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
221
|
+
"""
|
222
|
+
Internal decorator to support Fast bakery
|
223
|
+
"""
|
224
|
+
...
|
225
|
+
|
226
|
+
@typing.overload
|
227
|
+
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
228
|
+
...
|
229
|
+
|
230
|
+
def fast_bakery_internal(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None):
|
231
|
+
"""
|
232
|
+
Internal decorator to support Fast bakery
|
233
|
+
"""
|
234
|
+
...
|
235
|
+
|
149
236
|
@typing.overload
|
150
237
|
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]]]:
|
151
238
|
"""
|
@@ -177,12 +264,6 @@ def conda(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], ty
|
|
177
264
|
"""
|
178
265
|
...
|
179
266
|
|
180
|
-
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]]]:
|
181
|
-
"""
|
182
|
-
Specifies that this step should execute on DGX cloud.
|
183
|
-
"""
|
184
|
-
...
|
185
|
-
|
186
267
|
@typing.overload
|
187
268
|
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]]]:
|
188
269
|
"""
|
@@ -214,6 +295,12 @@ def catch(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], ty
|
|
214
295
|
"""
|
215
296
|
...
|
216
297
|
|
298
|
+
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]]]:
|
299
|
+
"""
|
300
|
+
Specifies that this step should execute on DGX cloud.
|
301
|
+
"""
|
302
|
+
...
|
303
|
+
|
217
304
|
@typing.overload
|
218
305
|
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]]]:
|
219
306
|
"""
|
@@ -236,51 +323,23 @@ def checkpoint(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None
|
|
236
323
|
...
|
237
324
|
|
238
325
|
@typing.overload
|
239
|
-
def
|
326
|
+
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]]]:
|
240
327
|
"""
|
241
|
-
Specifies
|
242
|
-
|
243
|
-
Use `@resources` to specify the resource requirements
|
244
|
-
independently of the specific compute layer (`@batch`, `@kubernetes`).
|
245
|
-
|
246
|
-
You can choose the compute layer on the command line by executing e.g.
|
247
|
-
```
|
248
|
-
python myflow.py run --with batch
|
249
|
-
```
|
250
|
-
or
|
251
|
-
```
|
252
|
-
python myflow.py run --with kubernetes
|
253
|
-
```
|
254
|
-
which executes the flow on the desired system using the
|
255
|
-
requirements specified in `@resources`.
|
328
|
+
Specifies environment variables to be set prior to the execution of a step.
|
256
329
|
"""
|
257
330
|
...
|
258
331
|
|
259
332
|
@typing.overload
|
260
|
-
def
|
333
|
+
def environment(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
261
334
|
...
|
262
335
|
|
263
336
|
@typing.overload
|
264
|
-
def
|
337
|
+
def environment(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
265
338
|
...
|
266
339
|
|
267
|
-
def
|
340
|
+
def environment(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, vars: typing.Dict[str, str] = {}):
|
268
341
|
"""
|
269
|
-
Specifies
|
270
|
-
|
271
|
-
Use `@resources` to specify the resource requirements
|
272
|
-
independently of the specific compute layer (`@batch`, `@kubernetes`).
|
273
|
-
|
274
|
-
You can choose the compute layer on the command line by executing e.g.
|
275
|
-
```
|
276
|
-
python myflow.py run --with batch
|
277
|
-
```
|
278
|
-
or
|
279
|
-
```
|
280
|
-
python myflow.py run --with kubernetes
|
281
|
-
```
|
282
|
-
which executes the flow on the desired system using the
|
283
|
-
requirements specified in `@resources`.
|
342
|
+
Specifies environment variables to be set prior to the execution of a step.
|
284
343
|
"""
|
285
344
|
...
|
286
345
|
|
@@ -323,80 +382,98 @@ def timeout(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None],
|
|
323
382
|
"""
|
324
383
|
...
|
325
384
|
|
385
|
+
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]]]:
|
386
|
+
"""
|
387
|
+
Decorator that helps cache, version and store models/datasets from huggingface hub.
|
388
|
+
"""
|
389
|
+
...
|
390
|
+
|
326
391
|
@typing.overload
|
327
|
-
def
|
392
|
+
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]]]:
|
328
393
|
"""
|
329
|
-
Specifies the
|
330
|
-
to a step needs to be retried.
|
331
|
-
|
332
|
-
This decorator is useful for handling transient errors, such as networking issues.
|
333
|
-
If your task contains operations that can't be retried safely, e.g. database updates,
|
334
|
-
it is advisable to annotate it with `@retry(times=0)`.
|
394
|
+
Specifies the PyPI packages for the step.
|
335
395
|
|
336
|
-
|
337
|
-
|
338
|
-
|
396
|
+
Information in this decorator will augment any
|
397
|
+
attributes set in the `@pyi_base` flow-level decorator. Hence,
|
398
|
+
you can use `@pypi_base` to set packages required by all
|
399
|
+
steps and use `@pypi` to specify step-specific overrides.
|
339
400
|
"""
|
340
401
|
...
|
341
402
|
|
342
403
|
@typing.overload
|
343
|
-
def
|
404
|
+
def pypi(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
344
405
|
...
|
345
406
|
|
346
407
|
@typing.overload
|
347
|
-
def
|
408
|
+
def pypi(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
348
409
|
...
|
349
410
|
|
350
|
-
def
|
411
|
+
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):
|
351
412
|
"""
|
352
|
-
Specifies the
|
353
|
-
to a step needs to be retried.
|
354
|
-
|
355
|
-
This decorator is useful for handling transient errors, such as networking issues.
|
356
|
-
If your task contains operations that can't be retried safely, e.g. database updates,
|
357
|
-
it is advisable to annotate it with `@retry(times=0)`.
|
413
|
+
Specifies the PyPI packages for the step.
|
358
414
|
|
359
|
-
|
360
|
-
|
361
|
-
|
415
|
+
Information in this decorator will augment any
|
416
|
+
attributes set in the `@pyi_base` flow-level decorator. Hence,
|
417
|
+
you can use `@pypi_base` to set packages required by all
|
418
|
+
steps and use `@pypi` to specify step-specific overrides.
|
362
419
|
"""
|
363
420
|
...
|
364
421
|
|
365
422
|
@typing.overload
|
366
|
-
def
|
423
|
+
def parallel(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
367
424
|
"""
|
368
|
-
|
425
|
+
Decorator prototype for all step decorators. This function gets specialized
|
426
|
+
and imported for all decorators types by _import_plugin_decorators().
|
369
427
|
"""
|
370
428
|
...
|
371
429
|
|
372
430
|
@typing.overload
|
373
|
-
def
|
374
|
-
...
|
375
|
-
|
376
|
-
@typing.overload
|
377
|
-
def model(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
431
|
+
def parallel(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
378
432
|
...
|
379
433
|
|
380
|
-
def
|
434
|
+
def parallel(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None):
|
381
435
|
"""
|
382
|
-
|
436
|
+
Decorator prototype for all step decorators. This function gets specialized
|
437
|
+
and imported for all decorators types by _import_plugin_decorators().
|
383
438
|
"""
|
384
439
|
...
|
385
440
|
|
386
441
|
@typing.overload
|
387
|
-
def
|
442
|
+
def retry(*, times: int = 3, minutes_between_retries: int = 2) -> 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]]]:
|
388
443
|
"""
|
389
|
-
|
444
|
+
Specifies the number of times the task corresponding
|
445
|
+
to a step needs to be retried.
|
446
|
+
|
447
|
+
This decorator is useful for handling transient errors, such as networking issues.
|
448
|
+
If your task contains operations that can't be retried safely, e.g. database updates,
|
449
|
+
it is advisable to annotate it with `@retry(times=0)`.
|
450
|
+
|
451
|
+
This can be used in conjunction with the `@catch` decorator. The `@catch`
|
452
|
+
decorator will execute a no-op task after all retries have been exhausted,
|
453
|
+
ensuring that the flow execution can continue.
|
390
454
|
"""
|
391
455
|
...
|
392
456
|
|
393
457
|
@typing.overload
|
394
|
-
def
|
458
|
+
def retry(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
395
459
|
...
|
396
460
|
|
397
|
-
|
461
|
+
@typing.overload
|
462
|
+
def retry(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
463
|
+
...
|
464
|
+
|
465
|
+
def retry(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, times: int = 3, minutes_between_retries: int = 2):
|
398
466
|
"""
|
399
|
-
|
467
|
+
Specifies the number of times the task corresponding
|
468
|
+
to a step needs to be retried.
|
469
|
+
|
470
|
+
This decorator is useful for handling transient errors, such as networking issues.
|
471
|
+
If your task contains operations that can't be retried safely, e.g. database updates,
|
472
|
+
it is advisable to annotate it with `@retry(times=0)`.
|
473
|
+
|
474
|
+
This can be used in conjunction with the `@catch` decorator. The `@catch`
|
475
|
+
decorator will execute a no-op task after all retries have been exhausted,
|
476
|
+
ensuring that the flow execution can continue.
|
400
477
|
"""
|
401
478
|
...
|
402
479
|
|
@@ -425,109 +502,91 @@ def card(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typ
|
|
425
502
|
"""
|
426
503
|
...
|
427
504
|
|
428
|
-
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]]]:
|
429
|
-
"""
|
430
|
-
Specifies that this step should execute on Kubernetes.
|
431
|
-
"""
|
432
|
-
...
|
433
|
-
|
434
505
|
@typing.overload
|
435
|
-
def
|
506
|
+
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]]]:
|
436
507
|
"""
|
437
|
-
Specifies
|
438
|
-
|
439
|
-
Information in this decorator will augment any
|
440
|
-
attributes set in the `@pyi_base` flow-level decorator. Hence,
|
441
|
-
you can use `@pypi_base` to set packages required by all
|
442
|
-
steps and use `@pypi` to specify step-specific overrides.
|
508
|
+
Specifies secrets to be retrieved and injected as environment variables prior to
|
509
|
+
the execution of a step.
|
443
510
|
"""
|
444
511
|
...
|
445
512
|
|
446
513
|
@typing.overload
|
447
|
-
def
|
514
|
+
def secrets(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
448
515
|
...
|
449
516
|
|
450
517
|
@typing.overload
|
451
|
-
def
|
518
|
+
def secrets(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
452
519
|
...
|
453
520
|
|
454
|
-
def
|
521
|
+
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]]] = []):
|
455
522
|
"""
|
456
|
-
Specifies
|
457
|
-
|
458
|
-
Information in this decorator will augment any
|
459
|
-
attributes set in the `@pyi_base` flow-level decorator. Hence,
|
460
|
-
you can use `@pypi_base` to set packages required by all
|
461
|
-
steps and use `@pypi` to specify step-specific overrides.
|
462
|
-
"""
|
463
|
-
...
|
464
|
-
|
465
|
-
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]]]:
|
466
|
-
"""
|
467
|
-
Decorator that helps cache, version and store models/datasets from huggingface hub.
|
523
|
+
Specifies secrets to be retrieved and injected as environment variables prior to
|
524
|
+
the execution of a step.
|
468
525
|
"""
|
469
526
|
...
|
470
527
|
|
471
|
-
|
472
|
-
def parallel(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
528
|
+
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]]]:
|
473
529
|
"""
|
474
|
-
|
475
|
-
and imported for all decorators types by _import_plugin_decorators().
|
530
|
+
Specifies that this step should execute on Kubernetes.
|
476
531
|
"""
|
477
532
|
...
|
478
533
|
|
479
|
-
|
480
|
-
def parallel(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
481
|
-
...
|
482
|
-
|
483
|
-
def parallel(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None):
|
534
|
+
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]]:
|
484
535
|
"""
|
485
|
-
|
486
|
-
and
|
536
|
+
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.
|
537
|
+
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.
|
487
538
|
"""
|
488
539
|
...
|
489
540
|
|
490
541
|
@typing.overload
|
491
|
-
def
|
542
|
+
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]]:
|
492
543
|
"""
|
493
|
-
Specifies
|
544
|
+
Specifies the times when the flow should be run when running on a
|
545
|
+
production scheduler.
|
494
546
|
"""
|
495
547
|
...
|
496
548
|
|
497
549
|
@typing.overload
|
498
|
-
def
|
499
|
-
...
|
500
|
-
|
501
|
-
@typing.overload
|
502
|
-
def environment(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
550
|
+
def schedule(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
503
551
|
...
|
504
552
|
|
505
|
-
def
|
553
|
+
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):
|
506
554
|
"""
|
507
|
-
Specifies
|
555
|
+
Specifies the times when the flow should be run when running on a
|
556
|
+
production scheduler.
|
508
557
|
"""
|
509
558
|
...
|
510
559
|
|
511
560
|
@typing.overload
|
512
|
-
def
|
561
|
+
def pypi_base(*, packages: typing.Dict[str, str] = {}, python: typing.Optional[str] = None) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
513
562
|
"""
|
514
|
-
Specifies
|
515
|
-
|
563
|
+
Specifies the PyPI packages for all steps of the flow.
|
564
|
+
|
565
|
+
Use `@pypi_base` to set common packages required by all
|
566
|
+
steps and use `@pypi` to specify step-specific overrides.
|
516
567
|
"""
|
517
568
|
...
|
518
569
|
|
519
570
|
@typing.overload
|
520
|
-
def
|
571
|
+
def pypi_base(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
521
572
|
...
|
522
573
|
|
523
|
-
|
524
|
-
|
574
|
+
def pypi_base(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, packages: typing.Dict[str, str] = {}, python: typing.Optional[str] = None):
|
575
|
+
"""
|
576
|
+
Specifies the PyPI packages for all steps of the flow.
|
577
|
+
|
578
|
+
Use `@pypi_base` to set common packages required by all
|
579
|
+
steps and use `@pypi` to specify step-specific overrides.
|
580
|
+
"""
|
525
581
|
...
|
526
582
|
|
527
|
-
def
|
583
|
+
def airflow_s3_key_sensor(*, timeout: int, poke_interval: int, mode: str, exponential_backoff: bool, pool: str, soft_fail: bool, name: str, description: str, bucket_key: typing.Union[str, typing.List[str]], bucket_name: str, wildcard_match: bool, aws_conn_id: str, verify: bool) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
528
584
|
"""
|
529
|
-
|
530
|
-
the
|
585
|
+
The `@airflow_s3_key_sensor` decorator attaches a Airflow [S3KeySensor](https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/_api/airflow/providers/amazon/aws/sensors/s3/index.html#airflow.providers.amazon.aws.sensors.s3.S3KeySensor)
|
586
|
+
before the start step of the flow. This decorator only works when a flow is scheduled on Airflow
|
587
|
+
and is compiled using `airflow create`. More than one `@airflow_s3_key_sensor` can be
|
588
|
+
added as a flow decorators. Adding more than one decorator will ensure that `start` step
|
589
|
+
starts only after all sensors finish.
|
531
590
|
"""
|
532
591
|
...
|
533
592
|
|
@@ -555,45 +614,84 @@ def nim(*, models: "list[NIM]", backend: str) -> typing.Callable[[typing.Type[Fl
|
|
555
614
|
"""
|
556
615
|
...
|
557
616
|
|
558
|
-
def project(*, name: str) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
559
|
-
"""
|
560
|
-
Specifies what flows belong to the same project.
|
561
|
-
|
562
|
-
A project-specific namespace is created for all flows that
|
563
|
-
use the same `@project(name)`.
|
564
|
-
"""
|
565
|
-
...
|
566
|
-
|
567
|
-
def airflow_s3_key_sensor(*, timeout: int, poke_interval: int, mode: str, exponential_backoff: bool, pool: str, soft_fail: bool, name: str, description: str, bucket_key: typing.Union[str, typing.List[str]], bucket_name: str, wildcard_match: bool, aws_conn_id: str, verify: bool) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
568
|
-
"""
|
569
|
-
The `@airflow_s3_key_sensor` decorator attaches a Airflow [S3KeySensor](https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/_api/airflow/providers/amazon/aws/sensors/s3/index.html#airflow.providers.amazon.aws.sensors.s3.S3KeySensor)
|
570
|
-
before the start step of the flow. This decorator only works when a flow is scheduled on Airflow
|
571
|
-
and is compiled using `airflow create`. More than one `@airflow_s3_key_sensor` can be
|
572
|
-
added as a flow decorators. Adding more than one decorator will ensure that `start` step
|
573
|
-
starts only after all sensors finish.
|
574
|
-
"""
|
575
|
-
...
|
576
|
-
|
577
617
|
@typing.overload
|
578
|
-
def
|
618
|
+
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]]:
|
579
619
|
"""
|
580
|
-
Specifies the
|
620
|
+
Specifies the flow(s) that this flow depends on.
|
581
621
|
|
582
|
-
|
583
|
-
|
622
|
+
```
|
623
|
+
@trigger_on_finish(flow='FooFlow')
|
624
|
+
```
|
625
|
+
or
|
626
|
+
```
|
627
|
+
@trigger_on_finish(flows=['FooFlow', 'BarFlow'])
|
628
|
+
```
|
629
|
+
This decorator respects the @project decorator and triggers the flow
|
630
|
+
when upstream runs within the same namespace complete successfully
|
631
|
+
|
632
|
+
Additionally, you can specify project aware upstream flow dependencies
|
633
|
+
by specifying the fully qualified project_flow_name.
|
634
|
+
```
|
635
|
+
@trigger_on_finish(flow='my_project.branch.my_branch.FooFlow')
|
636
|
+
```
|
637
|
+
or
|
638
|
+
```
|
639
|
+
@trigger_on_finish(flows=['my_project.branch.my_branch.FooFlow', 'BarFlow'])
|
640
|
+
```
|
641
|
+
|
642
|
+
You can also specify just the project or project branch (other values will be
|
643
|
+
inferred from the current project or project branch):
|
644
|
+
```
|
645
|
+
@trigger_on_finish(flow={"name": "FooFlow", "project": "my_project", "project_branch": "branch"})
|
646
|
+
```
|
647
|
+
|
648
|
+
Note that `branch` is typically one of:
|
649
|
+
- `prod`
|
650
|
+
- `user.bob`
|
651
|
+
- `test.my_experiment`
|
652
|
+
- `prod.staging`
|
584
653
|
"""
|
585
654
|
...
|
586
655
|
|
587
656
|
@typing.overload
|
588
|
-
def
|
657
|
+
def trigger_on_finish(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
589
658
|
...
|
590
659
|
|
591
|
-
def
|
660
|
+
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] = {}):
|
592
661
|
"""
|
593
|
-
Specifies the
|
662
|
+
Specifies the flow(s) that this flow depends on.
|
594
663
|
|
595
|
-
|
596
|
-
|
664
|
+
```
|
665
|
+
@trigger_on_finish(flow='FooFlow')
|
666
|
+
```
|
667
|
+
or
|
668
|
+
```
|
669
|
+
@trigger_on_finish(flows=['FooFlow', 'BarFlow'])
|
670
|
+
```
|
671
|
+
This decorator respects the @project decorator and triggers the flow
|
672
|
+
when upstream runs within the same namespace complete successfully
|
673
|
+
|
674
|
+
Additionally, you can specify project aware upstream flow dependencies
|
675
|
+
by specifying the fully qualified project_flow_name.
|
676
|
+
```
|
677
|
+
@trigger_on_finish(flow='my_project.branch.my_branch.FooFlow')
|
678
|
+
```
|
679
|
+
or
|
680
|
+
```
|
681
|
+
@trigger_on_finish(flows=['my_project.branch.my_branch.FooFlow', 'BarFlow'])
|
682
|
+
```
|
683
|
+
|
684
|
+
You can also specify just the project or project branch (other values will be
|
685
|
+
inferred from the current project or project branch):
|
686
|
+
```
|
687
|
+
@trigger_on_finish(flow={"name": "FooFlow", "project": "my_project", "project_branch": "branch"})
|
688
|
+
```
|
689
|
+
|
690
|
+
Note that `branch` is typically one of:
|
691
|
+
- `prod`
|
692
|
+
- `user.bob`
|
693
|
+
- `test.my_experiment`
|
694
|
+
- `prod.staging`
|
597
695
|
"""
|
598
696
|
...
|
599
697
|
|
@@ -670,6 +768,15 @@ def trigger(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, event: t
|
|
670
768
|
"""
|
671
769
|
...
|
672
770
|
|
771
|
+
def project(*, name: str) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
772
|
+
"""
|
773
|
+
Specifies what flows belong to the same project.
|
774
|
+
|
775
|
+
A project-specific namespace is created for all flows that
|
776
|
+
use the same `@project(name)`.
|
777
|
+
"""
|
778
|
+
...
|
779
|
+
|
673
780
|
@typing.overload
|
674
781
|
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]]:
|
675
782
|
"""
|
@@ -693,112 +800,5 @@ def conda_base(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, packa
|
|
693
800
|
"""
|
694
801
|
...
|
695
802
|
|
696
|
-
@typing.overload
|
697
|
-
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]]:
|
698
|
-
"""
|
699
|
-
Specifies the flow(s) that this flow depends on.
|
700
|
-
|
701
|
-
```
|
702
|
-
@trigger_on_finish(flow='FooFlow')
|
703
|
-
```
|
704
|
-
or
|
705
|
-
```
|
706
|
-
@trigger_on_finish(flows=['FooFlow', 'BarFlow'])
|
707
|
-
```
|
708
|
-
This decorator respects the @project decorator and triggers the flow
|
709
|
-
when upstream runs within the same namespace complete successfully
|
710
|
-
|
711
|
-
Additionally, you can specify project aware upstream flow dependencies
|
712
|
-
by specifying the fully qualified project_flow_name.
|
713
|
-
```
|
714
|
-
@trigger_on_finish(flow='my_project.branch.my_branch.FooFlow')
|
715
|
-
```
|
716
|
-
or
|
717
|
-
```
|
718
|
-
@trigger_on_finish(flows=['my_project.branch.my_branch.FooFlow', 'BarFlow'])
|
719
|
-
```
|
720
|
-
|
721
|
-
You can also specify just the project or project branch (other values will be
|
722
|
-
inferred from the current project or project branch):
|
723
|
-
```
|
724
|
-
@trigger_on_finish(flow={"name": "FooFlow", "project": "my_project", "project_branch": "branch"})
|
725
|
-
```
|
726
|
-
|
727
|
-
Note that `branch` is typically one of:
|
728
|
-
- `prod`
|
729
|
-
- `user.bob`
|
730
|
-
- `test.my_experiment`
|
731
|
-
- `prod.staging`
|
732
|
-
"""
|
733
|
-
...
|
734
|
-
|
735
|
-
@typing.overload
|
736
|
-
def trigger_on_finish(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
737
|
-
...
|
738
|
-
|
739
|
-
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] = {}):
|
740
|
-
"""
|
741
|
-
Specifies the flow(s) that this flow depends on.
|
742
|
-
|
743
|
-
```
|
744
|
-
@trigger_on_finish(flow='FooFlow')
|
745
|
-
```
|
746
|
-
or
|
747
|
-
```
|
748
|
-
@trigger_on_finish(flows=['FooFlow', 'BarFlow'])
|
749
|
-
```
|
750
|
-
This decorator respects the @project decorator and triggers the flow
|
751
|
-
when upstream runs within the same namespace complete successfully
|
752
|
-
|
753
|
-
Additionally, you can specify project aware upstream flow dependencies
|
754
|
-
by specifying the fully qualified project_flow_name.
|
755
|
-
```
|
756
|
-
@trigger_on_finish(flow='my_project.branch.my_branch.FooFlow')
|
757
|
-
```
|
758
|
-
or
|
759
|
-
```
|
760
|
-
@trigger_on_finish(flows=['my_project.branch.my_branch.FooFlow', 'BarFlow'])
|
761
|
-
```
|
762
|
-
|
763
|
-
You can also specify just the project or project branch (other values will be
|
764
|
-
inferred from the current project or project branch):
|
765
|
-
```
|
766
|
-
@trigger_on_finish(flow={"name": "FooFlow", "project": "my_project", "project_branch": "branch"})
|
767
|
-
```
|
768
|
-
|
769
|
-
Note that `branch` is typically one of:
|
770
|
-
- `prod`
|
771
|
-
- `user.bob`
|
772
|
-
- `test.my_experiment`
|
773
|
-
- `prod.staging`
|
774
|
-
"""
|
775
|
-
...
|
776
|
-
|
777
|
-
@typing.overload
|
778
|
-
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]]:
|
779
|
-
"""
|
780
|
-
Specifies the times when the flow should be run when running on a
|
781
|
-
production scheduler.
|
782
|
-
"""
|
783
|
-
...
|
784
|
-
|
785
|
-
@typing.overload
|
786
|
-
def schedule(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
787
|
-
...
|
788
|
-
|
789
|
-
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):
|
790
|
-
"""
|
791
|
-
Specifies the times when the flow should be run when running on a
|
792
|
-
production scheduler.
|
793
|
-
"""
|
794
|
-
...
|
795
|
-
|
796
|
-
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]]:
|
797
|
-
"""
|
798
|
-
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.
|
799
|
-
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.
|
800
|
-
"""
|
801
|
-
...
|
802
|
-
|
803
803
|
pkg_name: str
|
804
804
|
|