aboutsummaryrefslogtreecommitdiff
path: root/tests/test_common_optimization.py
blob: 341e0d2f6e54a2376173857d9eb45ef132082592 (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
# SPDX-FileCopyrightText: Copyright 2024, Arm Limited and/or its affiliates.
# SPDX-License-Identifier: Apache-2.0
"""Tests for the common optimization module."""
from contextlib import ExitStack as does_not_raises
from pathlib import Path
from typing import Any
from unittest.mock import MagicMock

import pytest

from mlia.core.context import ExecutionContext
from mlia.nn.common import Optimizer
from mlia.nn.select import OptimizationSettings
from mlia.nn.tensorflow.config import TFLiteModel
from mlia.target.common.optimization import _DEFAULT_OPTIMIZATION_TARGETS
from mlia.target.common.optimization import add_common_optimization_params
from mlia.target.common.optimization import OptimizingDataCollector
from mlia.target.config import load_profile
from mlia.target.config import TargetProfile


class FakeOptimizer(Optimizer):
    """Optimizer for testing purposes."""

    def __init__(self, optimized_model_path: Path) -> None:
        """Initialize."""
        super().__init__()
        self.optimized_model_path = optimized_model_path
        self.invocation_count = 0

    def apply_optimization(self) -> None:
        """Count the invocations."""
        self.invocation_count += 1

    def get_model(self) -> TFLiteModel:
        """Return optimized model."""
        return TFLiteModel(self.optimized_model_path)

    def optimization_config(self) -> str:
        """Return something: doesn't matter, not used."""
        return ""


def test_optimizing_data_collector(
    test_keras_model: Path,
    test_tflite_model: Path,
    monkeypatch: pytest.MonkeyPatch,
) -> None:
    """Test OptimizingDataCollector, base support for various targets."""
    optimizations = [
        [
            {"optimization_type": "fake", "optimization_target": 42},
        ]
    ]
    training_parameters = {"batch_size": 32, "show_progress": False}
    context = ExecutionContext(
        config_parameters={
            "common_optimizations": {
                "optimizations": optimizations,
                "training_parameters": training_parameters,
            }
        }
    )

    target_profile = MagicMock(spec=TargetProfile)

    fake_optimizer = FakeOptimizer(test_tflite_model)

    monkeypatch.setattr(
        "mlia.target.common.optimization.get_optimizer",
        MagicMock(return_value=fake_optimizer),
    )

    collector = OptimizingDataCollector(test_keras_model, target_profile)

    optimize_model_mock = MagicMock(side_effect=collector.optimize_model)
    monkeypatch.setattr(
        "mlia.target.common.optimization.OptimizingDataCollector.optimize_model",
        optimize_model_mock,
    )
    opt_settings = [
        [
            OptimizationSettings(
                item.get("optimization_type"),  # type: ignore
                item.get("optimization_target"),  # type: ignore
                item.get("layers_to_optimize"),  # type: ignore
                item.get("dataset"),  # type: ignore
            )
            for item in opt_configuration
        ]
        for opt_configuration in optimizations
    ]

    collector.set_context(context)
    collector.collect_data()
    assert optimize_model_mock.call_args.args[0] == opt_settings[0]
    assert optimize_model_mock.call_args.args[1] == training_parameters
    assert fake_optimizer.invocation_count == 1


@pytest.mark.parametrize(
    "extra_args, error_to_raise",
    [
        (
            {
                "optimization_targets": [
                    {
                        "optimization_type": "pruning",
                        "optimization_target": 0.5,
                        "layers_to_optimize": None,
                    }
                ],
            },
            does_not_raises(),
        ),
        (
            {
                "optimization_profile": load_profile(
                    "src/mlia/resources/optimization_profiles/optimization.toml"
                )
            },
            does_not_raises(),
        ),
        (
            {
                "optimization_targets": {
                    "optimization_type": "pruning",
                    "optimization_target": 0.5,
                    "layers_to_optimize": None,
                },
            },
            pytest.raises(
                TypeError, match="Optimization targets value has wrong format."
            ),
        ),
        (
            {"optimization_profile": [32, 1e-3, True, 48000, "cosine", 1, 0]},
            pytest.raises(
                TypeError, match="Training Parameter values has wrong format."
            ),
        ),
    ],
)
def test_add_common_optimization_params(extra_args: dict, error_to_raise: Any) -> None:
    """Test to check that optimization_targets and optimization_profiles are
    correctly parsed."""
    advisor_parameters: dict = {}

    with error_to_raise:
        add_common_optimization_params(advisor_parameters, extra_args)
        if not extra_args.get("optimization_targets"):
            assert advisor_parameters["common_optimizations"]["optimizations"] == [
                _DEFAULT_OPTIMIZATION_TARGETS
            ]
        else:
            assert advisor_parameters["common_optimizations"]["optimizations"] == [
                extra_args["optimization_targets"]
            ]

        if not extra_args.get("optimization_profile"):
            assert (
                advisor_parameters["common_optimizations"]["training_parameters"]
                is None
            )
        else:
            assert (
                advisor_parameters["common_optimizations"]["training_parameters"]
                == extra_args["optimization_profile"]["training"]
            )