ob-metaflow-stubs 6.0.3.133__py2.py3-none-any.whl → 6.0.3.135__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 +243 -243
- 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 +3 -3
- metaflow-stubs/client/filecache.pyi +3 -3
- 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 +3 -3
- 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 +4 -2
- metaflow-stubs/metaflow_current.pyi +98 -98
- 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 +2 -2
- 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 +3 -3
- 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 +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 +2 -2
- 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 +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 +4 -4
- 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 +2 -2
- metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +3 -3
- metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +4 -4
- 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 +4 -4
- metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +2 -2
- 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 +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 +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 +3 -3
- 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 +3 -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 +20 -0
- 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 +2 -2
- 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 +3 -3
- 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 +3 -3
- 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 +28 -28
- metaflow-stubs/runner/deployer_impl.pyi +3 -3
- metaflow-stubs/runner/metaflow_runner.pyi +4 -4
- 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 +2 -2
- 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 +11 -11
- {ob_metaflow_stubs-6.0.3.133.dist-info → ob_metaflow_stubs-6.0.3.135.dist-info}/METADATA +1 -1
- ob_metaflow_stubs-6.0.3.135.dist-info/RECORD +192 -0
- ob_metaflow_stubs-6.0.3.133.dist-info/RECORD +0 -191
- {ob_metaflow_stubs-6.0.3.133.dist-info → ob_metaflow_stubs-6.0.3.135.dist-info}/WHEEL +0 -0
- {ob_metaflow_stubs-6.0.3.133.dist-info → ob_metaflow_stubs-6.0.3.135.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.8.1+obcheckpoint(0.1.6);ob(v1) #
|
4
|
+
# Generated on 2025-01-30T21:59:34.749405 #
|
5
5
|
######################################################################################################
|
6
6
|
|
7
7
|
from __future__ import annotations
|
8
8
|
|
9
9
|
import typing
|
10
10
|
if typing.TYPE_CHECKING:
|
11
|
-
import datetime
|
12
11
|
import typing
|
12
|
+
import datetime
|
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
|
38
39
|
from . import tuple_util as tuple_util
|
39
40
|
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
|
@@ -147,155 +147,63 @@ def step(f: typing.Union[typing.Callable[[FlowSpecDerived], None], typing.Callab
|
|
147
147
|
...
|
148
148
|
|
149
149
|
@typing.overload
|
150
|
-
def
|
150
|
+
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
151
|
"""
|
152
|
-
Specifies the
|
152
|
+
Specifies the Conda environment for the step.
|
153
153
|
|
154
154
|
Information in this decorator will augment any
|
155
|
-
attributes set in the `@
|
156
|
-
you can use `@
|
157
|
-
steps and use `@
|
155
|
+
attributes set in the `@conda_base` flow-level decorator. Hence,
|
156
|
+
you can use `@conda_base` to set packages required by all
|
157
|
+
steps and use `@conda` to specify step-specific overrides.
|
158
158
|
"""
|
159
159
|
...
|
160
160
|
|
161
161
|
@typing.overload
|
162
|
-
def
|
162
|
+
def conda(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
163
163
|
...
|
164
164
|
|
165
165
|
@typing.overload
|
166
|
-
def
|
166
|
+
def conda(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
167
167
|
...
|
168
168
|
|
169
|
-
def
|
169
|
+
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):
|
170
170
|
"""
|
171
|
-
Specifies the
|
171
|
+
Specifies the Conda environment for the step.
|
172
172
|
|
173
173
|
Information in this decorator will augment any
|
174
|
-
attributes set in the `@
|
175
|
-
you can use `@
|
176
|
-
steps and use `@
|
177
|
-
"""
|
178
|
-
...
|
179
|
-
|
180
|
-
@typing.overload
|
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]]]:
|
182
|
-
"""
|
183
|
-
Enables loading / saving of models within a step.
|
184
|
-
"""
|
185
|
-
...
|
186
|
-
|
187
|
-
@typing.overload
|
188
|
-
def model(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
189
|
-
...
|
190
|
-
|
191
|
-
@typing.overload
|
192
|
-
def model(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
193
|
-
...
|
194
|
-
|
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):
|
196
|
-
"""
|
197
|
-
Enables loading / saving of models within a step.
|
198
|
-
"""
|
199
|
-
...
|
200
|
-
|
201
|
-
@typing.overload
|
202
|
-
def parallel(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
203
|
-
"""
|
204
|
-
Decorator prototype for all step decorators. This function gets specialized
|
205
|
-
and imported for all decorators types by _import_plugin_decorators().
|
206
|
-
"""
|
207
|
-
...
|
208
|
-
|
209
|
-
@typing.overload
|
210
|
-
def parallel(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
211
|
-
...
|
212
|
-
|
213
|
-
def parallel(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None):
|
214
|
-
"""
|
215
|
-
Decorator prototype for all step decorators. This function gets specialized
|
216
|
-
and imported for all decorators types by _import_plugin_decorators().
|
174
|
+
attributes set in the `@conda_base` flow-level decorator. Hence,
|
175
|
+
you can use `@conda_base` to set packages required by all
|
176
|
+
steps and use `@conda` to specify step-specific overrides.
|
217
177
|
"""
|
218
178
|
...
|
219
179
|
|
220
|
-
|
221
|
-
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]]]:
|
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]]]:
|
222
181
|
"""
|
223
|
-
Specifies
|
224
|
-
to a step needs to be retried.
|
225
|
-
|
226
|
-
This decorator is useful for handling transient errors, such as networking issues.
|
227
|
-
If your task contains operations that can't be retried safely, e.g. database updates,
|
228
|
-
it is advisable to annotate it with `@retry(times=0)`.
|
229
|
-
|
230
|
-
This can be used in conjunction with the `@catch` decorator. The `@catch`
|
231
|
-
decorator will execute a no-op task after all retries have been exhausted,
|
232
|
-
ensuring that the flow execution can continue.
|
182
|
+
Specifies that this step should execute on DGX cloud.
|
233
183
|
"""
|
234
184
|
...
|
235
185
|
|
236
186
|
@typing.overload
|
237
|
-
def
|
238
|
-
...
|
239
|
-
|
240
|
-
@typing.overload
|
241
|
-
def retry(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
242
|
-
...
|
243
|
-
|
244
|
-
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):
|
187
|
+
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]]]:
|
245
188
|
"""
|
246
|
-
Specifies the
|
247
|
-
to a step needs to be retried.
|
248
|
-
|
249
|
-
This decorator is useful for handling transient errors, such as networking issues.
|
250
|
-
If your task contains operations that can't be retried safely, e.g. database updates,
|
251
|
-
it is advisable to annotate it with `@retry(times=0)`.
|
189
|
+
Specifies that the step will success under all circumstances.
|
252
190
|
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
...
|
258
|
-
|
259
|
-
@typing.overload
|
260
|
-
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
261
|
-
"""
|
262
|
-
Internal decorator to support Fast bakery
|
263
|
-
"""
|
264
|
-
...
|
265
|
-
|
266
|
-
@typing.overload
|
267
|
-
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
268
|
-
...
|
269
|
-
|
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
|
-
"""
|
274
|
-
...
|
275
|
-
|
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]]]:
|
278
|
-
"""
|
279
|
-
Specifies environment variables to be set prior to the execution of a step.
|
191
|
+
The decorator will create an optional artifact, specified by `var`, which
|
192
|
+
contains the exception raised. You can use it to detect the presence
|
193
|
+
of errors, indicating that all happy-path artifacts produced by the step
|
194
|
+
are missing.
|
280
195
|
"""
|
281
196
|
...
|
282
197
|
|
283
198
|
@typing.overload
|
284
|
-
def
|
199
|
+
def catch(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
285
200
|
...
|
286
201
|
|
287
202
|
@typing.overload
|
288
|
-
def
|
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] = {}):
|
292
|
-
"""
|
293
|
-
Specifies environment variables to be set prior to the execution of a step.
|
294
|
-
"""
|
203
|
+
def catch(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
295
204
|
...
|
296
205
|
|
297
|
-
|
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]]]:
|
206
|
+
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):
|
299
207
|
"""
|
300
208
|
Specifies that the step will success under all circumstances.
|
301
209
|
|
@@ -307,21 +215,23 @@ def catch(*, var: typing.Optional[str] = None, print_exception: bool = True) ->
|
|
307
215
|
...
|
308
216
|
|
309
217
|
@typing.overload
|
310
|
-
def
|
218
|
+
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
|
+
"""
|
220
|
+
Enables checkpointing for a step.
|
221
|
+
"""
|
311
222
|
...
|
312
223
|
|
313
224
|
@typing.overload
|
314
|
-
def
|
225
|
+
def checkpoint(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
315
226
|
...
|
316
227
|
|
317
|
-
|
228
|
+
@typing.overload
|
229
|
+
def checkpoint(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
230
|
+
...
|
231
|
+
|
232
|
+
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):
|
318
233
|
"""
|
319
|
-
|
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.
|
234
|
+
Enables checkpointing for a step.
|
325
235
|
"""
|
326
236
|
...
|
327
237
|
|
@@ -414,120 +324,234 @@ def timeout(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None],
|
|
414
324
|
...
|
415
325
|
|
416
326
|
@typing.overload
|
417
|
-
def
|
327
|
+
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]]]:
|
418
328
|
"""
|
419
|
-
Specifies
|
420
|
-
|
329
|
+
Specifies the number of times the task corresponding
|
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)`.
|
335
|
+
|
336
|
+
This can be used in conjunction with the `@catch` decorator. The `@catch`
|
337
|
+
decorator will execute a no-op task after all retries have been exhausted,
|
338
|
+
ensuring that the flow execution can continue.
|
421
339
|
"""
|
422
340
|
...
|
423
341
|
|
424
342
|
@typing.overload
|
425
|
-
def
|
343
|
+
def retry(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
426
344
|
...
|
427
345
|
|
428
346
|
@typing.overload
|
429
|
-
def
|
347
|
+
def retry(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
430
348
|
...
|
431
349
|
|
432
|
-
def
|
350
|
+
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):
|
433
351
|
"""
|
434
|
-
Specifies
|
435
|
-
|
352
|
+
Specifies the number of times the task corresponding
|
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)`.
|
358
|
+
|
359
|
+
This can be used in conjunction with the `@catch` decorator. The `@catch`
|
360
|
+
decorator will execute a no-op task after all retries have been exhausted,
|
361
|
+
ensuring that the flow execution can continue.
|
436
362
|
"""
|
437
363
|
...
|
438
364
|
|
439
|
-
|
365
|
+
@typing.overload
|
366
|
+
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]]]:
|
440
367
|
"""
|
441
|
-
|
368
|
+
Enables loading / saving of models within a step.
|
442
369
|
"""
|
443
370
|
...
|
444
371
|
|
445
372
|
@typing.overload
|
446
|
-
def
|
373
|
+
def model(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
374
|
+
...
|
375
|
+
|
376
|
+
@typing.overload
|
377
|
+
def model(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
378
|
+
...
|
379
|
+
|
380
|
+
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):
|
447
381
|
"""
|
448
|
-
Enables
|
382
|
+
Enables loading / saving of models within a step.
|
449
383
|
"""
|
450
384
|
...
|
451
385
|
|
452
386
|
@typing.overload
|
453
|
-
def
|
387
|
+
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
388
|
+
"""
|
389
|
+
Internal decorator to support Fast bakery
|
390
|
+
"""
|
454
391
|
...
|
455
392
|
|
456
393
|
@typing.overload
|
457
|
-
def
|
394
|
+
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
458
395
|
...
|
459
396
|
|
460
|
-
def
|
397
|
+
def fast_bakery_internal(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None):
|
461
398
|
"""
|
462
|
-
|
399
|
+
Internal decorator to support Fast bakery
|
463
400
|
"""
|
464
401
|
...
|
465
402
|
|
466
|
-
|
403
|
+
@typing.overload
|
404
|
+
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]]]:
|
467
405
|
"""
|
468
|
-
|
406
|
+
Creates a human-readable report, a Metaflow Card, after this step completes.
|
407
|
+
|
408
|
+
Note that you may add multiple `@card` decorators in a step with different parameters.
|
469
409
|
"""
|
470
410
|
...
|
471
411
|
|
472
412
|
@typing.overload
|
473
|
-
def
|
413
|
+
def card(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
414
|
+
...
|
415
|
+
|
416
|
+
@typing.overload
|
417
|
+
def card(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
418
|
+
...
|
419
|
+
|
420
|
+
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):
|
474
421
|
"""
|
475
|
-
|
422
|
+
Creates a human-readable report, a Metaflow Card, after this step completes.
|
423
|
+
|
424
|
+
Note that you may add multiple `@card` decorators in a step with different parameters.
|
425
|
+
"""
|
426
|
+
...
|
427
|
+
|
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
|
+
@typing.overload
|
435
|
+
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]]]:
|
436
|
+
"""
|
437
|
+
Specifies the PyPI packages for the step.
|
476
438
|
|
477
439
|
Information in this decorator will augment any
|
478
|
-
attributes set in the `@
|
479
|
-
you can use `@
|
480
|
-
steps and use `@
|
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.
|
481
443
|
"""
|
482
444
|
...
|
483
445
|
|
484
446
|
@typing.overload
|
485
|
-
def
|
447
|
+
def pypi(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
486
448
|
...
|
487
449
|
|
488
450
|
@typing.overload
|
489
|
-
def
|
451
|
+
def pypi(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
490
452
|
...
|
491
453
|
|
492
|
-
def
|
454
|
+
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):
|
493
455
|
"""
|
494
|
-
Specifies the
|
456
|
+
Specifies the PyPI packages for the step.
|
495
457
|
|
496
458
|
Information in this decorator will augment any
|
497
|
-
attributes set in the `@
|
498
|
-
you can use `@
|
499
|
-
steps and use `@
|
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.
|
500
468
|
"""
|
501
469
|
...
|
502
470
|
|
503
471
|
@typing.overload
|
504
|
-
def
|
472
|
+
def parallel(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
505
473
|
"""
|
506
|
-
|
507
|
-
|
508
|
-
Note that you may add multiple `@card` decorators in a step with different parameters.
|
474
|
+
Decorator prototype for all step decorators. This function gets specialized
|
475
|
+
and imported for all decorators types by _import_plugin_decorators().
|
509
476
|
"""
|
510
477
|
...
|
511
478
|
|
512
479
|
@typing.overload
|
513
|
-
def
|
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):
|
484
|
+
"""
|
485
|
+
Decorator prototype for all step decorators. This function gets specialized
|
486
|
+
and imported for all decorators types by _import_plugin_decorators().
|
487
|
+
"""
|
514
488
|
...
|
515
489
|
|
516
490
|
@typing.overload
|
517
|
-
def
|
491
|
+
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]]]:
|
492
|
+
"""
|
493
|
+
Specifies environment variables to be set prior to the execution of a step.
|
494
|
+
"""
|
518
495
|
...
|
519
496
|
|
520
|
-
|
497
|
+
@typing.overload
|
498
|
+
def environment(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
499
|
+
...
|
500
|
+
|
501
|
+
@typing.overload
|
502
|
+
def environment(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
503
|
+
...
|
504
|
+
|
505
|
+
def environment(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, vars: typing.Dict[str, str] = {}):
|
521
506
|
"""
|
522
|
-
|
523
|
-
|
524
|
-
Note that you may add multiple `@card` decorators in a step with different parameters.
|
507
|
+
Specifies environment variables to be set prior to the execution of a step.
|
525
508
|
"""
|
526
509
|
...
|
527
510
|
|
528
|
-
|
511
|
+
@typing.overload
|
512
|
+
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]]]:
|
529
513
|
"""
|
530
|
-
Specifies
|
514
|
+
Specifies secrets to be retrieved and injected as environment variables prior to
|
515
|
+
the execution of a step.
|
516
|
+
"""
|
517
|
+
...
|
518
|
+
|
519
|
+
@typing.overload
|
520
|
+
def secrets(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
521
|
+
...
|
522
|
+
|
523
|
+
@typing.overload
|
524
|
+
def secrets(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
525
|
+
...
|
526
|
+
|
527
|
+
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]]] = []):
|
528
|
+
"""
|
529
|
+
Specifies secrets to be retrieved and injected as environment variables prior to
|
530
|
+
the execution of a step.
|
531
|
+
"""
|
532
|
+
...
|
533
|
+
|
534
|
+
def nim(*, models: "list[NIM]", backend: str) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
535
|
+
"""
|
536
|
+
This decorator is used to run NIM containers in Metaflow tasks as sidecars.
|
537
|
+
|
538
|
+
User code call
|
539
|
+
-----------
|
540
|
+
@nim(
|
541
|
+
models=['meta/llama3-8b-instruct', 'meta/llama3-70b-instruct'],
|
542
|
+
backend='managed'
|
543
|
+
)
|
544
|
+
|
545
|
+
Valid backend options
|
546
|
+
---------------------
|
547
|
+
- 'managed': Outerbounds selects a compute provider based on the model.
|
548
|
+
- 🚧 'dataplane': Run in your account.
|
549
|
+
|
550
|
+
Valid model options
|
551
|
+
----------------
|
552
|
+
- 'meta/llama3-8b-instruct': 8B parameter model
|
553
|
+
- 'meta/llama3-70b-instruct': 70B parameter model
|
554
|
+
- Upon request, any model here: https://nvcf.ngc.nvidia.com/functions?filter=nvidia-functions
|
531
555
|
"""
|
532
556
|
...
|
533
557
|
|
@@ -540,6 +564,39 @@ def project(*, name: str) -> typing.Callable[[typing.Type[FlowSpecDerived]], typ
|
|
540
564
|
"""
|
541
565
|
...
|
542
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
|
+
@typing.overload
|
578
|
+
def pypi_base(*, packages: typing.Dict[str, str] = {}, python: typing.Optional[str] = None) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
579
|
+
"""
|
580
|
+
Specifies the PyPI packages for all steps of the flow.
|
581
|
+
|
582
|
+
Use `@pypi_base` to set common packages required by all
|
583
|
+
steps and use `@pypi` to specify step-specific overrides.
|
584
|
+
"""
|
585
|
+
...
|
586
|
+
|
587
|
+
@typing.overload
|
588
|
+
def pypi_base(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
589
|
+
...
|
590
|
+
|
591
|
+
def pypi_base(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, packages: typing.Dict[str, str] = {}, python: typing.Optional[str] = None):
|
592
|
+
"""
|
593
|
+
Specifies the PyPI packages for all steps of the flow.
|
594
|
+
|
595
|
+
Use `@pypi_base` to set common packages required by all
|
596
|
+
steps and use `@pypi` to specify step-specific overrides.
|
597
|
+
"""
|
598
|
+
...
|
599
|
+
|
543
600
|
@typing.overload
|
544
601
|
def trigger(*, event: typing.Union[str, typing.Dict[str, typing.Any], None] = None, events: typing.List[typing.Union[str, typing.Dict[str, typing.Any]]] = [], options: typing.Dict[str, typing.Any] = {}) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
545
602
|
"""
|
@@ -614,54 +671,25 @@ def trigger(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, event: t
|
|
614
671
|
...
|
615
672
|
|
616
673
|
@typing.overload
|
617
|
-
def
|
618
|
-
"""
|
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]]:
|
674
|
+
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]]:
|
637
675
|
"""
|
638
|
-
Specifies the
|
676
|
+
Specifies the Conda environment for all steps of the flow.
|
639
677
|
|
640
|
-
Use `@
|
641
|
-
steps and use `@
|
678
|
+
Use `@conda_base` to set common libraries required by all
|
679
|
+
steps and use `@conda` to specify step-specific additions.
|
642
680
|
"""
|
643
681
|
...
|
644
682
|
|
645
683
|
@typing.overload
|
646
|
-
def
|
684
|
+
def conda_base(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
647
685
|
...
|
648
686
|
|
649
|
-
def
|
687
|
+
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):
|
650
688
|
"""
|
651
|
-
Specifies the
|
689
|
+
Specifies the Conda environment for all steps of the flow.
|
652
690
|
|
653
|
-
Use `@
|
654
|
-
steps and use `@
|
655
|
-
"""
|
656
|
-
...
|
657
|
-
|
658
|
-
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]]:
|
659
|
-
"""
|
660
|
-
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)
|
661
|
-
before the start step of the flow. This decorator only works when a flow is scheduled on Airflow
|
662
|
-
and is compiled using `airflow create`. More than one `@airflow_s3_key_sensor` can be
|
663
|
-
added as a flow decorators. Adding more than one decorator will ensure that `start` step
|
664
|
-
starts only after all sensors finish.
|
691
|
+
Use `@conda_base` to set common libraries required by all
|
692
|
+
steps and use `@conda` to specify step-specific additions.
|
665
693
|
"""
|
666
694
|
...
|
667
695
|
|
@@ -747,25 +775,21 @@ def trigger_on_finish(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *
|
|
747
775
|
...
|
748
776
|
|
749
777
|
@typing.overload
|
750
|
-
def
|
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]]:
|
751
779
|
"""
|
752
|
-
Specifies the
|
753
|
-
|
754
|
-
Use `@conda_base` to set common libraries required by all
|
755
|
-
steps and use `@conda` to specify step-specific additions.
|
780
|
+
Specifies the times when the flow should be run when running on a
|
781
|
+
production scheduler.
|
756
782
|
"""
|
757
783
|
...
|
758
784
|
|
759
785
|
@typing.overload
|
760
|
-
def
|
786
|
+
def schedule(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
761
787
|
...
|
762
788
|
|
763
|
-
def
|
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):
|
764
790
|
"""
|
765
|
-
Specifies the
|
766
|
-
|
767
|
-
Use `@conda_base` to set common libraries required by all
|
768
|
-
steps and use `@conda` to specify step-specific additions.
|
791
|
+
Specifies the times when the flow should be run when running on a
|
792
|
+
production scheduler.
|
769
793
|
"""
|
770
794
|
...
|
771
795
|
|
@@ -776,29 +800,5 @@ def airflow_external_task_sensor(*, timeout: int, poke_interval: int, mode: str,
|
|
776
800
|
"""
|
777
801
|
...
|
778
802
|
|
779
|
-
def nim(*, models: "list[NIM]", backend: str) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
780
|
-
"""
|
781
|
-
This decorator is used to run NIM containers in Metaflow tasks as sidecars.
|
782
|
-
|
783
|
-
User code call
|
784
|
-
-----------
|
785
|
-
@nim(
|
786
|
-
models=['meta/llama3-8b-instruct', 'meta/llama3-70b-instruct'],
|
787
|
-
backend='managed'
|
788
|
-
)
|
789
|
-
|
790
|
-
Valid backend options
|
791
|
-
---------------------
|
792
|
-
- 'managed': Outerbounds selects a compute provider based on the model.
|
793
|
-
- 🚧 'dataplane': Run in your account.
|
794
|
-
|
795
|
-
Valid model options
|
796
|
-
----------------
|
797
|
-
- 'meta/llama3-8b-instruct': 8B parameter model
|
798
|
-
- 'meta/llama3-70b-instruct': 70B parameter model
|
799
|
-
- Upon request, any model here: https://nvcf.ngc.nvidia.com/functions?filter=nvidia-functions
|
800
|
-
"""
|
801
|
-
...
|
802
|
-
|
803
803
|
pkg_name: str
|
804
804
|
|