Skip to content

taps.run.apps.synthetic

taps/run/apps/synthetic.py

SyntheticConfig

Bases: AppConfig

Synthetic application configuration.

add_argument_group() classmethod 

add_argument_group(
    parser: ArgumentParser,
    *,
    argv: Sequence[str] | None = None,
    required: bool = True
) -> None

Add model fields as arguments of an argument group on the parser.

Parameters:

  • parser (ArgumentParser) –

    Parser to add a new argument group to.

  • argv (Sequence[str] | None, default: None ) –

    Optional sequence of string arguments.

  • required (bool, default: True ) –

    Mark arguments without defaults as required.

Source code in taps/config.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@classmethod
def add_argument_group(
    cls,
    parser: argparse.ArgumentParser,
    *,
    argv: Sequence[str] | None = None,
    required: bool = True,
) -> None:
    """Add model fields as arguments of an argument group on the parser.

    Args:
        parser: Parser to add a new argument group to.
        argv: Optional sequence of string arguments.
        required: Mark arguments without defaults as required.
    """
    group = parser.add_argument_group(cls.__name__)
    for field_name, field_info in cls.model_fields.items():
        arg_name = field_name.replace('_', '-').lower()
        group.add_argument(
            f'--{arg_name}',
            dest=field_name,
            # type=field_info.annotation,
            default=field_info.get_default(),
            required=field_info.is_required() and required,
            help=field_info.description,
        )

create_app() 

create_app() -> App

Create an application instance from the config.

Source code in taps/run/apps/synthetic.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
def create_app(self) -> App:
    """Create an application instance from the config."""
    from taps.apps.synthetic import SyntheticApp
    from taps.apps.synthetic import WorkflowStructure

    return SyntheticApp(
        structure=WorkflowStructure(self.structure),
        task_count=self.task_count,
        task_data_bytes=self.task_data_bytes,
        task_sleep=self.task_sleep,
        bag_max_running=self.bag_max_running,
        warmup_task=self.warmup_task,
    )