itwinai.cli
- itwinai.cli.generate_scalability_report(log_dir: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fdf9754aa70>] = 'scalability-metrics', plot_dir: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fdf9754a980>] = 'plots', do_backup: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fdf97548f70>] = False, backup_root_dir: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fdf9754a140>] = 'backup-scalability-metrics/', experiment_name: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7fdf9754ab00>] | None = None)[source]
Generates scalability reports for epoch time, GPU data, and communication data based on log files in the specified directory. Optionally, backups of the reports can be created.
This command processes log files stored in specific subdirectories under the given log_dir. It generates plots and metrics for scalability analysis and saves them in the plot_dir. If backups are enabled, the generated reports will also be copied to a backup directory under backup_root_dir.
- itwinai.cli.sanity_check(torch: ~typing.Annotated[bool | None, <typer.models.OptionInfo object at 0x7fdf9754abf0>] = False, tensorflow: ~typing.Annotated[bool | None, <typer.models.OptionInfo object at 0x7fdf9754ac80>] = False, all: ~typing.Annotated[bool | None, <typer.models.OptionInfo object at 0x7fdf9754ad10>] = False, optional_deps: ~typing.List[str] = <typer.models.OptionInfo object>)[source]
Run sanity checks on the installation of itwinai and its dependencies by trying to import itwinai modules. By default, only itwinai core modules (neither torch, nor tensorflow) are tested.
- itwinai.cli.exec_pipeline(config: ~pathlib.Annotated[~pathlib.Path, <typer.models.OptionInfo object at 0x7fdf9754add0>], pipe_key: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fdf9754ae60>] = 'pipeline', steps: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7fdf9754aef0>] | None = None, print_config: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fdf9754af80>] = False, overrides_list: ~typing.Annotated[~typing.List[str] | None, <typer.models.OptionInfo object at 0x7fdf9754b010>] | None = None)[source]
Execute a pipeline from configuration file. Allows dynamic override of fields.
- itwinai.cli.mlflow_ui(path: str = <typer.models.OptionInfo object>, port: int = <typer.models.OptionInfo object>, host: str = <typer.models.OptionInfo object>)[source]
Visualize Mlflow logs.