OliveSystems

The following systems are available in Olive.

Config

pydantic settings olive.systems.system_config.SystemConfig

field config: TargetUserConfig = None

field type: SystemType [Required]

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

Device

DockerTargetUserConfig

pydantic settings olive.systems.system_config.DockerTargetUserConfig

field is_dev: bool = False

field local_docker_config: LocalDockerConfig [Required]

LocalDockerConfig

pydantic settings olive.systems.docker.LocalDockerConfig

field base_image: str | None = None

field build_args: dict | None = None

field build_context_path: Path | str | 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

field aml_compute: str [Required]

field aml_docker_config: AzureMLDockerConfig [Required]

field azureml_client_config: AzureMLClientConfig = None

field instance_count: int = 1

field is_dev: bool = False

AzureMLDockerConfig

pydantic settings olive.systems.azureml.AzureMLDockerConfig

field base_image: str | None = None

field build_context_path: Path | str | None = None

field conda_file_path: Path | str | None = None

field dockerfile: str | None = None

PythonEnvironmentTargetUserConfig

pydantic settings olive.systems.system_config.PythonEnvironmentTargetUserConfig

field environment_variables: Dict[str, str] = None

field prepend_to_path: List[str] = None

field python_environment_path: Path | str [Required]

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, instance_count: int = 1, is_dev: bool = False, accelerators: List[str] | None = None)

DockerSystem

class olive.systems.docker.DockerSystem(local_docker_config: Dict[str, Any] | LocalDockerConfig, is_dev: bool = False)

PythonEnvironmentSystem

class olive.systems.python_environment.PythonEnvironmentSystem(python_environment_path: Path | str, environment_variables: Dict[str, str] | None = None, prepend_to_path: List[str] | None = None, accelerators: List[str] | None = None)