OliveSystems¶

The following systems are available in Olive.

Config¶

pydantic settings olive.systems.system_config.SystemConfig[source]¶

field config: TargetUserConfig = None¶

field type: SystemType [Required]¶

create_system()[source]¶

SystemType¶

enum olive.systems.common.SystemType(value)[source]¶

An enumeration.

Member Type:: str

Valid values are as follows:

Docker = <SystemType.Docker: 'Docker'>¶

Local = <SystemType.Local: 'LocalSystem'>¶

AzureML = <SystemType.AzureML: 'AzureML'>¶

LocalTargetUserConfig¶

pydantic settings olive.systems.system_config.LocalTargetUserConfig[source]¶

field device: Device = Device.CPU¶

Device

enum olive.systems.common.Device(value)[source]¶

An enumeration.

Member Type:: str

Valid values are as follows:

CPU = <Device.CPU: 'cpu'>¶

GPU = <Device.GPU: 'gpu'>¶

NPU = <Device.NPU: 'npu'>¶

INTEL_MYRIAD = <Device.INTEL_MYRIAD: 'intel_myriad'>¶

DockerTargetUserConfig¶

pydantic settings olive.systems.system_config.DockerTargetUserConfig[source]¶

field local_docker_config: LocalDockerConfig [Required]¶

LocalDockerConfig

pydantic settings olive.systems.docker.LocalDockerConfig[source]¶

field base_image: str | None = None¶

field build_args: dict | None = None¶

field build_context_path: str | Path | None = None¶

field dockerfile: str | None = None¶

field image_name: str [Required]¶

field requirements_file_path: str | None = None¶

field run_params: dict | None = None¶

AzureMLTargetUserConfig¶

pydantic settings olive.systems.system_config.AzureMLTargetUserConfig[source]¶

field aml_compute: str [Required]¶

field aml_config_path: Path | str [Required]¶

field aml_docker_config: AzureMLDockerConfig [Required]¶

field instance_count: int = 1¶

field is_dev: bool = False¶

AzureMLDockerConfig

pydantic settings olive.systems.azureml.AzureMLDockerConfig[source]¶

field base_image: str | None = None¶

field build_context_path: str | Path | None = None¶

field conda_file_path: str | Path | None = None¶

field dockerfile: str | None = None¶

Classes¶

LocalSystem¶

class olive.systems.local.LocalSystem(device: Device = Device.CPU)[source]¶

AzureMLSystem¶

class olive.systems.azureml.AzureMLSystem(aml_config_path: str, aml_compute: str, aml_docker_config: Dict[str, Any] | AzureMLDockerConfig, device: Device = Device.CPU, instance_count: int = 1, is_dev: bool = False)[source]¶

DockerSystem¶

class olive.systems.docker.DockerSystem(local_docker_config: Dict[str, Any] | LocalDockerConfig)[source]¶