aboutsummaryrefslogtreecommitdiff
path: root/tests/mlia/test_cli_commands.py
blob: bf17339e3c9151ea879cf126fab53ef0cc991270 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# SPDX-FileCopyrightText: Copyright 2022, Arm Limited and/or its affiliates.
# SPDX-License-Identifier: Apache-2.0
"""Tests for cli.commands module."""
from pathlib import Path
from typing import Any
from typing import Optional
from unittest.mock import call
from unittest.mock import MagicMock

import pytest

from mlia.cli.commands import backend
from mlia.cli.commands import operators
from mlia.cli.commands import optimization
from mlia.cli.commands import performance
from mlia.core.context import ExecutionContext
from mlia.devices.ethosu.config import EthosUConfiguration
from mlia.devices.ethosu.performance import MemoryUsage
from mlia.devices.ethosu.performance import NPUCycles
from mlia.devices.ethosu.performance import PerformanceMetrics
from mlia.tools.metadata.common import InstallationManager


def test_operators_expected_parameters(dummy_context: ExecutionContext) -> None:
    """Test operators command wrong parameters."""
    with pytest.raises(Exception, match="Model is not provided"):
        operators(dummy_context, "ethos-u55-256")


def test_performance_unknown_target(
    dummy_context: ExecutionContext, test_tflite_model: Path
) -> None:
    """Test that command should fail if unknown target passed."""
    with pytest.raises(Exception, match="Unable to find target profile unknown"):
        performance(
            dummy_context, model=str(test_tflite_model), target_profile="unknown"
        )


@pytest.mark.parametrize(
    "target_profile, optimization_type, optimization_target, expected_error",
    [
        [
            "ethos-u55-256",
            None,
            "0.5",
            pytest.raises(Exception, match="Optimization type is not provided"),
        ],
        [
            "ethos-u65-512",
            "unknown",
            "16",
            pytest.raises(Exception, match="Unsupported optimization type: unknown"),
        ],
        [
            "ethos-u55-256",
            "pruning",
            None,
            pytest.raises(Exception, match="Optimization target is not provided"),
        ],
        [
            "ethos-u65-512",
            "clustering",
            None,
            pytest.raises(Exception, match="Optimization target is not provided"),
        ],
        [
            "unknown",
            "clustering",
            "16",
            pytest.raises(Exception, match="Unable to find target profile unknown"),
        ],
    ],
)
def test_opt_expected_parameters(
    dummy_context: ExecutionContext,
    target_profile: str,
    monkeypatch: pytest.MonkeyPatch,
    optimization_type: str,
    optimization_target: str,
    expected_error: Any,
    test_keras_model: Path,
) -> None:
    """Test that command should fail if no or unknown optimization type provided."""
    mock_performance_estimation(monkeypatch)

    with expected_error:
        optimization(
            ctx=dummy_context,
            target_profile=target_profile,
            model=str(test_keras_model),
            optimization_type=optimization_type,
            optimization_target=optimization_target,
        )


@pytest.mark.parametrize(
    "target_profile, optimization_type, optimization_target",
    [
        ["ethos-u55-256", "pruning", "0.5"],
        ["ethos-u65-512", "clustering", "32"],
        ["ethos-u55-256", "pruning,clustering", "0.5,32"],
    ],
)
def test_opt_valid_optimization_target(
    target_profile: str,
    dummy_context: ExecutionContext,
    optimization_type: str,
    optimization_target: str,
    monkeypatch: pytest.MonkeyPatch,
    test_keras_model: Path,
) -> None:
    """Test that command should not fail with valid optimization targets."""
    mock_performance_estimation(monkeypatch)

    optimization(
        ctx=dummy_context,
        target_profile=target_profile,
        model=str(test_keras_model),
        optimization_type=optimization_type,
        optimization_target=optimization_target,
    )


def mock_performance_estimation(monkeypatch: pytest.MonkeyPatch) -> None:
    """Mock performance estimation."""
    metrics = PerformanceMetrics(
        EthosUConfiguration("ethos-u55-256"),
        NPUCycles(1, 2, 3, 4, 5, 6),
        MemoryUsage(1, 2, 3, 4, 5),
    )
    monkeypatch.setattr(
        "mlia.devices.ethosu.data_collection.EthosUPerformanceEstimator.estimate",
        MagicMock(return_value=metrics),
    )


@pytest.fixture(name="installation_manager_mock")
def fixture_mock_installation_manager(monkeypatch: pytest.MonkeyPatch) -> MagicMock:
    """Mock installation manager."""
    install_manager_mock = MagicMock(spec=InstallationManager)
    monkeypatch.setattr(
        "mlia.cli.commands.get_installation_manager",
        MagicMock(return_value=install_manager_mock),
    )
    return install_manager_mock


def test_backend_command_action_status(installation_manager_mock: MagicMock) -> None:
    """Test backend command "status"."""
    backend(backend_action="status")

    installation_manager_mock.show_env_details.assert_called_once()


@pytest.mark.parametrize(
    "i_agree_to_the_contained_eula, backend_name, expected_calls",
    [
        [False, None, [call(None, True)]],
        [True, None, [call(None, False)]],
        [False, "backend_name", [call("backend_name", True)]],
        [True, "backend_name", [call("backend_name", False)]],
    ],
)
def test_backend_command_action_add_downoad(
    installation_manager_mock: MagicMock,
    i_agree_to_the_contained_eula: bool,
    backend_name: Optional[str],
    expected_calls: Any,
) -> None:
    """Test backend command "install" with download option."""
    backend(
        backend_action="install",
        download=True,
        name=backend_name,
        i_agree_to_the_contained_eula=i_agree_to_the_contained_eula,
    )

    assert installation_manager_mock.download_and_install.mock_calls == expected_calls


@pytest.mark.parametrize("backend_name", [None, "backend_name"])
def test_backend_command_action_install_from_path(
    installation_manager_mock: MagicMock,
    tmp_path: Path,
    backend_name: Optional[str],
) -> None:
    """Test backend command "install" with backend path."""
    backend(backend_action="install", path=tmp_path, name=backend_name)

    installation_manager_mock.install_from(tmp_path, backend_name)


def test_backend_command_action_install_only_one_action(
    installation_manager_mock: MagicMock,  # pylint: disable=unused-argument
    tmp_path: Path,
) -> None:
    """Test that only one of action type allowed."""
    with pytest.raises(
        Exception,
        match="Please select only one action: download or "
        "provide path to the backend installation",
    ):
        backend(backend_action="install", download=True, path=tmp_path)