From 5800fc990ed1e36ce7d06670f911fbb12a0ec771 Mon Sep 17 00:00:00 2001 From: Raul Farkas Date: Tue, 29 Nov 2022 13:29:04 +0000 Subject: MLIA-650 Implement new CLI changes Breaking change in the CLI and API: Sub-commands "optimization", "operators", and "performance" were replaced by "check", which incorporates compatibility and performance checks, and "optimize" which is used for optimization. "get_advice" API was adapted to these CLI changes. API changes: * Remove previous advice category "all" that would perform all three operations (when possible). Replace them with the ability to pass a set of the advice categories. * Update api.get_advice method docstring to reflect new changes. * Set default advice category to COMPATIBILITY * Update core.common.AdviceCategory by changing the "OPERATORS" advice category to "COMPATIBILITY" and removing "ALL" enum type. Update all subsequent methods that previously used "OPERATORS" to use "COMPATIBILITY". * Update core.context.ExecutionContext to have "COMPATIBILITY" as default advice_category instead of "ALL". * Remove api.generate_supported_operators_report and all related functions from cli.commands, cli.helpers, cli.main, cli.options, core.helpers * Update tests to reflect new API changes. CLI changes: * Update README.md to contain information on the new CLI * Remove the ability to generate supported operators support from MLIA CLI * Replace `mlia ops` and `mlia perf` with the new `mlia check` command that can be used to perform both operations. * Replace `mlia opt` with the new `mlia optimize` command. * Replace `--evaluate-on` flag with `--backend` flag * Replace `--verbose` flag with `--debug` flag (no behaviour change). * Remove the ability for the user to select MLIA working directory. Create and use a temporary directory in /temp instead. * Change behaviour of `--output` flag to not format the content automatically based on file extension anymore. Instead it will simply redirect to a file. * Add the `--json` flag to specfy that the format of the output should be json. * Add command validators that are used to validate inter-dependent flags (e.g. backend validation based on target_profile). * Add support for selecting built-in backends for both `check` and `optimize` commands. * Add new unit tests and update old ones to test the new CLI changes. * Update RELEASES.md * Update copyright notice Change-Id: Ia6340797c7bee3acbbd26601950e5a16ad5602db --- src/mlia/core/context.py | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) (limited to 'src/mlia/core/context.py') diff --git a/src/mlia/core/context.py b/src/mlia/core/context.py index a4737bb..94aa885 100644 --- a/src/mlia/core/context.py +++ b/src/mlia/core/context.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 """Context module. @@ -10,6 +10,7 @@ parameters). from __future__ import annotations import logging +import tempfile from abc import ABC from abc import abstractmethod from pathlib import Path @@ -54,7 +55,7 @@ class Context(ABC): @property @abstractmethod - def advice_category(self) -> AdviceCategory: + def advice_category(self) -> set[AdviceCategory]: """Return advice category.""" @property @@ -71,7 +72,7 @@ class Context(ABC): def update( self, *, - advice_category: AdviceCategory, + advice_category: set[AdviceCategory], event_handlers: list[EventHandler], config_parameters: Mapping[str, Any], ) -> None: @@ -79,11 +80,11 @@ class Context(ABC): def category_enabled(self, category: AdviceCategory) -> bool: """Check if category enabled.""" - return category == self.advice_category + return category in self.advice_category def any_category_enabled(self, *categories: AdviceCategory) -> bool: """Return true if any category is enabled.""" - return self.advice_category in categories + return all(category in self.advice_category for category in categories) def register_event_handlers(self) -> None: """Register event handlers.""" @@ -96,7 +97,7 @@ class ExecutionContext(Context): def __init__( self, *, - advice_category: AdviceCategory = AdviceCategory.ALL, + advice_category: set[AdviceCategory] = None, config_parameters: Mapping[str, Any] | None = None, working_dir: str | Path | None = None, event_handlers: list[EventHandler] | None = None, @@ -108,7 +109,7 @@ class ExecutionContext(Context): ) -> None: """Init execution context. - :param advice_category: requested advice category + :param advice_category: requested advice categories :param config_parameters: dictionary like object with input parameters :param working_dir: path to the directory that will be used as a place to store temporary files, logs, models. If not provided then @@ -124,13 +125,13 @@ class ExecutionContext(Context): :param action_resolver: instance of the action resolver that could make advice actionable """ - self._advice_category = advice_category + self._advice_category = advice_category or {AdviceCategory.COMPATIBILITY} self._config_parameters = config_parameters - self._working_dir_path = Path.cwd() if working_dir: self._working_dir_path = Path(working_dir) - self._working_dir_path.mkdir(exist_ok=True) + else: + self._working_dir_path = generate_temp_workdir() self._event_handlers = event_handlers self._event_publisher = event_publisher or DefaultEventPublisher() @@ -140,12 +141,17 @@ class ExecutionContext(Context): self._action_resolver = action_resolver or APIActionResolver() @property - def advice_category(self) -> AdviceCategory: + def working_dir(self) -> Path: + """Return working dir path.""" + return self._working_dir_path + + @property + def advice_category(self) -> set[AdviceCategory]: """Return advice category.""" return self._advice_category @advice_category.setter - def advice_category(self, advice_category: AdviceCategory) -> None: + def advice_category(self, advice_category: set[AdviceCategory]) -> None: """Setter for the advice category.""" self._advice_category = advice_category @@ -194,7 +200,7 @@ class ExecutionContext(Context): def update( self, *, - advice_category: AdviceCategory, + advice_category: set[AdviceCategory], event_handlers: list[EventHandler], config_parameters: Mapping[str, Any], ) -> None: @@ -206,7 +212,9 @@ class ExecutionContext(Context): def __str__(self) -> str: """Return string representation.""" category = ( - "" if self.advice_category is None else self.advice_category.name + "" + if self.advice_category is None + else {x.name for x in self.advice_category} ) return ( @@ -215,3 +223,9 @@ class ExecutionContext(Context): f"config_parameters={self.config_parameters}, " f"verbose={self.verbose}" ) + + +def generate_temp_workdir() -> Path: + """Generate a temporary working dir and returns the path.""" + working_dir = tempfile.mkdtemp(suffix=None, prefix="mlia-", dir=None) + return Path(working_dir) -- cgit v1.2.1