ob-metaflow-stubs 6.0.3.102rc5__py2.py3-none-any.whl → 6.0.3.102rc7__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 +444 -444
- metaflow-stubs/cards.pyi +4 -4
- metaflow-stubs/cli.pyi +2 -2
- metaflow-stubs/client/__init__.pyi +3 -3
- metaflow-stubs/client/core.pyi +5 -5
- metaflow-stubs/client/filecache.pyi +1 -1
- metaflow-stubs/clone_util.pyi +1 -1
- metaflow-stubs/events.pyi +1 -1
- metaflow-stubs/exception.pyi +1 -1
- metaflow-stubs/flowspec.pyi +4 -4
- metaflow-stubs/generated_for.txt +1 -1
- metaflow-stubs/includefile.pyi +3 -3
- metaflow-stubs/info_file.pyi +1 -1
- metaflow-stubs/metadata/metadata.pyi +2 -2
- metaflow-stubs/metadata/util.pyi +1 -1
- metaflow-stubs/metaflow_config.pyi +1 -1
- metaflow-stubs/metaflow_current.pyi +51 -51
- metaflow-stubs/mflog/mflog.pyi +1 -1
- metaflow-stubs/multicore_utils.pyi +1 -1
- metaflow-stubs/parameters.pyi +2 -2
- metaflow-stubs/plugins/__init__.pyi +2 -2
- metaflow-stubs/plugins/airflow/__init__.pyi +1 -1
- metaflow-stubs/plugins/airflow/airflow_utils.pyi +1 -1
- metaflow-stubs/plugins/airflow/exception.pyi +1 -1
- metaflow-stubs/plugins/airflow/sensors/__init__.pyi +1 -1
- metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +1 -1
- 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 +1 -1
- metaflow-stubs/plugins/argo/argo_client.pyi +1 -1
- metaflow-stubs/plugins/argo/argo_events.pyi +1 -1
- metaflow-stubs/plugins/argo/argo_workflows.pyi +3 -3
- metaflow-stubs/plugins/argo/argo_workflows_cli.pyi +5 -5
- metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +6 -6
- metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +2 -2
- metaflow-stubs/plugins/aws/__init__.pyi +1 -1
- metaflow-stubs/plugins/aws/aws_client.pyi +1 -1
- metaflow-stubs/plugins/aws/aws_utils.pyi +1 -1
- metaflow-stubs/plugins/aws/batch/__init__.pyi +1 -1
- metaflow-stubs/plugins/aws/batch/batch.pyi +1 -1
- metaflow-stubs/plugins/aws/batch/batch_client.pyi +1 -1
- metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +2 -2
- metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +1 -1
- metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/__init__.pyi +1 -1
- metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +1 -1
- metaflow-stubs/plugins/aws/step_functions/production_token.pyi +1 -1
- metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +1 -1
- metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +1 -1
- metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +1 -1
- metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +1 -1
- metaflow-stubs/plugins/azure/__init__.pyi +1 -1
- metaflow-stubs/plugins/azure/azure_credential.pyi +1 -1
- metaflow-stubs/plugins/azure/azure_exceptions.pyi +1 -1
- metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +2 -2
- metaflow-stubs/plugins/azure/azure_utils.pyi +1 -1
- metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +1 -1
- metaflow-stubs/plugins/azure/includefile_support.pyi +1 -1
- metaflow-stubs/plugins/cards/__init__.pyi +1 -1
- metaflow-stubs/plugins/cards/card_cli.pyi +3 -3
- metaflow-stubs/plugins/cards/card_client.pyi +2 -2
- metaflow-stubs/plugins/cards/card_creator.pyi +1 -1
- metaflow-stubs/plugins/cards/card_datastore.pyi +1 -1
- metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/__init__.pyi +1 -1
- metaflow-stubs/plugins/cards/card_modules/basic.pyi +1 -1
- metaflow-stubs/plugins/cards/card_modules/card.pyi +1 -1
- metaflow-stubs/plugins/cards/card_modules/components.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +1 -1
- metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +1 -1
- metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +1 -1
- metaflow-stubs/plugins/cards/card_resolver.pyi +1 -1
- metaflow-stubs/plugins/cards/component_serializer.pyi +1 -1
- metaflow-stubs/plugins/cards/exception.pyi +1 -1
- metaflow-stubs/plugins/catch_decorator.pyi +2 -2
- metaflow-stubs/plugins/datatools/__init__.pyi +2 -2
- metaflow-stubs/plugins/datatools/local.pyi +1 -1
- metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
- metaflow-stubs/plugins/datatools/s3/s3.pyi +5 -5
- metaflow-stubs/plugins/datatools/s3/s3tail.pyi +1 -1
- metaflow-stubs/plugins/datatools/s3/s3util.pyi +1 -1
- metaflow-stubs/plugins/debug_logger.pyi +1 -1
- metaflow-stubs/plugins/debug_monitor.pyi +1 -1
- metaflow-stubs/plugins/environment_decorator.pyi +1 -1
- metaflow-stubs/plugins/events_decorator.pyi +2 -2
- metaflow-stubs/plugins/frameworks/__init__.pyi +1 -1
- metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
- metaflow-stubs/plugins/gcp/__init__.pyi +1 -1
- metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +2 -2
- metaflow-stubs/plugins/gcp/gs_exceptions.pyi +1 -1
- metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +1 -1
- metaflow-stubs/plugins/gcp/gs_utils.pyi +1 -1
- metaflow-stubs/plugins/gcp/includefile_support.pyi +1 -1
- metaflow-stubs/plugins/kubernetes/__init__.pyi +1 -1
- metaflow-stubs/plugins/kubernetes/kube_utils.pyi +1 -1
- metaflow-stubs/plugins/kubernetes/kubernetes.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kubernetes_cli.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +1 -1
- metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +1 -1
- metaflow-stubs/plugins/logs_cli.pyi +1 -1
- metaflow-stubs/plugins/package_cli.pyi +1 -1
- metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
- metaflow-stubs/plugins/perimeters.pyi +1 -1
- metaflow-stubs/plugins/project_decorator.pyi +2 -2
- metaflow-stubs/plugins/pypi/__init__.pyi +1 -1
- metaflow-stubs/plugins/pypi/conda_decorator.pyi +1 -1
- metaflow-stubs/plugins/pypi/conda_environment.pyi +2 -2
- metaflow-stubs/plugins/pypi/pypi_decorator.pyi +1 -1
- metaflow-stubs/plugins/pypi/pypi_environment.pyi +1 -1
- metaflow-stubs/plugins/pypi/utils.pyi +1 -1
- metaflow-stubs/plugins/resources_decorator.pyi +1 -1
- metaflow-stubs/plugins/retry_decorator.pyi +1 -1
- metaflow-stubs/plugins/secrets/__init__.pyi +1 -1
- metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +2 -2
- metaflow-stubs/plugins/secrets/secrets_decorator.pyi +1 -1
- metaflow-stubs/plugins/storage_executor.pyi +1 -1
- metaflow-stubs/plugins/tag_cli.pyi +4 -4
- metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +1 -1
- metaflow-stubs/plugins/timeout_decorator.pyi +1 -1
- metaflow-stubs/procpoll.pyi +1 -1
- metaflow-stubs/profilers/__init__.pyi +1 -1
- metaflow-stubs/pylint_wrapper.pyi +1 -1
- metaflow-stubs/runner/__init__.pyi +1 -1
- metaflow-stubs/runner/deployer.pyi +3 -3
- metaflow-stubs/runner/metaflow_runner.pyi +2 -2
- metaflow-stubs/runner/nbdeploy.pyi +1 -1
- metaflow-stubs/runner/nbrun.pyi +1 -1
- metaflow-stubs/runner/subprocess_manager.pyi +1 -1
- metaflow-stubs/runner/utils.pyi +1 -1
- metaflow-stubs/system/__init__.pyi +2 -2
- metaflow-stubs/system/system_logger.pyi +1 -1
- metaflow-stubs/system/system_monitor.pyi +2 -2
- metaflow-stubs/tagging_util.pyi +1 -1
- metaflow-stubs/tuple_util.pyi +1 -1
- {ob_metaflow_stubs-6.0.3.102rc5.dist-info → ob_metaflow_stubs-6.0.3.102rc7.dist-info}/METADATA +1 -1
- ob_metaflow_stubs-6.0.3.102rc7.dist-info/RECORD +140 -0
- ob_metaflow_stubs-6.0.3.102rc5.dist-info/RECORD +0 -140
- {ob_metaflow_stubs-6.0.3.102rc5.dist-info → ob_metaflow_stubs-6.0.3.102rc7.dist-info}/WHEEL +0 -0
- {ob_metaflow_stubs-6.0.3.102rc5.dist-info → ob_metaflow_stubs-6.0.3.102rc7.dist-info}/top_level.txt +0 -0
metaflow-stubs/__init__.pyi
CHANGED
@@ -1,24 +1,24 @@
|
|
1
1
|
##################################################################################
|
2
2
|
# Auto-generated Metaflow stub file #
|
3
3
|
# MF version: 2.12.22.1+obcheckpoint(0.0.10);ob(v1) #
|
4
|
-
# Generated on 2024-09-20T19:
|
4
|
+
# Generated on 2024-09-20T19:26:01.310999 #
|
5
5
|
##################################################################################
|
6
6
|
|
7
7
|
from __future__ import annotations
|
8
8
|
|
9
9
|
import typing
|
10
10
|
if typing.TYPE_CHECKING:
|
11
|
-
import
|
12
|
-
import metaflow.
|
11
|
+
import typing
|
12
|
+
import metaflow.flowspec
|
13
13
|
import metaflow._vendor.click.types
|
14
|
+
import metaflow.parameters
|
15
|
+
import datetime
|
16
|
+
import metaflow.events
|
14
17
|
import metaflow.runner.metaflow_runner
|
15
18
|
import metaflow.client.core
|
16
19
|
import metaflow_extensions.obcheckpoint.plugins.machine_learning_utilities.datastructures
|
20
|
+
import metaflow.metaflow_current
|
17
21
|
import metaflow.datastore.inputs
|
18
|
-
import metaflow.events
|
19
|
-
import datetime
|
20
|
-
import metaflow.flowspec
|
21
|
-
import typing
|
22
22
|
FlowSpecDerived = typing.TypeVar("FlowSpecDerived", bound="FlowSpec", contravariant=False, covariant=False)
|
23
23
|
StepFlag = typing.NewType("StepFlag", bool)
|
24
24
|
|
@@ -468,59 +468,160 @@ def secrets(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None],
|
|
468
468
|
...
|
469
469
|
|
470
470
|
@typing.overload
|
471
|
-
def
|
471
|
+
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]]]:
|
472
472
|
"""
|
473
|
-
|
473
|
+
Creates a human-readable report, a Metaflow Card, after this step completes.
|
474
474
|
|
475
|
-
|
476
|
-
attributes set in the `@conda_base` flow-level decorator. Hence,
|
477
|
-
you can use `@conda_base` to set packages required by all
|
478
|
-
steps and use `@conda` to specify step-specific overrides.
|
475
|
+
Note that you may add multiple `@card` decorators in a step with different parameters.
|
479
476
|
|
480
477
|
Parameters
|
481
478
|
----------
|
482
|
-
|
483
|
-
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
|
479
|
+
type : str, default 'default'
|
480
|
+
Card type.
|
481
|
+
id : str, optional, default None
|
482
|
+
If multiple cards are present, use this id to identify this card.
|
483
|
+
options : Dict[str, Any], default {}
|
484
|
+
Options passed to the card. The contents depend on the card type.
|
485
|
+
timeout : int, default 45
|
486
|
+
Interrupt reporting if it takes more than this many seconds.
|
487
|
+
|
488
|
+
|
492
489
|
"""
|
493
490
|
...
|
494
491
|
|
495
492
|
@typing.overload
|
496
|
-
def
|
493
|
+
def card(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
497
494
|
...
|
498
495
|
|
499
496
|
@typing.overload
|
500
|
-
def
|
497
|
+
def card(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
501
498
|
...
|
502
499
|
|
503
|
-
def
|
500
|
+
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):
|
504
501
|
"""
|
505
|
-
|
502
|
+
Creates a human-readable report, a Metaflow Card, after this step completes.
|
506
503
|
|
507
|
-
|
508
|
-
attributes set in the `@conda_base` flow-level decorator. Hence,
|
509
|
-
you can use `@conda_base` to set packages required by all
|
510
|
-
steps and use `@conda` to specify step-specific overrides.
|
504
|
+
Note that you may add multiple `@card` decorators in a step with different parameters.
|
511
505
|
|
512
506
|
Parameters
|
513
507
|
----------
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
|
519
|
-
|
520
|
-
|
521
|
-
|
522
|
-
|
523
|
-
|
508
|
+
type : str, default 'default'
|
509
|
+
Card type.
|
510
|
+
id : str, optional, default None
|
511
|
+
If multiple cards are present, use this id to identify this card.
|
512
|
+
options : Dict[str, Any], default {}
|
513
|
+
Options passed to the card. The contents depend on the card type.
|
514
|
+
timeout : int, default 45
|
515
|
+
Interrupt reporting if it takes more than this many seconds.
|
516
|
+
|
517
|
+
|
518
|
+
"""
|
519
|
+
...
|
520
|
+
|
521
|
+
@typing.overload
|
522
|
+
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]]]:
|
523
|
+
"""
|
524
|
+
Specifies environment variables to be set prior to the execution of a step.
|
525
|
+
|
526
|
+
Parameters
|
527
|
+
----------
|
528
|
+
vars : Dict[str, str], default {}
|
529
|
+
Dictionary of environment variables to set.
|
530
|
+
"""
|
531
|
+
...
|
532
|
+
|
533
|
+
@typing.overload
|
534
|
+
def environment(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
535
|
+
...
|
536
|
+
|
537
|
+
@typing.overload
|
538
|
+
def environment(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
539
|
+
...
|
540
|
+
|
541
|
+
def environment(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, vars: typing.Dict[str, str] = {}):
|
542
|
+
"""
|
543
|
+
Specifies environment variables to be set prior to the execution of a step.
|
544
|
+
|
545
|
+
Parameters
|
546
|
+
----------
|
547
|
+
vars : Dict[str, str], default {}
|
548
|
+
Dictionary of environment variables to set.
|
549
|
+
"""
|
550
|
+
...
|
551
|
+
|
552
|
+
@typing.overload
|
553
|
+
def parallel(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
554
|
+
"""
|
555
|
+
Decorator prototype for all step decorators. This function gets specialized
|
556
|
+
and imported for all decorators types by _import_plugin_decorators().
|
557
|
+
"""
|
558
|
+
...
|
559
|
+
|
560
|
+
@typing.overload
|
561
|
+
def parallel(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
562
|
+
...
|
563
|
+
|
564
|
+
def parallel(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None):
|
565
|
+
"""
|
566
|
+
Decorator prototype for all step decorators. This function gets specialized
|
567
|
+
and imported for all decorators types by _import_plugin_decorators().
|
568
|
+
"""
|
569
|
+
...
|
570
|
+
|
571
|
+
@typing.overload
|
572
|
+
def timeout(*, seconds: int = 0, minutes: int = 0, hours: int = 0) -> typing.Callable[[typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]], typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]]]:
|
573
|
+
"""
|
574
|
+
Specifies a timeout for your step.
|
575
|
+
|
576
|
+
This decorator is useful if this step may hang indefinitely.
|
577
|
+
|
578
|
+
This can be used in conjunction with the `@retry` decorator as well as the `@catch` decorator.
|
579
|
+
A timeout is considered to be an exception thrown by the step. It will cause the step to be
|
580
|
+
retried if needed and the exception will be caught by the `@catch` decorator, if present.
|
581
|
+
|
582
|
+
Note that all the values specified in parameters are added together so if you specify
|
583
|
+
60 seconds and 1 hour, the decorator will have an effective timeout of 1 hour and 1 minute.
|
584
|
+
|
585
|
+
Parameters
|
586
|
+
----------
|
587
|
+
seconds : int, default 0
|
588
|
+
Number of seconds to wait prior to timing out.
|
589
|
+
minutes : int, default 0
|
590
|
+
Number of minutes to wait prior to timing out.
|
591
|
+
hours : int, default 0
|
592
|
+
Number of hours to wait prior to timing out.
|
593
|
+
"""
|
594
|
+
...
|
595
|
+
|
596
|
+
@typing.overload
|
597
|
+
def timeout(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
598
|
+
...
|
599
|
+
|
600
|
+
@typing.overload
|
601
|
+
def timeout(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
602
|
+
...
|
603
|
+
|
604
|
+
def timeout(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None, *, seconds: int = 0, minutes: int = 0, hours: int = 0):
|
605
|
+
"""
|
606
|
+
Specifies a timeout for your step.
|
607
|
+
|
608
|
+
This decorator is useful if this step may hang indefinitely.
|
609
|
+
|
610
|
+
This can be used in conjunction with the `@retry` decorator as well as the `@catch` decorator.
|
611
|
+
A timeout is considered to be an exception thrown by the step. It will cause the step to be
|
612
|
+
retried if needed and the exception will be caught by the `@catch` decorator, if present.
|
613
|
+
|
614
|
+
Note that all the values specified in parameters are added together so if you specify
|
615
|
+
60 seconds and 1 hour, the decorator will have an effective timeout of 1 hour and 1 minute.
|
616
|
+
|
617
|
+
Parameters
|
618
|
+
----------
|
619
|
+
seconds : int, default 0
|
620
|
+
Number of seconds to wait prior to timing out.
|
621
|
+
minutes : int, default 0
|
622
|
+
Number of minutes to wait prior to timing out.
|
623
|
+
hours : int, default 0
|
624
|
+
Number of hours to wait prior to timing out.
|
524
625
|
"""
|
525
626
|
...
|
526
627
|
|
@@ -590,55 +691,6 @@ def kubernetes(*, cpu: int = 1, memory: int = 4096, disk: int = 10240, image: ty
|
|
590
691
|
"""
|
591
692
|
...
|
592
693
|
|
593
|
-
@typing.overload
|
594
|
-
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]]]:
|
595
|
-
"""
|
596
|
-
Specifies that the step will success under all circumstances.
|
597
|
-
|
598
|
-
The decorator will create an optional artifact, specified by `var`, which
|
599
|
-
contains the exception raised. You can use it to detect the presence
|
600
|
-
of errors, indicating that all happy-path artifacts produced by the step
|
601
|
-
are missing.
|
602
|
-
|
603
|
-
Parameters
|
604
|
-
----------
|
605
|
-
var : str, optional, default None
|
606
|
-
Name of the artifact in which to store the caught exception.
|
607
|
-
If not specified, the exception is not stored.
|
608
|
-
print_exception : bool, default True
|
609
|
-
Determines whether or not the exception is printed to
|
610
|
-
stdout when caught.
|
611
|
-
"""
|
612
|
-
...
|
613
|
-
|
614
|
-
@typing.overload
|
615
|
-
def catch(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
616
|
-
...
|
617
|
-
|
618
|
-
@typing.overload
|
619
|
-
def catch(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
620
|
-
...
|
621
|
-
|
622
|
-
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):
|
623
|
-
"""
|
624
|
-
Specifies that the step will success under all circumstances.
|
625
|
-
|
626
|
-
The decorator will create an optional artifact, specified by `var`, which
|
627
|
-
contains the exception raised. You can use it to detect the presence
|
628
|
-
of errors, indicating that all happy-path artifacts produced by the step
|
629
|
-
are missing.
|
630
|
-
|
631
|
-
Parameters
|
632
|
-
----------
|
633
|
-
var : str, optional, default None
|
634
|
-
Name of the artifact in which to store the caught exception.
|
635
|
-
If not specified, the exception is not stored.
|
636
|
-
print_exception : bool, default True
|
637
|
-
Determines whether or not the exception is printed to
|
638
|
-
stdout when caught.
|
639
|
-
"""
|
640
|
-
...
|
641
|
-
|
642
694
|
@typing.overload
|
643
695
|
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]]]:
|
644
696
|
"""
|
@@ -701,199 +753,271 @@ def model(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], ty
|
|
701
753
|
...
|
702
754
|
|
703
755
|
@typing.overload
|
704
|
-
def
|
756
|
+
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]]]:
|
705
757
|
"""
|
706
|
-
Specifies the
|
758
|
+
Specifies the number of times the task corresponding
|
759
|
+
to a step needs to be retried.
|
707
760
|
|
708
|
-
|
709
|
-
|
710
|
-
|
711
|
-
|
761
|
+
This decorator is useful for handling transient errors, such as networking issues.
|
762
|
+
If your task contains operations that can't be retried safely, e.g. database updates,
|
763
|
+
it is advisable to annotate it with `@retry(times=0)`.
|
764
|
+
|
765
|
+
This can be used in conjunction with the `@catch` decorator. The `@catch`
|
766
|
+
decorator will execute a no-op task after all retries have been exhausted,
|
767
|
+
ensuring that the flow execution can continue.
|
712
768
|
|
713
769
|
Parameters
|
714
770
|
----------
|
715
|
-
|
716
|
-
|
717
|
-
|
718
|
-
|
719
|
-
Version of Python to use, e.g. '3.7.4'. A default value of None implies
|
720
|
-
that the version used will correspond to the version of the Python interpreter used to start the run.
|
771
|
+
times : int, default 3
|
772
|
+
Number of times to retry this task.
|
773
|
+
minutes_between_retries : int, default 2
|
774
|
+
Number of minutes between retries.
|
721
775
|
"""
|
722
776
|
...
|
723
777
|
|
724
778
|
@typing.overload
|
725
|
-
def
|
779
|
+
def retry(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
726
780
|
...
|
727
781
|
|
728
782
|
@typing.overload
|
729
|
-
def
|
783
|
+
def retry(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
730
784
|
...
|
731
785
|
|
732
|
-
def
|
786
|
+
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):
|
733
787
|
"""
|
734
|
-
Specifies the
|
788
|
+
Specifies the number of times the task corresponding
|
789
|
+
to a step needs to be retried.
|
735
790
|
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
791
|
+
This decorator is useful for handling transient errors, such as networking issues.
|
792
|
+
If your task contains operations that can't be retried safely, e.g. database updates,
|
793
|
+
it is advisable to annotate it with `@retry(times=0)`.
|
794
|
+
|
795
|
+
This can be used in conjunction with the `@catch` decorator. The `@catch`
|
796
|
+
decorator will execute a no-op task after all retries have been exhausted,
|
797
|
+
ensuring that the flow execution can continue.
|
740
798
|
|
741
799
|
Parameters
|
742
800
|
----------
|
743
|
-
|
744
|
-
|
745
|
-
|
746
|
-
|
747
|
-
Version of Python to use, e.g. '3.7.4'. A default value of None implies
|
748
|
-
that the version used will correspond to the version of the Python interpreter used to start the run.
|
801
|
+
times : int, default 3
|
802
|
+
Number of times to retry this task.
|
803
|
+
minutes_between_retries : int, default 2
|
804
|
+
Number of minutes between retries.
|
749
805
|
"""
|
750
806
|
...
|
751
807
|
|
752
808
|
@typing.overload
|
753
|
-
def
|
809
|
+
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]]]:
|
754
810
|
"""
|
755
|
-
|
811
|
+
Enables checkpointing for a step.
|
756
812
|
|
757
|
-
Note that you may add multiple `@card` decorators in a step with different parameters.
|
758
813
|
|
759
814
|
Parameters
|
760
815
|
----------
|
761
|
-
|
762
|
-
|
763
|
-
|
764
|
-
|
765
|
-
|
766
|
-
|
767
|
-
|
768
|
-
|
816
|
+
load_policy : str, default: "fresh"
|
817
|
+
The policy for loading the checkpoint. The following policies are supported:
|
818
|
+
- "eager": Loads the the latest available checkpoint within the namespace.
|
819
|
+
With this mode, the latest checkpoint written by any previous task (can be even a different run) of the step
|
820
|
+
will be loaded at the start of the task.
|
821
|
+
- "none": Do not load any checkpoint
|
822
|
+
- "fresh": Loads the lastest checkpoint created within the running Task.
|
823
|
+
This mode helps loading checkpoints across various retry attempts of the same task.
|
824
|
+
With this mode, no checkpoint will be loaded at the start of a task but any checkpoints
|
825
|
+
created within the task will be loaded when the task is retries execution on failure.
|
826
|
+
|
827
|
+
temp_dir_root : str, default: None
|
828
|
+
The root directory under which `current.checkpoint.directory` will be created.
|
829
|
+
|
769
830
|
|
770
831
|
|
771
832
|
"""
|
772
833
|
...
|
773
834
|
|
774
835
|
@typing.overload
|
775
|
-
def
|
836
|
+
def checkpoint(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
776
837
|
...
|
777
838
|
|
778
839
|
@typing.overload
|
779
|
-
def
|
840
|
+
def checkpoint(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
780
841
|
...
|
781
842
|
|
782
|
-
def
|
843
|
+
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):
|
783
844
|
"""
|
784
|
-
|
845
|
+
Enables checkpointing for a step.
|
785
846
|
|
786
|
-
Note that you may add multiple `@card` decorators in a step with different parameters.
|
787
847
|
|
788
848
|
Parameters
|
789
849
|
----------
|
790
|
-
|
791
|
-
|
792
|
-
|
793
|
-
|
794
|
-
|
795
|
-
|
796
|
-
|
797
|
-
|
850
|
+
load_policy : str, default: "fresh"
|
851
|
+
The policy for loading the checkpoint. The following policies are supported:
|
852
|
+
- "eager": Loads the the latest available checkpoint within the namespace.
|
853
|
+
With this mode, the latest checkpoint written by any previous task (can be even a different run) of the step
|
854
|
+
will be loaded at the start of the task.
|
855
|
+
- "none": Do not load any checkpoint
|
856
|
+
- "fresh": Loads the lastest checkpoint created within the running Task.
|
857
|
+
This mode helps loading checkpoints across various retry attempts of the same task.
|
858
|
+
With this mode, no checkpoint will be loaded at the start of a task but any checkpoints
|
859
|
+
created within the task will be loaded when the task is retries execution on failure.
|
860
|
+
|
861
|
+
temp_dir_root : str, default: None
|
862
|
+
The root directory under which `current.checkpoint.directory` will be created.
|
863
|
+
|
798
864
|
|
799
865
|
|
800
866
|
"""
|
801
867
|
...
|
802
868
|
|
803
869
|
@typing.overload
|
804
|
-
def
|
870
|
+
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]]]:
|
805
871
|
"""
|
806
|
-
|
872
|
+
Specifies the Conda environment for the step.
|
873
|
+
|
874
|
+
Information in this decorator will augment any
|
875
|
+
attributes set in the `@conda_base` flow-level decorator. Hence,
|
876
|
+
you can use `@conda_base` to set packages required by all
|
877
|
+
steps and use `@conda` to specify step-specific overrides.
|
878
|
+
|
879
|
+
Parameters
|
880
|
+
----------
|
881
|
+
packages : Dict[str, str], default {}
|
882
|
+
Packages to use for this step. The key is the name of the package
|
883
|
+
and the value is the version to use.
|
884
|
+
libraries : Dict[str, str], default {}
|
885
|
+
Supported for backward compatibility. When used with packages, packages will take precedence.
|
886
|
+
python : str, optional, default None
|
887
|
+
Version of Python to use, e.g. '3.7.4'. A default value of None implies
|
888
|
+
that the version used will correspond to the version of the Python interpreter used to start the run.
|
889
|
+
disabled : bool, default False
|
890
|
+
If set to True, disables @conda.
|
807
891
|
"""
|
808
892
|
...
|
809
893
|
|
810
894
|
@typing.overload
|
811
|
-
def
|
895
|
+
def conda(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
812
896
|
...
|
813
897
|
|
814
|
-
|
898
|
+
@typing.overload
|
899
|
+
def conda(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
900
|
+
...
|
901
|
+
|
902
|
+
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):
|
815
903
|
"""
|
816
|
-
|
904
|
+
Specifies the Conda environment for the step.
|
905
|
+
|
906
|
+
Information in this decorator will augment any
|
907
|
+
attributes set in the `@conda_base` flow-level decorator. Hence,
|
908
|
+
you can use `@conda_base` to set packages required by all
|
909
|
+
steps and use `@conda` to specify step-specific overrides.
|
910
|
+
|
911
|
+
Parameters
|
912
|
+
----------
|
913
|
+
packages : Dict[str, str], default {}
|
914
|
+
Packages to use for this step. The key is the name of the package
|
915
|
+
and the value is the version to use.
|
916
|
+
libraries : Dict[str, str], default {}
|
917
|
+
Supported for backward compatibility. When used with packages, packages will take precedence.
|
918
|
+
python : str, optional, default None
|
919
|
+
Version of Python to use, e.g. '3.7.4'. A default value of None implies
|
920
|
+
that the version used will correspond to the version of the Python interpreter used to start the run.
|
921
|
+
disabled : bool, default False
|
922
|
+
If set to True, disables @conda.
|
817
923
|
"""
|
818
924
|
...
|
819
925
|
|
820
926
|
@typing.overload
|
821
|
-
def
|
927
|
+
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]]]:
|
822
928
|
"""
|
823
|
-
|
824
|
-
|
929
|
+
Specifies the PyPI packages for the step.
|
930
|
+
|
931
|
+
Information in this decorator will augment any
|
932
|
+
attributes set in the `@pyi_base` flow-level decorator. Hence,
|
933
|
+
you can use `@pypi_base` to set packages required by all
|
934
|
+
steps and use `@pypi` to specify step-specific overrides.
|
935
|
+
|
936
|
+
Parameters
|
937
|
+
----------
|
938
|
+
packages : Dict[str, str], default: {}
|
939
|
+
Packages to use for this step. The key is the name of the package
|
940
|
+
and the value is the version to use.
|
941
|
+
python : str, optional, default: None
|
942
|
+
Version of Python to use, e.g. '3.7.4'. A default value of None implies
|
943
|
+
that the version used will correspond to the version of the Python interpreter used to start the run.
|
825
944
|
"""
|
826
945
|
...
|
827
946
|
|
828
947
|
@typing.overload
|
829
|
-
def
|
948
|
+
def pypi(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
830
949
|
...
|
831
950
|
|
832
|
-
|
951
|
+
@typing.overload
|
952
|
+
def pypi(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
953
|
+
...
|
954
|
+
|
955
|
+
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):
|
833
956
|
"""
|
834
|
-
|
835
|
-
|
957
|
+
Specifies the PyPI packages for the step.
|
958
|
+
|
959
|
+
Information in this decorator will augment any
|
960
|
+
attributes set in the `@pyi_base` flow-level decorator. Hence,
|
961
|
+
you can use `@pypi_base` to set packages required by all
|
962
|
+
steps and use `@pypi` to specify step-specific overrides.
|
963
|
+
|
964
|
+
Parameters
|
965
|
+
----------
|
966
|
+
packages : Dict[str, str], default: {}
|
967
|
+
Packages to use for this step. The key is the name of the package
|
968
|
+
and the value is the version to use.
|
969
|
+
python : str, optional, default: None
|
970
|
+
Version of Python to use, e.g. '3.7.4'. A default value of None implies
|
971
|
+
that the version used will correspond to the version of the Python interpreter used to start the run.
|
836
972
|
"""
|
837
973
|
...
|
838
974
|
|
839
975
|
@typing.overload
|
840
|
-
def
|
976
|
+
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]]]:
|
841
977
|
"""
|
842
|
-
|
978
|
+
Specifies that the step will success under all circumstances.
|
843
979
|
|
980
|
+
The decorator will create an optional artifact, specified by `var`, which
|
981
|
+
contains the exception raised. You can use it to detect the presence
|
982
|
+
of errors, indicating that all happy-path artifacts produced by the step
|
983
|
+
are missing.
|
844
984
|
|
845
985
|
Parameters
|
846
986
|
----------
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
852
|
-
|
853
|
-
- "fresh": Loads the lastest checkpoint created within the running Task.
|
854
|
-
This mode helps loading checkpoints across various retry attempts of the same task.
|
855
|
-
With this mode, no checkpoint will be loaded at the start of a task but any checkpoints
|
856
|
-
created within the task will be loaded when the task is retries execution on failure.
|
857
|
-
|
858
|
-
temp_dir_root : str, default: None
|
859
|
-
The root directory under which `current.checkpoint.directory` will be created.
|
860
|
-
|
861
|
-
|
862
|
-
|
987
|
+
var : str, optional, default None
|
988
|
+
Name of the artifact in which to store the caught exception.
|
989
|
+
If not specified, the exception is not stored.
|
990
|
+
print_exception : bool, default True
|
991
|
+
Determines whether or not the exception is printed to
|
992
|
+
stdout when caught.
|
863
993
|
"""
|
864
994
|
...
|
865
995
|
|
866
996
|
@typing.overload
|
867
|
-
def
|
997
|
+
def catch(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
868
998
|
...
|
869
999
|
|
870
1000
|
@typing.overload
|
871
|
-
def
|
1001
|
+
def catch(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
872
1002
|
...
|
873
1003
|
|
874
|
-
def
|
1004
|
+
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):
|
875
1005
|
"""
|
876
|
-
|
1006
|
+
Specifies that the step will success under all circumstances.
|
877
1007
|
|
1008
|
+
The decorator will create an optional artifact, specified by `var`, which
|
1009
|
+
contains the exception raised. You can use it to detect the presence
|
1010
|
+
of errors, indicating that all happy-path artifacts produced by the step
|
1011
|
+
are missing.
|
878
1012
|
|
879
1013
|
Parameters
|
880
1014
|
----------
|
881
|
-
|
882
|
-
|
883
|
-
|
884
|
-
|
885
|
-
|
886
|
-
|
887
|
-
- "fresh": Loads the lastest checkpoint created within the running Task.
|
888
|
-
This mode helps loading checkpoints across various retry attempts of the same task.
|
889
|
-
With this mode, no checkpoint will be loaded at the start of a task but any checkpoints
|
890
|
-
created within the task will be loaded when the task is retries execution on failure.
|
891
|
-
|
892
|
-
temp_dir_root : str, default: None
|
893
|
-
The root directory under which `current.checkpoint.directory` will be created.
|
894
|
-
|
895
|
-
|
896
|
-
|
1015
|
+
var : str, optional, default None
|
1016
|
+
Name of the artifact in which to store the caught exception.
|
1017
|
+
If not specified, the exception is not stored.
|
1018
|
+
print_exception : bool, default True
|
1019
|
+
Determines whether or not the exception is printed to
|
1020
|
+
stdout when caught.
|
897
1021
|
"""
|
898
1022
|
...
|
899
1023
|
|
@@ -975,143 +1099,117 @@ def resources(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None]
|
|
975
1099
|
...
|
976
1100
|
|
977
1101
|
@typing.overload
|
978
|
-
def
|
1102
|
+
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
|
979
1103
|
"""
|
980
|
-
|
981
|
-
|
982
|
-
Parameters
|
983
|
-
----------
|
984
|
-
vars : Dict[str, str], default {}
|
985
|
-
Dictionary of environment variables to set.
|
1104
|
+
Internal decorator to support Fast bakery
|
986
1105
|
"""
|
987
1106
|
...
|
988
1107
|
|
989
1108
|
@typing.overload
|
990
|
-
def
|
991
|
-
...
|
992
|
-
|
993
|
-
@typing.overload
|
994
|
-
def environment(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
1109
|
+
def fast_bakery_internal(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
995
1110
|
...
|
996
1111
|
|
997
|
-
def
|
1112
|
+
def fast_bakery_internal(f: typing.Union[typing.Callable[[FlowSpecDerived, StepFlag], None], typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None], None] = None):
|
998
1113
|
"""
|
999
|
-
|
1000
|
-
|
1001
|
-
Parameters
|
1002
|
-
----------
|
1003
|
-
vars : Dict[str, str], default {}
|
1004
|
-
Dictionary of environment variables to set.
|
1114
|
+
Internal decorator to support Fast bakery
|
1005
1115
|
"""
|
1006
1116
|
...
|
1007
1117
|
|
1008
1118
|
@typing.overload
|
1009
|
-
def
|
1119
|
+
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]]:
|
1010
1120
|
"""
|
1011
|
-
Specifies
|
1012
|
-
|
1013
|
-
This decorator is useful if this step may hang indefinitely.
|
1014
|
-
|
1015
|
-
This can be used in conjunction with the `@retry` decorator as well as the `@catch` decorator.
|
1016
|
-
A timeout is considered to be an exception thrown by the step. It will cause the step to be
|
1017
|
-
retried if needed and the exception will be caught by the `@catch` decorator, if present.
|
1018
|
-
|
1019
|
-
Note that all the values specified in parameters are added together so if you specify
|
1020
|
-
60 seconds and 1 hour, the decorator will have an effective timeout of 1 hour and 1 minute.
|
1121
|
+
Specifies the times when the flow should be run when running on a
|
1122
|
+
production scheduler.
|
1021
1123
|
|
1022
1124
|
Parameters
|
1023
1125
|
----------
|
1024
|
-
|
1025
|
-
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1126
|
+
hourly : bool, default False
|
1127
|
+
Run the workflow hourly.
|
1128
|
+
daily : bool, default True
|
1129
|
+
Run the workflow daily.
|
1130
|
+
weekly : bool, default False
|
1131
|
+
Run the workflow weekly.
|
1132
|
+
cron : str, optional, default None
|
1133
|
+
Run the workflow at [a custom Cron schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions)
|
1134
|
+
specified by this expression.
|
1135
|
+
timezone : str, optional, default None
|
1136
|
+
Timezone on which the schedule runs (default: None). Currently supported only for Argo workflows,
|
1137
|
+
which accepts timezones in [IANA format](https://nodatime.org/TimeZones).
|
1030
1138
|
"""
|
1031
1139
|
...
|
1032
1140
|
|
1033
1141
|
@typing.overload
|
1034
|
-
def
|
1035
|
-
...
|
1036
|
-
|
1037
|
-
@typing.overload
|
1038
|
-
def timeout(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
1142
|
+
def schedule(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
1039
1143
|
...
|
1040
1144
|
|
1041
|
-
def
|
1145
|
+
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):
|
1042
1146
|
"""
|
1043
|
-
Specifies
|
1044
|
-
|
1045
|
-
This decorator is useful if this step may hang indefinitely.
|
1046
|
-
|
1047
|
-
This can be used in conjunction with the `@retry` decorator as well as the `@catch` decorator.
|
1048
|
-
A timeout is considered to be an exception thrown by the step. It will cause the step to be
|
1049
|
-
retried if needed and the exception will be caught by the `@catch` decorator, if present.
|
1050
|
-
|
1051
|
-
Note that all the values specified in parameters are added together so if you specify
|
1052
|
-
60 seconds and 1 hour, the decorator will have an effective timeout of 1 hour and 1 minute.
|
1147
|
+
Specifies the times when the flow should be run when running on a
|
1148
|
+
production scheduler.
|
1053
1149
|
|
1054
1150
|
Parameters
|
1055
1151
|
----------
|
1056
|
-
|
1057
|
-
|
1058
|
-
|
1059
|
-
|
1060
|
-
|
1061
|
-
|
1152
|
+
hourly : bool, default False
|
1153
|
+
Run the workflow hourly.
|
1154
|
+
daily : bool, default True
|
1155
|
+
Run the workflow daily.
|
1156
|
+
weekly : bool, default False
|
1157
|
+
Run the workflow weekly.
|
1158
|
+
cron : str, optional, default None
|
1159
|
+
Run the workflow at [a custom Cron schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions)
|
1160
|
+
specified by this expression.
|
1161
|
+
timezone : str, optional, default None
|
1162
|
+
Timezone on which the schedule runs (default: None). Currently supported only for Argo workflows,
|
1163
|
+
which accepts timezones in [IANA format](https://nodatime.org/TimeZones).
|
1062
1164
|
"""
|
1063
1165
|
...
|
1064
1166
|
|
1065
1167
|
@typing.overload
|
1066
|
-
def
|
1168
|
+
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]]:
|
1067
1169
|
"""
|
1068
|
-
Specifies the
|
1069
|
-
to a step needs to be retried.
|
1070
|
-
|
1071
|
-
This decorator is useful for handling transient errors, such as networking issues.
|
1072
|
-
If your task contains operations that can't be retried safely, e.g. database updates,
|
1073
|
-
it is advisable to annotate it with `@retry(times=0)`.
|
1170
|
+
Specifies the Conda environment for all steps of the flow.
|
1074
1171
|
|
1075
|
-
|
1076
|
-
|
1077
|
-
ensuring that the flow execution can continue.
|
1172
|
+
Use `@conda_base` to set common libraries required by all
|
1173
|
+
steps and use `@conda` to specify step-specific additions.
|
1078
1174
|
|
1079
1175
|
Parameters
|
1080
1176
|
----------
|
1081
|
-
|
1082
|
-
|
1083
|
-
|
1084
|
-
|
1177
|
+
packages : Dict[str, str], default {}
|
1178
|
+
Packages to use for this flow. The key is the name of the package
|
1179
|
+
and the value is the version to use.
|
1180
|
+
libraries : Dict[str, str], default {}
|
1181
|
+
Supported for backward compatibility. When used with packages, packages will take precedence.
|
1182
|
+
python : str, optional, default None
|
1183
|
+
Version of Python to use, e.g. '3.7.4'. A default value of None implies
|
1184
|
+
that the version used will correspond to the version of the Python interpreter used to start the run.
|
1185
|
+
disabled : bool, default False
|
1186
|
+
If set to True, disables Conda.
|
1085
1187
|
"""
|
1086
1188
|
...
|
1087
1189
|
|
1088
1190
|
@typing.overload
|
1089
|
-
def
|
1090
|
-
...
|
1091
|
-
|
1092
|
-
@typing.overload
|
1093
|
-
def retry(f: typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, typing.Any, StepFlag], None]:
|
1191
|
+
def conda_base(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
1094
1192
|
...
|
1095
1193
|
|
1096
|
-
def
|
1194
|
+
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):
|
1097
1195
|
"""
|
1098
|
-
Specifies the
|
1099
|
-
to a step needs to be retried.
|
1100
|
-
|
1101
|
-
This decorator is useful for handling transient errors, such as networking issues.
|
1102
|
-
If your task contains operations that can't be retried safely, e.g. database updates,
|
1103
|
-
it is advisable to annotate it with `@retry(times=0)`.
|
1196
|
+
Specifies the Conda environment for all steps of the flow.
|
1104
1197
|
|
1105
|
-
|
1106
|
-
|
1107
|
-
ensuring that the flow execution can continue.
|
1198
|
+
Use `@conda_base` to set common libraries required by all
|
1199
|
+
steps and use `@conda` to specify step-specific additions.
|
1108
1200
|
|
1109
1201
|
Parameters
|
1110
1202
|
----------
|
1111
|
-
|
1112
|
-
|
1113
|
-
|
1114
|
-
|
1203
|
+
packages : Dict[str, str], default {}
|
1204
|
+
Packages to use for this flow. The key is the name of the package
|
1205
|
+
and the value is the version to use.
|
1206
|
+
libraries : Dict[str, str], default {}
|
1207
|
+
Supported for backward compatibility. When used with packages, packages will take precedence.
|
1208
|
+
python : str, optional, default None
|
1209
|
+
Version of Python to use, e.g. '3.7.4'. A default value of None implies
|
1210
|
+
that the version used will correspond to the version of the Python interpreter used to start the run.
|
1211
|
+
disabled : bool, default False
|
1212
|
+
If set to True, disables Conda.
|
1115
1213
|
"""
|
1116
1214
|
...
|
1117
1215
|
|
@@ -1154,37 +1252,6 @@ def pypi_base(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, packag
|
|
1154
1252
|
"""
|
1155
1253
|
...
|
1156
1254
|
|
1157
|
-
def nim(*, models: "list[NIM]", backend: str) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
1158
|
-
"""
|
1159
|
-
This decorator is used to run NIM containers in Metaflow tasks as sidecars.
|
1160
|
-
|
1161
|
-
User code call
|
1162
|
-
-----------
|
1163
|
-
@nim(
|
1164
|
-
models=['meta/llama3-8b-instruct', 'meta/llama3-70b-instruct'],
|
1165
|
-
backend='managed'
|
1166
|
-
)
|
1167
|
-
|
1168
|
-
Valid backend options
|
1169
|
-
---------------------
|
1170
|
-
- 'managed': Outerbounds selects a compute provider based on the model.
|
1171
|
-
- 🚧 'dataplane': Run in your account.
|
1172
|
-
|
1173
|
-
Valid model options
|
1174
|
-
----------------
|
1175
|
-
- 'meta/llama3-8b-instruct': 8B parameter model
|
1176
|
-
- 'meta/llama3-70b-instruct': 70B parameter model
|
1177
|
-
- Upon request, any model here: https://nvcf.ngc.nvidia.com/functions?filter=nvidia-functions
|
1178
|
-
|
1179
|
-
Parameters
|
1180
|
-
----------
|
1181
|
-
models: list[NIM]
|
1182
|
-
List of NIM containers running models in sidecars.
|
1183
|
-
backend: str
|
1184
|
-
Compute provider to run the NIM container.
|
1185
|
-
"""
|
1186
|
-
...
|
1187
|
-
|
1188
1255
|
@typing.overload
|
1189
1256
|
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]]:
|
1190
1257
|
"""
|
@@ -1280,6 +1347,48 @@ def trigger(f: typing.Optional[typing.Type[FlowSpecDerived]] = None, *, event: t
|
|
1280
1347
|
"""
|
1281
1348
|
...
|
1282
1349
|
|
1350
|
+
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]]:
|
1351
|
+
"""
|
1352
|
+
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)
|
1353
|
+
before the start step of the flow. This decorator only works when a flow is scheduled on Airflow
|
1354
|
+
and is compiled using `airflow create`. More than one `@airflow_s3_key_sensor` can be
|
1355
|
+
added as a flow decorators. Adding more than one decorator will ensure that `start` step
|
1356
|
+
starts only after all sensors finish.
|
1357
|
+
|
1358
|
+
Parameters
|
1359
|
+
----------
|
1360
|
+
timeout : int
|
1361
|
+
Time, in seconds before the task times out and fails. (Default: 3600)
|
1362
|
+
poke_interval : int
|
1363
|
+
Time in seconds that the job should wait in between each try. (Default: 60)
|
1364
|
+
mode : str
|
1365
|
+
How the sensor operates. Options are: { poke | reschedule }. (Default: "poke")
|
1366
|
+
exponential_backoff : bool
|
1367
|
+
allow progressive longer waits between pokes by using exponential backoff algorithm. (Default: True)
|
1368
|
+
pool : str
|
1369
|
+
the slot pool this task should run in,
|
1370
|
+
slot pools are a way to limit concurrency for certain tasks. (Default:None)
|
1371
|
+
soft_fail : bool
|
1372
|
+
Set to true to mark the task as SKIPPED on failure. (Default: False)
|
1373
|
+
name : str
|
1374
|
+
Name of the sensor on Airflow
|
1375
|
+
description : str
|
1376
|
+
Description of sensor in the Airflow UI
|
1377
|
+
bucket_key : Union[str, List[str]]
|
1378
|
+
The key(s) being waited on. Supports full s3:// style url or relative path from root level.
|
1379
|
+
When it's specified as a full s3:// url, please leave `bucket_name` as None
|
1380
|
+
bucket_name : str
|
1381
|
+
Name of the S3 bucket. Only needed when bucket_key is not provided as a full s3:// url.
|
1382
|
+
When specified, all the keys passed to bucket_key refers to this bucket. (Default:None)
|
1383
|
+
wildcard_match : bool
|
1384
|
+
whether the bucket_key should be interpreted as a Unix wildcard pattern. (Default: False)
|
1385
|
+
aws_conn_id : str
|
1386
|
+
a reference to the s3 connection on Airflow. (Default: None)
|
1387
|
+
verify : bool
|
1388
|
+
Whether or not to verify SSL certificates for S3 connection. (Default: None)
|
1389
|
+
"""
|
1390
|
+
...
|
1391
|
+
|
1283
1392
|
@typing.overload
|
1284
1393
|
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]]:
|
1285
1394
|
"""
|
@@ -1401,97 +1510,6 @@ def project(*, name: str) -> typing.Callable[[typing.Type[FlowSpecDerived]], typ
|
|
1401
1510
|
"""
|
1402
1511
|
...
|
1403
1512
|
|
1404
|
-
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]]:
|
1405
|
-
"""
|
1406
|
-
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)
|
1407
|
-
before the start step of the flow. This decorator only works when a flow is scheduled on Airflow
|
1408
|
-
and is compiled using `airflow create`. More than one `@airflow_s3_key_sensor` can be
|
1409
|
-
added as a flow decorators. Adding more than one decorator will ensure that `start` step
|
1410
|
-
starts only after all sensors finish.
|
1411
|
-
|
1412
|
-
Parameters
|
1413
|
-
----------
|
1414
|
-
timeout : int
|
1415
|
-
Time, in seconds before the task times out and fails. (Default: 3600)
|
1416
|
-
poke_interval : int
|
1417
|
-
Time in seconds that the job should wait in between each try. (Default: 60)
|
1418
|
-
mode : str
|
1419
|
-
How the sensor operates. Options are: { poke | reschedule }. (Default: "poke")
|
1420
|
-
exponential_backoff : bool
|
1421
|
-
allow progressive longer waits between pokes by using exponential backoff algorithm. (Default: True)
|
1422
|
-
pool : str
|
1423
|
-
the slot pool this task should run in,
|
1424
|
-
slot pools are a way to limit concurrency for certain tasks. (Default:None)
|
1425
|
-
soft_fail : bool
|
1426
|
-
Set to true to mark the task as SKIPPED on failure. (Default: False)
|
1427
|
-
name : str
|
1428
|
-
Name of the sensor on Airflow
|
1429
|
-
description : str
|
1430
|
-
Description of sensor in the Airflow UI
|
1431
|
-
bucket_key : Union[str, List[str]]
|
1432
|
-
The key(s) being waited on. Supports full s3:// style url or relative path from root level.
|
1433
|
-
When it's specified as a full s3:// url, please leave `bucket_name` as None
|
1434
|
-
bucket_name : str
|
1435
|
-
Name of the S3 bucket. Only needed when bucket_key is not provided as a full s3:// url.
|
1436
|
-
When specified, all the keys passed to bucket_key refers to this bucket. (Default:None)
|
1437
|
-
wildcard_match : bool
|
1438
|
-
whether the bucket_key should be interpreted as a Unix wildcard pattern. (Default: False)
|
1439
|
-
aws_conn_id : str
|
1440
|
-
a reference to the s3 connection on Airflow. (Default: None)
|
1441
|
-
verify : bool
|
1442
|
-
Whether or not to verify SSL certificates for S3 connection. (Default: None)
|
1443
|
-
"""
|
1444
|
-
...
|
1445
|
-
|
1446
|
-
@typing.overload
|
1447
|
-
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]]:
|
1448
|
-
"""
|
1449
|
-
Specifies the Conda environment for all steps of the flow.
|
1450
|
-
|
1451
|
-
Use `@conda_base` to set common libraries required by all
|
1452
|
-
steps and use `@conda` to specify step-specific additions.
|
1453
|
-
|
1454
|
-
Parameters
|
1455
|
-
----------
|
1456
|
-
packages : Dict[str, str], default {}
|
1457
|
-
Packages to use for this flow. The key is the name of the package
|
1458
|
-
and the value is the version to use.
|
1459
|
-
libraries : Dict[str, str], default {}
|
1460
|
-
Supported for backward compatibility. When used with packages, packages will take precedence.
|
1461
|
-
python : str, optional, default None
|
1462
|
-
Version of Python to use, e.g. '3.7.4'. A default value of None implies
|
1463
|
-
that the version used will correspond to the version of the Python interpreter used to start the run.
|
1464
|
-
disabled : bool, default False
|
1465
|
-
If set to True, disables Conda.
|
1466
|
-
"""
|
1467
|
-
...
|
1468
|
-
|
1469
|
-
@typing.overload
|
1470
|
-
def conda_base(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
1471
|
-
...
|
1472
|
-
|
1473
|
-
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):
|
1474
|
-
"""
|
1475
|
-
Specifies the Conda environment for all steps of the flow.
|
1476
|
-
|
1477
|
-
Use `@conda_base` to set common libraries required by all
|
1478
|
-
steps and use `@conda` to specify step-specific additions.
|
1479
|
-
|
1480
|
-
Parameters
|
1481
|
-
----------
|
1482
|
-
packages : Dict[str, str], default {}
|
1483
|
-
Packages to use for this flow. The key is the name of the package
|
1484
|
-
and the value is the version to use.
|
1485
|
-
libraries : Dict[str, str], default {}
|
1486
|
-
Supported for backward compatibility. When used with packages, packages will take precedence.
|
1487
|
-
python : str, optional, default None
|
1488
|
-
Version of Python to use, e.g. '3.7.4'. A default value of None implies
|
1489
|
-
that the version used will correspond to the version of the Python interpreter used to start the run.
|
1490
|
-
disabled : bool, default False
|
1491
|
-
If set to True, disables Conda.
|
1492
|
-
"""
|
1493
|
-
...
|
1494
|
-
|
1495
1513
|
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]]:
|
1496
1514
|
"""
|
1497
1515
|
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.
|
@@ -1534,52 +1552,34 @@ def airflow_external_task_sensor(*, timeout: int, poke_interval: int, mode: str,
|
|
1534
1552
|
"""
|
1535
1553
|
...
|
1536
1554
|
|
1537
|
-
|
1538
|
-
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]]:
|
1555
|
+
def nim(*, models: "list[NIM]", backend: str) -> typing.Callable[[typing.Type[FlowSpecDerived]], typing.Type[FlowSpecDerived]]:
|
1539
1556
|
"""
|
1540
|
-
|
1541
|
-
production scheduler.
|
1557
|
+
This decorator is used to run NIM containers in Metaflow tasks as sidecars.
|
1542
1558
|
|
1543
|
-
|
1544
|
-
|
1545
|
-
|
1546
|
-
|
1547
|
-
|
1548
|
-
|
1549
|
-
|
1550
|
-
|
1551
|
-
|
1552
|
-
|
1553
|
-
|
1554
|
-
|
1555
|
-
|
1556
|
-
|
1557
|
-
|
1558
|
-
|
1559
|
-
|
1560
|
-
@typing.overload
|
1561
|
-
def schedule(f: typing.Type[FlowSpecDerived]) -> typing.Type[FlowSpecDerived]:
|
1562
|
-
...
|
1563
|
-
|
1564
|
-
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):
|
1565
|
-
"""
|
1566
|
-
Specifies the times when the flow should be run when running on a
|
1567
|
-
production scheduler.
|
1559
|
+
User code call
|
1560
|
+
-----------
|
1561
|
+
@nim(
|
1562
|
+
models=['meta/llama3-8b-instruct', 'meta/llama3-70b-instruct'],
|
1563
|
+
backend='managed'
|
1564
|
+
)
|
1565
|
+
|
1566
|
+
Valid backend options
|
1567
|
+
---------------------
|
1568
|
+
- 'managed': Outerbounds selects a compute provider based on the model.
|
1569
|
+
- 🚧 'dataplane': Run in your account.
|
1570
|
+
|
1571
|
+
Valid model options
|
1572
|
+
----------------
|
1573
|
+
- 'meta/llama3-8b-instruct': 8B parameter model
|
1574
|
+
- 'meta/llama3-70b-instruct': 70B parameter model
|
1575
|
+
- Upon request, any model here: https://nvcf.ngc.nvidia.com/functions?filter=nvidia-functions
|
1568
1576
|
|
1569
1577
|
Parameters
|
1570
1578
|
----------
|
1571
|
-
|
1572
|
-
|
1573
|
-
|
1574
|
-
|
1575
|
-
weekly : bool, default False
|
1576
|
-
Run the workflow weekly.
|
1577
|
-
cron : str, optional, default None
|
1578
|
-
Run the workflow at [a custom Cron schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions)
|
1579
|
-
specified by this expression.
|
1580
|
-
timezone : str, optional, default None
|
1581
|
-
Timezone on which the schedule runs (default: None). Currently supported only for Argo workflows,
|
1582
|
-
which accepts timezones in [IANA format](https://nodatime.org/TimeZones).
|
1579
|
+
models: list[NIM]
|
1580
|
+
List of NIM containers running models in sidecars.
|
1581
|
+
backend: str
|
1582
|
+
Compute provider to run the NIM container.
|
1583
1583
|
"""
|
1584
1584
|
...
|
1585
1585
|
|