OliveSystems

The following systems are available in Olive.

Config

pydantic settings olive.systems.system_config.SystemConfig

field type: SystemType [Required]

field config: TargetUserConfig = None

create_system()

SystemType

class olive.systems.common.SystemType(value)

An enumeration.

AzureML = 'AzureML'

Docker = 'Docker'

Local = 'LocalSystem'

PythonEnvironment = 'PythonEnvironment'

LocalTargetUserConfig

pydantic settings olive.systems.system_config.LocalTargetUserConfig

field accelerators: List[str] = None

DockerTargetUserConfig

pydantic settings olive.systems.system_config.DockerTargetUserConfig

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

field image_name: str [Required]

field base_image: str | None = None

field requirements_file_path: str | None = None

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

field azureml_client_config: AzureMLClientConfig = None

field aml_compute: str [Required]

field aml_docker_config: AzureMLDockerConfig = None

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

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

PythonEnvironmentTargetUserConfig

pydantic settings olive.systems.system_config.PythonEnvironmentTargetUserConfig

field python_environment_path: Path | str = None

field environment_variables: Dict[str, str] = None

field prepend_to_path: List[str] = None

field olive_managed_env: bool = False

field requirements_file: Path | str = None

Classes

LocalSystem

class olive.systems.local.LocalSystem(accelerators: List[str] | None = None)

AzureMLSystem

class olive.systems.azureml.AzureMLSystem(azureml_client_config: AzureMLClientConfig, aml_compute: str, aml_docker_config: Dict[str, Any] | AzureMLDockerConfig | None = None, resources: Dict | None = None, instance_count: int = 1, is_dev: bool = False, accelerators: List[str] | None = None, olive_managed_env: bool = False, requirements_file: str | Path | None = None)

DockerSystem

class olive.systems.docker.DockerSystem(local_docker_config: Dict[str, Any] | LocalDockerConfig | None = None, accelerators: List[str] | None = None, is_dev: bool = False, olive_managed_env: bool = False, requirements_file: str | Path | None = None)

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[str] | None = None, olive_managed_env: bool = False, requirements_file: str | Path | None = None)

System Alias

class olive.systems.system_alias.AzureND12SSystem

accelerators = ['GPU']

num_cpus = 12

num_gpus = 2

sku = 'STANDARD_ND12S'

system_type = 'AzureML'

class olive.systems.system_alias.AzureND24RSSystem

accelerators = ['GPU']

num_cpus = 24

num_gpus = 4

sku = 'STANDARD_ND24RS'

system_type = 'AzureML'

class olive.systems.system_alias.AzureND24SSystem

accelerators = ['GPU']

num_cpus = 24

num_gpus = 4

sku = 'STANDARD_ND24S'

system_type = 'AzureML'

class olive.systems.system_alias.AzureND6SSystem

accelerators = ['GPU']

num_cpus = 6

num_gpus = 1

sku = 'STANDARD_ND6S'

system_type = 'AzureML'

class olive.systems.system_alias.AzureND96A100System

accelerators = ['GPU']

num_cpus = 96

num_gpus = 8

sku = 'STANDARD_ND96AMSR_A100_V4'

system_type = 'AzureML'

class olive.systems.system_alias.AzureND96ASystem

accelerators = ['GPU']

num_cpus = 96

num_gpus = 8

sku = 'STANDARD_ND96ASR_V4'

system_type = 'AzureML'

class olive.systems.system_alias.AzureNDV2System

accelerators = ['GPU']

num_cpus = 40

num_gpus = 8

sku = 'STANDARD_ND40RS_V2'

system_type = 'AzureML'

class olive.systems.system_alias.SurfaceProSystem1796

accelerators = ['GPU']

sku = 'Surface_Pro_1796'

system_type = 'LocalSystem'

class olive.systems.system_alias.SurfaceProSystem1807

accelerators = ['GPU']

sku = 'Surface_Pro_1807'

system_type = 'LocalSystem'