diff options
Diffstat (limited to 'src')
-rw-r--r-- | src/mlia/api.py | 2 | ||||
-rw-r--r-- | src/mlia/cli/command_validators.py | 2 | ||||
-rw-r--r-- | src/mlia/cli/options.py | 2 | ||||
-rw-r--r-- | src/mlia/target/config.py | 99 | ||||
-rw-r--r-- | src/mlia/target/cortex_a/advisor.py | 4 | ||||
-rw-r--r-- | src/mlia/target/cortex_a/config.py | 23 | ||||
-rw-r--r-- | src/mlia/target/ethos_u/advisor.py | 12 | ||||
-rw-r--r-- | src/mlia/target/ethos_u/config.py | 73 | ||||
-rw-r--r-- | src/mlia/target/tosa/advisor.py | 2 | ||||
-rw-r--r-- | src/mlia/target/tosa/config.py | 24 | ||||
-rw-r--r-- | src/mlia/utils/filesystem.py | 51 |
11 files changed, 158 insertions, 136 deletions
diff --git a/src/mlia/api.py b/src/mlia/api.py index 437c457..fd5fc13 100644 --- a/src/mlia/api.py +++ b/src/mlia/api.py @@ -10,10 +10,10 @@ from typing import Any from mlia.core.advisor import InferenceAdvisor from mlia.core.common import AdviceCategory from mlia.core.context import ExecutionContext +from mlia.target.config import get_target from mlia.target.cortex_a.advisor import configure_and_get_cortexa_advisor from mlia.target.ethos_u.advisor import configure_and_get_ethosu_advisor from mlia.target.tosa.advisor import configure_and_get_tosa_advisor -from mlia.utils.filesystem import get_target logger = logging.getLogger(__name__) diff --git a/src/mlia/cli/command_validators.py b/src/mlia/cli/command_validators.py index 1974a1d..eb04192 100644 --- a/src/mlia/cli/command_validators.py +++ b/src/mlia/cli/command_validators.py @@ -8,8 +8,8 @@ import logging import sys from mlia.cli.config import get_default_backends +from mlia.target.config import get_target from mlia.target.registry import supported_backends -from mlia.utils.filesystem import get_target logger = logging.getLogger(__name__) diff --git a/src/mlia/cli/options.py b/src/mlia/cli/options.py index 1b92958..dac8c82 100644 --- a/src/mlia/cli/options.py +++ b/src/mlia/cli/options.py @@ -13,7 +13,7 @@ from mlia.cli.config import DEFAULT_PRUNING_TARGET from mlia.cli.config import get_available_backends from mlia.cli.config import is_corstone_backend from mlia.core.typing import OutputFormat -from mlia.utils.filesystem import get_builtin_supported_profile_names +from mlia.target.config import get_builtin_supported_profile_names def add_check_category_options(parser: argparse.ArgumentParser) -> None: diff --git a/src/mlia/target/config.py b/src/mlia/target/config.py index f257784..ec3fb4c 100644 --- a/src/mlia/target/config.py +++ b/src/mlia/target/config.py @@ -1,21 +1,110 @@ -# SPDX-FileCopyrightText: Copyright 2022, Arm Limited and/or its affiliates. +# SPDX-FileCopyrightText: Copyright 2022-2023, Arm Limited and/or its affiliates. # SPDX-License-Identifier: Apache-2.0 -"""IP configuration module.""" +"""Target configuration module.""" from __future__ import annotations +from abc import ABC +from abc import abstractmethod from dataclasses import dataclass +from pathlib import Path +from typing import Any +from typing import cast +from typing import TypeVar + +try: + import tomllib +except ModuleNotFoundError: + import tomli as tomllib # type: ignore from mlia.backend.registry import registry as backend_registry from mlia.core.common import AdviceCategory +from mlia.utils.filesystem import get_mlia_target_profiles_dir + + +def get_profile_file(target_profile: str | Path) -> Path: + """Get the target profile toml file.""" + if not target_profile: + raise Exception("Target profile is not provided.") + + profile_file = Path(get_mlia_target_profiles_dir() / f"{target_profile}.toml") + if not profile_file.is_file(): + profile_file = Path(target_profile) + + if not profile_file.exists(): + raise Exception(f"File not found: {profile_file}.") + return profile_file + + +def load_profile(path: str | Path) -> dict[str, Any]: + """Get settings for the provided target profile.""" + with open(path, "rb") as file: + profile = tomllib.load(file) + + return cast(dict, profile) + + +def get_builtin_supported_profile_names() -> list[str]: + """Return list of default profiles in the target profiles directory.""" + return sorted( + [ + item.stem + for item in get_mlia_target_profiles_dir().iterdir() + if item.is_file() and item.suffix == ".toml" + ] + ) + +def get_target(target_profile: str | Path) -> str: + """Return target for the provided target_profile.""" + profile_file = get_profile_file(target_profile) + profile = load_profile(profile_file) + return cast(str, profile["target"]) -class IPConfiguration: # pylint: disable=too-few-public-methods - """Base class for IP configuration.""" + +T = TypeVar("T", bound="TargetProfile") + + +class TargetProfile(ABC): + """Base class for target profiles.""" def __init__(self, target: str) -> None: - """Init IP configuration instance.""" + """Init TargetProfile instance with the target name.""" self.target = target + @classmethod + def load(cls: type[T], path: str | Path) -> T: + """Load and verify a target profile from file and return new instance.""" + profile = load_profile(path) + + try: + new_instance = cls(**profile) + except KeyError as ex: + raise KeyError(f"Missing key in file {path}.") from ex + + new_instance.verify() + + return new_instance + + @classmethod + def load_profile(cls: type[T], target_profile: str) -> T: + """Load a target profile by name.""" + profile_file = get_profile_file(target_profile) + return cls.load(profile_file) + + def save(self, path: str | Path) -> None: + """Save this target profile to a file.""" + raise NotImplementedError("Saving target profiles is currently not supported.") + + @abstractmethod + def verify(self) -> None: + """ + Check that all attributes contain valid values etc. + + Raises a ValueError, if an issue is detected. + """ + if not self.target: + raise ValueError(f"Invalid target name: {self.target}") + @dataclass class TargetInfo: diff --git a/src/mlia/target/cortex_a/advisor.py b/src/mlia/target/cortex_a/advisor.py index 52af592..518c9f1 100644 --- a/src/mlia/target/cortex_a/advisor.py +++ b/src/mlia/target/cortex_a/advisor.py @@ -58,7 +58,9 @@ class CortexAInferenceAdvisor(DefaultInferenceAdvisor): target_profile = self.get_target_profile(context) return [ - CortexAAdvisorStartedEvent(model, CortexAConfiguration(target_profile)), + CortexAAdvisorStartedEvent( + model, CortexAConfiguration.load_profile(target_profile) + ), ] diff --git a/src/mlia/target/cortex_a/config.py b/src/mlia/target/cortex_a/config.py index b2b51ea..fd39e0a 100644 --- a/src/mlia/target/cortex_a/config.py +++ b/src/mlia/target/cortex_a/config.py @@ -1,20 +1,23 @@ -# SPDX-FileCopyrightText: Copyright 2022, Arm Limited and/or its affiliates. +# SPDX-FileCopyrightText: Copyright 2022-2023, Arm Limited and/or its affiliates. # SPDX-License-Identifier: Apache-2.0 """Cortex-A configuration.""" from __future__ import annotations -from mlia.target.config import IPConfiguration -from mlia.utils.filesystem import get_profile +from typing import Any +from mlia.target.config import TargetProfile -class CortexAConfiguration(IPConfiguration): # pylint: disable=too-few-public-methods + +class CortexAConfiguration(TargetProfile): """Cortex-A configuration.""" - def __init__(self, target_profile: str) -> None: + def __init__(self, **kwargs: Any) -> None: """Init Cortex-A target configuration.""" - target_data = get_profile(target_profile) - - target = target_data["target"] - if target != "cortex-a": - raise Exception(f"Wrong target {target} for Cortex-A configuration") + target = kwargs["target"] super().__init__(target) + + def verify(self) -> None: + """Check the parameters.""" + super().verify() + if self.target != "cortex-a": + raise ValueError(f"Wrong target {self.target} for Cortex-A configuration.") diff --git a/src/mlia/target/ethos_u/advisor.py b/src/mlia/target/ethos_u/advisor.py index 937e91c..225fd87 100644 --- a/src/mlia/target/ethos_u/advisor.py +++ b/src/mlia/target/ethos_u/advisor.py @@ -19,7 +19,6 @@ from mlia.nn.tensorflow.utils import is_tflite_model from mlia.target.ethos_u.advice_generation import EthosUAdviceProducer from mlia.target.ethos_u.advice_generation import EthosUStaticAdviceProducer from mlia.target.ethos_u.config import EthosUConfiguration -from mlia.target.ethos_u.config import get_target from mlia.target.ethos_u.data_analysis import EthosUDataAnalyzer from mlia.target.ethos_u.data_collection import EthosUOperatorCompatibility from mlia.target.ethos_u.data_collection import EthosUOptimizationPerformance @@ -40,7 +39,7 @@ class EthosUInferenceAdvisor(DefaultInferenceAdvisor): def get_collectors(self, context: Context) -> list[DataCollector]: """Return list of the data collectors.""" model = self.get_model(context) - device = self._get_device(context) + device = self._get_device_cfg(context) backends = self._get_backends(context) collectors: list[DataCollector] = [] @@ -88,17 +87,16 @@ class EthosUInferenceAdvisor(DefaultInferenceAdvisor): def get_events(self, context: Context) -> list[Event]: """Return list of the startup events.""" model = self.get_model(context) - device = self._get_device(context) + device = self._get_device_cfg(context) return [ EthosUAdvisorStartedEvent(device=device, model=model), ] - def _get_device(self, context: Context) -> EthosUConfiguration: - """Get device.""" + def _get_device_cfg(self, context: Context) -> EthosUConfiguration: + """Get device configuration.""" target_profile = self.get_target_profile(context) - - return get_target(target_profile) + return EthosUConfiguration.load_profile(target_profile) def _get_optimization_settings(self, context: Context) -> list[list[dict]]: """Get optimization settings.""" diff --git a/src/mlia/target/ethos_u/config.py b/src/mlia/target/ethos_u/config.py index 8d8f481..eb5691d 100644 --- a/src/mlia/target/ethos_u/config.py +++ b/src/mlia/target/ethos_u/config.py @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: Copyright 2022, Arm Limited and/or its affiliates. +# SPDX-FileCopyrightText: Copyright 2022-2023, Arm Limited and/or its affiliates. # SPDX-License-Identifier: Apache-2.0 """Ethos-U configuration.""" from __future__ import annotations @@ -8,36 +8,49 @@ from typing import Any from mlia.backend.vela.compiler import resolve_compiler_config from mlia.backend.vela.compiler import VelaCompilerOptions -from mlia.target.config import IPConfiguration -from mlia.utils.filesystem import get_profile +from mlia.target.config import TargetProfile from mlia.utils.filesystem import get_vela_config logger = logging.getLogger(__name__) -class EthosUConfiguration(IPConfiguration): +class EthosUConfiguration(TargetProfile): """Ethos-U configuration.""" - def __init__(self, target_profile: str) -> None: + def __init__(self, **kwargs: Any) -> None: """Init Ethos-U target configuration.""" - target_data = get_profile(target_profile) - _check_target_data_complete(target_data) - - target = target_data["target"] + target = kwargs["target"] super().__init__(target) - mac = target_data["mac"] - _check_device_options_valid(target, mac) + mac = kwargs["mac"] self.mac = mac self.compiler_options = VelaCompilerOptions( - system_config=target_data["system_config"], - memory_mode=target_data["memory_mode"], + system_config=kwargs["system_config"], + memory_mode=kwargs["memory_mode"], config_files=str(get_vela_config()), accelerator_config=f"{self.target}-{mac}", # type: ignore ) + def verify(self) -> None: + """Check the parameters.""" + super().verify() + + target_mac_ranges = { + "ethos-u55": [32, 64, 128, 256], + "ethos-u65": [256, 512], + } + + if self.target not in target_mac_ranges: + raise ValueError(f"Unsupported target: {self.target}") + + target_mac_range = target_mac_ranges[self.target] + if self.mac not in target_mac_range: + raise ValueError( + f"Mac value for selected device should be in {target_mac_range}." + ) + @property def resolved_compiler_config(self) -> dict[str, Any]: """Resolve compiler configuration.""" @@ -54,37 +67,3 @@ class EthosUConfiguration(IPConfiguration): def __repr__(self) -> str: """Return string representation.""" return f"<Ethos-U configuration target={self.target}>" - - -def get_target(target_profile: str) -> EthosUConfiguration: - """Get target instance based on provided params.""" - if not target_profile: - raise Exception("No target profile given") - - return EthosUConfiguration(target_profile) - - -def _check_target_data_complete(target_data: dict[str, Any]) -> None: - """Check if profile contains all needed data.""" - mandatory_keys = {"target", "mac", "system_config", "memory_mode"} - missing_keys = sorted(mandatory_keys - target_data.keys()) - - if missing_keys: - raise Exception(f"Mandatory fields missing from target profile: {missing_keys}") - - -def _check_device_options_valid(target: str, mac: int) -> None: - """Check if mac is valid for selected device.""" - target_mac_ranges = { - "ethos-u55": [32, 64, 128, 256], - "ethos-u65": [256, 512], - } - - if target not in target_mac_ranges: - raise Exception(f"Unsupported target: {target}") - - target_mac_range = target_mac_ranges[target] - if mac not in target_mac_range: - raise Exception( - f"Mac value for selected device should be in {target_mac_range}" - ) diff --git a/src/mlia/target/tosa/advisor.py b/src/mlia/target/tosa/advisor.py index e8aad53..5588d0f 100644 --- a/src/mlia/target/tosa/advisor.py +++ b/src/mlia/target/tosa/advisor.py @@ -66,7 +66,7 @@ class TOSAInferenceAdvisor(DefaultInferenceAdvisor): return [ TOSAAdvisorStartedEvent( model, - TOSAConfiguration(target_profile), + TOSAConfiguration.load_profile(target_profile), MetadataDisplay( TOSAMetadata("tosa-checker"), MLIAMetadata("mlia"), diff --git a/src/mlia/target/tosa/config.py b/src/mlia/target/tosa/config.py index 22805b7..826e719 100644 --- a/src/mlia/target/tosa/config.py +++ b/src/mlia/target/tosa/config.py @@ -1,19 +1,21 @@ -# SPDX-FileCopyrightText: Copyright 2022, Arm Limited and/or its affiliates. +# SPDX-FileCopyrightText: Copyright 2022-2023, Arm Limited and/or its affiliates. # SPDX-License-Identifier: Apache-2.0 """TOSA target configuration.""" -from mlia.target.config import IPConfiguration -from mlia.utils.filesystem import get_profile +from typing import Any +from mlia.target.config import TargetProfile -class TOSAConfiguration(IPConfiguration): # pylint: disable=too-few-public-methods + +class TOSAConfiguration(TargetProfile): """TOSA configuration.""" - def __init__(self, target_profile: str) -> None: + def __init__(self, **kwargs: Any) -> None: """Init configuration.""" - target_data = get_profile(target_profile) - target = target_data["target"] - - if target != "tosa": - raise Exception(f"Wrong target {target} for TOSA configuration") - + target = kwargs["target"] super().__init__(target) + + def verify(self) -> None: + """Check the parameters.""" + super().verify() + if self.target != "tosa": + raise ValueError(f"Wrong target {self.target} for TOSA configuration.") diff --git a/src/mlia/utils/filesystem.py b/src/mlia/utils/filesystem.py index 4734a84..f92629b 100644 --- a/src/mlia/utils/filesystem.py +++ b/src/mlia/utils/filesystem.py @@ -11,16 +11,9 @@ from contextlib import contextmanager from pathlib import Path from tempfile import mkstemp from tempfile import TemporaryDirectory -from typing import Any -from typing import cast from typing import Generator from typing import Iterable -try: - import tomllib -except ModuleNotFoundError: - import tomli as tomllib # type: ignore - def get_mlia_resources() -> Path: """Get the path to the resources directory.""" @@ -39,50 +32,6 @@ def get_mlia_target_profiles_dir() -> Path: return get_mlia_resources() / "target_profiles" -def get_profile_toml_file(target_profile: str | Path) -> str | Path: - """Get the target profile toml file.""" - if not target_profile: - raise Exception("Target profile is not provided") - - profile_toml_file = Path(get_mlia_target_profiles_dir() / f"{target_profile}.toml") - if not profile_toml_file.is_file(): - profile_toml_file = Path(target_profile) - - if not profile_toml_file.exists(): - raise Exception(f"File not found: {profile_toml_file}.") - return profile_toml_file - - -def get_profile(target_profile: str | Path) -> dict[str, Any]: - """Get settings for the provided target profile.""" - if not target_profile: - raise Exception("Target profile is not provided") - - toml_file = get_profile_toml_file(target_profile) - - with open(toml_file, "rb") as file: - profile = tomllib.load(file) - - return cast(dict, profile) - - -def get_builtin_supported_profile_names() -> list[str]: - """Return list of default profiles in the target profiles directory.""" - return sorted( - [ - item.stem - for item in get_mlia_target_profiles_dir().iterdir() - if item.is_file() and item.suffix == ".toml" - ] - ) - - -def get_target(target_profile: str | Path) -> str: - """Return target for the provided target_profile.""" - profile = get_profile(target_profile) - return cast(str, profile["target"]) - - @contextmanager def temp_file(suffix: str | None = None) -> Generator[Path, None, None]: """Create temp file and remove it after.""" |