aboutsummaryrefslogtreecommitdiff
path: root/tests/test_common_optimization.py
blob: bdcf034e50f8de9fd629391e2d236c4278353eef (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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
# SPDX-FileCopyrightText: Copyright 2024, Arm Limited and/or its affiliates.
# SPDX-License-Identifier: Apache-2.0
"""Tests for the common optimization module."""
from __future__ import annotations

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.common.optimization import parse_augmentations
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,
                "rewrite_parameters": {
                    "train_params": training_parameters,
                    "rewrite_specific_params": None,
                },
            }
        }
    )

    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] == {
        "train_params": training_parameters,
        "rewrite_specific_params": None,
    }
    assert fake_optimizer.invocation_count == 1


@pytest.mark.parametrize(
    "extra_args, error_to_raise, rewrite_parameter_type",
    [
        (
            {
                "optimization_targets": [
                    {
                        "optimization_type": "pruning",
                        "optimization_target": 0.5,
                        "layers_to_optimize": None,
                    }
                ],
            },
            does_not_raises(),
            type(None),
        ),
        (
            {
                "optimization_targets": [
                    {
                        "optimization_type": "rewrite",
                        "optimization_target": "fully-connected-clustering",
                    }
                ],
                "optimization_profile": load_profile(
                    "src/mlia/resources/optimization_profiles/"
                    "optimization-fully-connected-clustering.toml"
                ),
            },
            does_not_raises(),
            dict,
        ),
        (
            {
                "optimization_targets": [
                    {
                        "optimization_type": "rewrite",
                        "optimization_target": "fully-connected-sparsity",
                    }
                ],
                "optimization_profile": load_profile(
                    "src/mlia/resources/optimization_profiles/"
                    "optimization-fully-connected-pruning.toml"
                ),
            },
            does_not_raises(),
            dict,
        ),
        (
            {
                "optimization_targets": {
                    "optimization_type": "pruning",
                    "optimization_target": 0.5,
                    "layers_to_optimize": None,
                },
            },
            pytest.raises(
                TypeError, match="Optimization targets value has wrong format."
            ),
            type(None),
        ),
        (
            {"optimization_profile": [32, 1e-3, True, 48000, "cosine", 1, 0]},
            pytest.raises(
                TypeError, match="Optimization Parameter values has wrong format."
            ),
            type(None),
        ),
    ],
)
def test_add_common_optimization_params(
    extra_args: dict,
    error_to_raise: Any,
    rewrite_parameter_type: dict | None,
) -> 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"]["rewrite_parameters"] == {
                "train_params": None,
                "rewrite_specific_params": None,
            }
        else:
            if not extra_args["optimization_profile"].get("rewrite"):
                assert isinstance(
                    advisor_parameters["common_optimizations"]["rewrite_parameters"][
                        "train_params"
                    ],
                    type(None),
                )
            elif not extra_args["optimization_profile"]["rewrite"].get(
                "training_parameters"
            ):
                assert isinstance(
                    advisor_parameters["common_optimizations"]["rewrite_parameters"][
                        "train_params"
                    ],
                    type(None),
                )
            else:
                assert isinstance(
                    advisor_parameters["common_optimizations"]["rewrite_parameters"][
                        "train_params"
                    ],
                    dict,
                )

            assert isinstance(
                advisor_parameters["common_optimizations"]["rewrite_parameters"][
                    "rewrite_specific_params"
                ],
                rewrite_parameter_type,  # type: ignore
            )


@pytest.mark.parametrize(
    "augmentations, expected_output",
    [
        (
            {"gaussian_strength": 1.0, "mixup_strength": 1.0},
            (1.0, 1.0),
        ),
        (
            {"gaussian_strength": 1.0},
            (None, 1.0),
        ),
        (
            {"Wrong param": 1.0, "mixup_strength": 1.0},
            (1.0, None),
        ),
        (
            {"Wrong param1": 1.0, "Wrong param2": 1.0},
            (None, None),
        ),
        (
            "gaussian",
            (None, 1.0),
        ),
        (
            "mix_gaussian_large",
            (2.0, 1.0),
        ),
        (
            "not in presets",
            (None, None),
        ),
        (
            {"gaussian_strength": 1.0, "mixup_strength": 1.0, "mix2": 1.0},
            (1.0, 1.0),
        ),
        (
            {"gaussian_strength": "not a float", "mixup_strength": 1.0},
            (1.0, None),
        ),
        (
            None,
            (None, None),
        ),
    ],
)
def test_parse_augmentations(
    augmentations: dict | str | None, expected_output: tuple
) -> None:
    """Check that augmentation parameters in optimization_profiles are
    correctly parsed."""

    augmentation_output = parse_augmentations(augmentations)
    assert augmentation_output == expected_output