OliveSystems

The following systems are available in Olive.

Config

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

field type: SystemType [Required]

field config: TargetUserConfig = None

create_system()[source]

property olive_managed_env

SystemType

class olive.systems.common.SystemType(value)[source]

An enumeration.

AzureML = 'AzureML'

Docker = 'Docker'

IsolatedORT = 'IsolatedORT'

Local = 'LocalSystem'

PythonEnvironment = 'PythonEnvironment'

Device

class olive.hardware.accelerator.Device(value)[source]

An enumeration.

CPU = 'cpu'

CPU_SPR = 'cpu_spr'

GPU = 'gpu'

INTEL_MYRIAD = 'intel_myriad'

NPU = 'npu'

VPU = 'vpu'

AcceleratorConfig

class olive.systems.common.AcceleratorConfig(*, device: str | Device = None, execution_providers: List[str] = None, memory: int | str = None)[source]

field device: str | Device = None: Device to use for the accelerator

field execution_providers: List[str] = None: Execution providers for the accelerator. Each must end with ExecutionProvider

field memory: int | str = None: Memory size of accelerator in bytes. Can also be provided in string format like 1GB.

validator validate_ep_suffix » execution_providers[source]

validator validate_memory » memory[source]

LocalTargetUserConfig

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

field accelerators: List[AcceleratorConfig] = None

field hf_token: bool = None

DockerTargetUserConfig

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

field local_docker_config: LocalDockerConfig = None

field is_dev: bool = False

field olive_managed_env: bool = False

field requirements_file: Path | str = None

LocalDockerConfig

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

field image_name: str [Required]

field dockerfile: str | None = None

field build_context_path: Path | str | None = None

field build_args: dict | None = None

field run_params: dict | None = None

AzureMLTargetUserConfig

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

field azureml_client_config: AzureMLClientConfig = None

field aml_compute: str [Required]

field aml_docker_config: AzureMLDockerConfig = None

field aml_environment_config: AzureMLEnvironmentConfig = None

field tags: Dict = None

field datastores: str = 'workspaceblobstore'

field resources: Dict = None

field instance_count: int = 1

field is_dev: bool = False

field olive_managed_env: bool = False

field requirements_file: Path | str = None

AzureMLDockerConfig

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

field base_image: str | None = None

field dockerfile: str | None = None

field build_context_path: Path | str | None = None

field conda_file_path: Path | str | None = None

field name: str | None = None

field version: str | None = None

PythonEnvironmentTargetUserConfig

pydantic settings olive.systems.system_config.PythonEnvironmentTargetUserConfig[source]

field olive_managed_env: bool = False

field requirements_file: Path | str = None

IsolatedORTTargetUserConfig

pydantic settings olive.systems.system_config.IsolatedORTTargetUserConfig[source]

field python_environment_path: Path | str = None

field environment_variables: Dict[str, str] = None

field prepend_to_path: List[str] = None

Classes

LocalSystem

class olive.systems.local.LocalSystem(accelerators: List[AcceleratorConfig] | List[Dict[str, Any]] | None = None, hf_token: bool | None = None)[source]

AzureMLSystem

class olive.systems.azureml.AzureMLSystem(azureml_client_config: AzureMLClientConfig, aml_compute: str, aml_docker_config: Dict[str, Any] | AzureMLDockerConfig | None = None, aml_environment_config: Dict[str, Any] | AzureMLEnvironmentConfig | None = None, tags: Dict | None = None, resources: Dict | None = None, instance_count: int = 1, is_dev: bool = False, accelerators: List[AcceleratorConfig] | None = None, hf_token: bool | None = None, **kwargs)[source]

DockerSystem

class olive.systems.docker.DockerSystem(local_docker_config: Dict[str, Any] | LocalDockerConfig, accelerators: List[AcceleratorConfig] | None = None, is_dev: bool = False, hf_token: bool | None = None, requirements_file: str | Path | None = None, **kwargs)[source]

PythonEnvironmentSystem

class olive.systems.python_environment.PythonEnvironmentSystem(python_environment_path: str | Path | None = None, environment_variables: Dict[str, str] | None = None, prepend_to_path: List[str] | None = None, accelerators: List[AcceleratorConfig] | None = None, olive_managed_env: bool = False, requirements_file: str | Path | None = None, hf_token: bool | None = None)[source]

IsolatedORTSystem

class olive.systems.isolated_ort.IsolatedORTSystem(python_environment_path: str | Path | None = None, environment_variables: Dict[str, str] | None = None, prepend_to_path: List[str] | None = None, accelerators: List[AcceleratorConfig] | None = None, hf_token: bool | None = None)[source]

System Alias

class olive.systems.system_alias.AzureND12SSystem[source]

accelerators: ClassVar[list] = ['GPU']

num_cpus = 12

num_gpus = 2

sku = 'STANDARD_ND12S'

system_type = 'AzureML'

class olive.systems.system_alias.AzureND24RSSystem[source]

accelerators: ClassVar[list] = ['GPU']

num_cpus = 24

num_gpus = 4

sku = 'STANDARD_ND24RS'

system_type = 'AzureML'

class olive.systems.system_alias.AzureND24SSystem[source]

accelerators: ClassVar[list] = ['GPU']

num_cpus = 24

num_gpus = 4

sku = 'STANDARD_ND24S'

system_type = 'AzureML'

class olive.systems.system_alias.AzureND6SSystem[source]

accelerators: ClassVar[list] = ['GPU']

num_cpus = 6

num_gpus = 1

sku = 'STANDARD_ND6S'

system_type = 'AzureML'

class olive.systems.system_alias.AzureND96A100System[source]

accelerators: ClassVar[list] = ['GPU']

num_cpus = 96

num_gpus = 8

sku = 'STANDARD_ND96AMSR_A100_V4'

system_type = 'AzureML'

class olive.systems.system_alias.AzureND96ASystem[source]

accelerators: ClassVar[list] = ['GPU']

num_cpus = 96

num_gpus = 8

sku = 'STANDARD_ND96ASR_V4'

system_type = 'AzureML'

class olive.systems.system_alias.AzureNDV2System[source]

accelerators: ClassVar[list] = ['GPU']

num_cpus = 40

num_gpus = 8

sku = 'STANDARD_ND40RS_V2'

system_type = 'AzureML'

class olive.systems.system_alias.SurfaceProSystem1796[source]

accelerators: ClassVar[list] = ['GPU']

sku = 'Surface_Pro_1796'

system_type = 'LocalSystem'

class olive.systems.system_alias.SurfaceProSystem1807[source]

accelerators: ClassVar[list] = ['GPU']

sku = 'Surface_Pro_1807'

system_type = 'LocalSystem'