erik.andersson@arm.com | ad45f79 | 2021-02-03 10:20:16 +0100 | [diff] [blame] | 1 | # Copyright (C) 2020-2021 Arm Limited or its affiliates. All rights reserved. |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 2 | # |
| 3 | # SPDX-License-Identifier: Apache-2.0 |
| 4 | # |
| 5 | # Licensed under the Apache License, Version 2.0 (the License); you may |
| 6 | # not use this file except in compliance with the License. |
| 7 | # You may obtain a copy of the License at |
| 8 | # |
| 9 | # www.apache.org/licenses/LICENSE-2.0 |
| 10 | # |
| 11 | # Unless required by applicable law or agreed to in writing, software |
| 12 | # distributed under the License is distributed on an AS IS BASIS, WITHOUT |
| 13 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | # See the License for the specific language governing permissions and |
| 15 | # limitations under the License. |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 16 | # Description: |
| 17 | # Main entry point for the Vela compiler. |
| 18 | # |
| 19 | # Provides command line interface, options parsing, and network loading. Before calling the compiler driver. |
Diego Russo | e8a1045 | 2020-04-21 17:39:10 +0100 | [diff] [blame] | 20 | import argparse |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 21 | import glob |
Tim Hall | 1bd531d | 2020-11-01 20:59:36 +0000 | [diff] [blame] | 22 | import os |
Diego Russo | ea6111a | 2020-04-14 18:41:58 +0100 | [diff] [blame] | 23 | import sys |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 24 | import time |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 25 | |
erik.andersson@arm.com | ad45f79 | 2021-02-03 10:20:16 +0100 | [diff] [blame] | 26 | import flatbuffers |
| 27 | |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 28 | from . import architecture_features |
Diego Russo | e8a1045 | 2020-04-21 17:39:10 +0100 | [diff] [blame] | 29 | from . import compiler_driver |
| 30 | from . import model_reader |
Diqing Zhong | 5e5a784 | 2021-08-16 17:24:09 +0200 | [diff] [blame] | 31 | from . import rawdata_writer |
Diego Russo | e8a1045 | 2020-04-21 17:39:10 +0100 | [diff] [blame] | 32 | from . import scheduler |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 33 | from . import stats_writer |
| 34 | from . import tflite_writer |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 35 | from ._version import __version__ |
Louis Verhaard | 11831ce | 2020-11-18 18:53:24 +0100 | [diff] [blame] | 36 | from .api import API_VERSION |
Tim Hall | e6ccd87 | 2020-11-09 16:46:37 +0000 | [diff] [blame] | 37 | from .debug_database import DebugDatabase |
Louis Verhaard | 7db7896 | 2020-05-25 15:05:26 +0200 | [diff] [blame] | 38 | from .errors import InputFileError |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 39 | from .errors import VelaError |
Tim Hall | cda4fcb | 2022-05-19 12:36:58 +0100 | [diff] [blame] | 40 | from .hillclimb_allocation import HillClimbAllocator |
Jonas Ohlsson | 45e653d | 2021-07-26 16:13:12 +0200 | [diff] [blame] | 41 | from .nn_graph import NetworkType |
Diego Russo | e8a1045 | 2020-04-21 17:39:10 +0100 | [diff] [blame] | 42 | from .nn_graph import TensorAllocator |
Diego Russo | ea6111a | 2020-04-14 18:41:58 +0100 | [diff] [blame] | 43 | from .tensor import MemArea |
Jacob Bohlin | 0628a8c | 2020-08-28 13:25:14 +0200 | [diff] [blame] | 44 | from .tensor import Tensor |
erik.andersson@arm.com | ad45f79 | 2021-02-03 10:20:16 +0100 | [diff] [blame] | 45 | from .tflite.Model import Model |
Michael McGeagh | 837dc1b | 2020-11-10 12:38:25 +0000 | [diff] [blame] | 46 | from .tflite_mapping import builtin_operator_map |
Tim Hall | a3fe665 | 2022-03-03 17:43:16 +0000 | [diff] [blame] | 47 | from .tflite_mapping import builtin_operator_name_map |
Jonas Ohlsson | 45e653d | 2021-07-26 16:13:12 +0200 | [diff] [blame] | 48 | from .tflite_model_semantic import TFLiteSemantic |
| 49 | from .tflite_supported_operators import TFLiteSupportedOperators |
| 50 | from .tosa_model_semantic import TosaSemantic |
| 51 | from .tosa_supported_operators import TosaSupportedOperators |
Louis Verhaard | 5207830 | 2020-11-18 13:35:06 +0100 | [diff] [blame] | 52 | from ethosu.vela.architecture_features import ArchitectureFeatures |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 53 | |
Rickard Bolin | 7ce6b32 | 2022-06-02 09:30:33 +0000 | [diff] [blame] | 54 | CONFIG_FILES_PATH = os.path.normpath(os.path.join(__file__, "..", "..", "config_files")) |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 55 | |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 56 | |
Tim Hall | e6ccd87 | 2020-11-09 16:46:37 +0000 | [diff] [blame] | 57 | def process(input_name, enable_debug_db, arch, model_reader_options, compiler_options, scheduler_options): |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 58 | if compiler_options.timing: |
| 59 | start = time.time() |
| 60 | |
Tim Hall | e6ccd87 | 2020-11-09 16:46:37 +0000 | [diff] [blame] | 61 | os.makedirs(compiler_options.output_dir, exist_ok=True) |
| 62 | output_basename = os.path.join(compiler_options.output_dir, os.path.splitext(os.path.basename(input_name))[0]) |
| 63 | DebugDatabase.show_warnings = enable_debug_db |
| 64 | |
Patrik Gustavsson | 8f1f9aa | 2021-06-28 07:41:58 +0200 | [diff] [blame] | 65 | nng, network_type = model_reader.read_model(input_name, model_reader_options) |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 66 | |
| 67 | if not nng: |
Michael McGeagh | 7a6f843 | 2020-12-02 15:29:22 +0000 | [diff] [blame] | 68 | raise InputFileError(input_name, "Input file could not be read") |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 69 | |
| 70 | if compiler_options.verbose_operators: |
| 71 | nng.print_operators() |
| 72 | |
| 73 | if compiler_options.timing: |
| 74 | stop = time.time() |
| 75 | print("Model reading took %f s" % (stop - start)) |
| 76 | start = time.time() |
| 77 | |
Patrik Gustavsson | 8f1f9aa | 2021-06-28 07:41:58 +0200 | [diff] [blame] | 78 | compiler_driver.compiler_driver(nng, arch, compiler_options, scheduler_options, network_type) |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 79 | |
Tim Hall | e6ccd87 | 2020-11-09 16:46:37 +0000 | [diff] [blame] | 80 | summary_csv_file = "{0}_summary_{1}.csv".format(output_basename, arch.system_config) |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 81 | stats_writer.write_summary_metrics_csv(nng, summary_csv_file, arch) |
| 82 | |
Fredrik Svedberg | f5c07c4 | 2021-04-23 14:36:42 +0200 | [diff] [blame] | 83 | stats_writer.print_performance_metrics( |
| 84 | nng, |
| 85 | show_cpu_operations=compiler_options.show_cpu_operations, |
| 86 | verbose_weights=compiler_options.verbose_weights, |
| 87 | arch=arch, |
| 88 | ) |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 89 | |
Diqing Zhong | 5e5a784 | 2021-08-16 17:24:09 +0200 | [diff] [blame] | 90 | output_tfl_filename = output_basename + "_vela.tflite" |
Patrik Gustavsson | b081d67 | 2021-08-25 13:49:25 +0200 | [diff] [blame] | 91 | if input_name.endswith(".tflite"): |
Diqing Zhong | 5e5a784 | 2021-08-16 17:24:09 +0200 | [diff] [blame] | 92 | tflite_writer.write_tflite(nng, output_tfl_filename) |
Patrik Gustavsson | c74682c | 2021-08-17 14:26:38 +0200 | [diff] [blame] | 93 | if input_name.endswith(".tosa"): |
Diqing Zhong | 5e5a784 | 2021-08-16 17:24:09 +0200 | [diff] [blame] | 94 | rawdata_writer.write_rawdata_output(nng, arch, output_basename) |
Tim Hall | e6ccd87 | 2020-11-09 16:46:37 +0000 | [diff] [blame] | 95 | |
| 96 | if enable_debug_db: |
Diqing Zhong | 5e5a784 | 2021-08-16 17:24:09 +0200 | [diff] [blame] | 97 | file_offsets = calculate_operator_file_offsets(output_tfl_filename) |
erik.andersson@arm.com | ad45f79 | 2021-02-03 10:20:16 +0100 | [diff] [blame] | 98 | for idx, offset in enumerate(sorted(file_offsets)): |
| 99 | sg = find_subgraph_with_command_stream_order(nng, idx) |
| 100 | if sg is not None: |
| 101 | DebugDatabase.set_stream_offset(sg, offset) |
Tim Hall | e6ccd87 | 2020-11-09 16:46:37 +0000 | [diff] [blame] | 102 | debug_filename = output_basename + "_debug.xml" |
Diqing Zhong | 5e5a784 | 2021-08-16 17:24:09 +0200 | [diff] [blame] | 103 | DebugDatabase.write(debug_filename, input_name, output_tfl_filename) |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 104 | |
| 105 | if compiler_options.timing: |
| 106 | stop = time.time() |
| 107 | print("Compiler driver took %f s" % (stop - start)) |
| 108 | |
| 109 | return nng |
| 110 | |
| 111 | |
erik.andersson@arm.com | ad45f79 | 2021-02-03 10:20:16 +0100 | [diff] [blame] | 112 | def find_subgraph_with_command_stream_order(nng, idx): |
| 113 | for sg in nng.subgraphs: |
| 114 | if sg.generated_stream_id == idx: |
| 115 | return sg |
| 116 | return None |
| 117 | |
| 118 | |
| 119 | def calculate_operator_file_offsets(name: str): |
| 120 | # Read the vela optimized tflite file |
| 121 | with open(name, "rb") as f: |
| 122 | buf = bytearray(f.read()) |
| 123 | # Calculate the file offsets for each custom operator |
| 124 | file_offsets = [] |
| 125 | model = Model.GetRootAsModel(buf, 0) |
| 126 | for idx in range(model.SubgraphsLength()): # However only one subgraph is supported as of now |
| 127 | sg = model.Subgraphs(idx) |
| 128 | for idx in range(sg.OperatorsLength()): |
| 129 | operator = sg.Operators(idx) |
| 130 | if model.OperatorCodes(operator.OpcodeIndex()).CustomCode() is not None: |
| 131 | tensor_idx = operator.Inputs(0) |
| 132 | tensor = sg.Tensors(tensor_idx) |
| 133 | buffer = model.Buffers(tensor.Buffer()) |
| 134 | offset = flatbuffers.number_types.UOffsetTFlags.py_type(buffer._tab.Offset(4)) |
| 135 | file_offsets.append(buffer._tab.Vector(offset)) |
| 136 | return file_offsets |
| 137 | |
| 138 | |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 139 | def print_subgraph_io_summary(nng): |
| 140 | """Print a summary of all the input and output tensor sizes for all subgraphs. |
| 141 | Also displays the total tensor size and the memory used area for sram. |
| 142 | """ |
| 143 | |
| 144 | print("Subgraph IO Summary") |
| 145 | print("-------------------") |
James Ward | 9338978 | 2021-10-14 12:58:02 +0100 | [diff] [blame] | 146 | print(f"NNG: {nng.name}") |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 147 | max_sg_size = 0 |
| 148 | for sg in reversed(nng.subgraphs): |
James Ward | 9338978 | 2021-10-14 12:58:02 +0100 | [diff] [blame] | 149 | print(f" NNG Subgraph: {sg.name} = {sg.placement}") |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 150 | sg_size = 0 |
| 151 | |
James Ward | 9338978 | 2021-10-14 12:58:02 +0100 | [diff] [blame] | 152 | if hasattr(sg, "scratch_tensor") and sg.scratch_tensor is not None: |
| 153 | sg_tensors = sg.input_tensors + [sg.scratch_tensor] + sg.output_tensors |
| 154 | else: |
| 155 | sg_tensors = sg.input_tensors + sg.output_tensors |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 156 | |
James Ward | 9338978 | 2021-10-14 12:58:02 +0100 | [diff] [blame] | 157 | for tens in sg_tensors: |
| 158 | if tens in sg.input_tensors: |
| 159 | tens_dir = "In" |
| 160 | elif tens in sg.output_tensors: |
| 161 | tens_dir = "Out" |
| 162 | else: |
| 163 | tens_dir = "In/Out" |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 164 | |
James Ward | 9338978 | 2021-10-14 12:58:02 +0100 | [diff] [blame] | 165 | size = tens.elements() * tens.element_size() / 1024.0 |
| 166 | sg_size = sg_size + size |
| 167 | print(f" Tensor [{tens_dir}]: {tens.name} = {size} KiB") |
| 168 | |
| 169 | print(f" Total Size = {sg_size} KiB") |
| 170 | print(f" SRAM Memory Used = {sg.memory_used.get(MemArea.Sram, 0) / 1024.0} KiB") |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 171 | max_sg_size = max(sg_size, max_sg_size) |
| 172 | |
James Ward | 9338978 | 2021-10-14 12:58:02 +0100 | [diff] [blame] | 173 | print(f" Maximum NNG Subgraph Size = {max_sg_size} KiB") |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 174 | |
| 175 | |
Michael McGeagh | 837dc1b | 2020-11-10 12:38:25 +0000 | [diff] [blame] | 176 | def generate_supported_ops(): |
Jonas Ohlsson | 0957e3e | 2021-09-01 15:57:21 +0200 | [diff] [blame] | 177 | # Exclude network type from generation by adding value to exclude list. |
| 178 | # To easily exclude NetworkType from generated documentation. |
| 179 | exclude_generation_network_type_value = [NetworkType.TOSA.value] |
| 180 | |
Michael McGeagh | 837dc1b | 2020-11-10 12:38:25 +0000 | [diff] [blame] | 181 | lines = [ |
| 182 | "# Supported Ops", |
| 183 | "", |
| 184 | "This file was automatically generated by Vela using the `--supported-ops-report` parameter. ", |
| 185 | f"Vela version: `{__version__}`", |
| 186 | "", |
Michael McGeagh | 54a6111 | 2020-11-24 14:58:51 +0000 | [diff] [blame] | 187 | "This file complies with", |
| 188 | "[**Gitiles Markdown syntax**](https://github.com/google/gitiles/blob/master/Documentation/markdown.md)", |
Michael McGeagh | 837dc1b | 2020-11-10 12:38:25 +0000 | [diff] [blame] | 189 | "", |
Jonas Ohlsson | 45e653d | 2021-07-26 16:13:12 +0200 | [diff] [blame] | 190 | "Summary table of constraints for:", |
Michael McGeagh | 837dc1b | 2020-11-10 12:38:25 +0000 | [diff] [blame] | 191 | ] |
Jonas Ohlsson | 45e653d | 2021-07-26 16:13:12 +0200 | [diff] [blame] | 192 | |
| 193 | for network_type in NetworkType: |
Jonas Ohlsson | 0957e3e | 2021-09-01 15:57:21 +0200 | [diff] [blame] | 194 | if network_type.value in exclude_generation_network_type_value: |
| 195 | continue |
| 196 | |
Jonas Ohlsson | 45e653d | 2021-07-26 16:13:12 +0200 | [diff] [blame] | 197 | lines += [ |
| 198 | f"- [{network_type.name}](#{network_type.name.lower()}-summary-table)", |
| 199 | ] |
| 200 | |
| 201 | for network_type in NetworkType: |
Jonas Ohlsson | 0957e3e | 2021-09-01 15:57:21 +0200 | [diff] [blame] | 202 | if network_type.value in exclude_generation_network_type_value: |
| 203 | continue |
| 204 | |
Michael McGeagh | 837dc1b | 2020-11-10 12:38:25 +0000 | [diff] [blame] | 205 | lines += [ |
| 206 | "", |
Jonas Ohlsson | 45e653d | 2021-07-26 16:13:12 +0200 | [diff] [blame] | 207 | f"## {network_type.name} Summary Table", |
Michael McGeagh | 837dc1b | 2020-11-10 12:38:25 +0000 | [diff] [blame] | 208 | "", |
| 209 | ] |
Jonas Ohlsson | 45e653d | 2021-07-26 16:13:12 +0200 | [diff] [blame] | 210 | if network_type == NetworkType.TFLite: |
| 211 | lines += [ |
| 212 | "The table below contains TFLite operators that can be placed on the Ethos-U NPU. ", |
| 213 | "If the constraints are not met, then that operator will be scheduled on the CPU instead. ", |
| 214 | "For any other TFLite operator not listed, will be left untouched and scheduled on the CPU. ", |
| 215 | "Please check the supported operator list for your chosen runtime for further information.", |
| 216 | "", |
| 217 | "| Operator | TFLite Constraints |", |
| 218 | "| --- | --- |", |
| 219 | ] |
| 220 | semantic_checker = TFLiteSemantic() |
| 221 | supported = TFLiteSupportedOperators() |
| 222 | elif network_type == NetworkType.TOSA: |
| 223 | lines += [ |
| 224 | "The table below contains TOSA operators that can be placed on the Ethos-U NPU. ", |
| 225 | "Note: There is limited support for compiling a TOSA neural network (EXPERIMENTAL). ", |
| 226 | "The related constraints have not yet been populated in the list.", |
| 227 | "", |
| 228 | "| Operator | TOSA Constraints |", |
| 229 | "| --- | --- |", |
| 230 | ] |
| 231 | semantic_checker = TosaSemantic() |
| 232 | supported = TosaSupportedOperators() |
| 233 | else: |
| 234 | raise ValueError |
| 235 | |
| 236 | op_constraint_links = [] |
Tim Hall | a3fe665 | 2022-03-03 17:43:16 +0000 | [diff] [blame] | 237 | op_list = sorted(((op, builtin_operator_name_map[op]) for op in builtin_operator_map), key=lambda x: x[1]) |
Jonas Ohlsson | 45e653d | 2021-07-26 16:13:12 +0200 | [diff] [blame] | 238 | for op, name in op_list: |
| 239 | internal_op = builtin_operator_map[op][0] |
| 240 | if internal_op in TFLiteSupportedOperators.supported_operators: |
| 241 | links = f"[Generic](#{network_type.name.lower()}-generic-constraints)" |
| 242 | if ( |
| 243 | internal_op in supported.specific_constraints |
| 244 | or internal_op in semantic_checker.specific_constraints |
| 245 | ): |
| 246 | links += f", [Specific](#{network_type.name.lower()}-{name.lower()}-constraints)" |
| 247 | op_constraint_links.append((internal_op, name)) |
| 248 | lines.append(f"| {name} | {links} |") |
| 249 | lines += [ |
| 250 | "", |
| 251 | f"### {network_type.name} Generic Constraints", |
| 252 | "", |
| 253 | "This is a list of constraints that all NPU operators must satisfy in order to be scheduled on the NPU.", |
| 254 | "", |
| 255 | ] |
| 256 | for constraint in semantic_checker.generic_constraints: |
Michael McGeagh | 837dc1b | 2020-11-10 12:38:25 +0000 | [diff] [blame] | 257 | # Markdown needs two spaces at the end of a line to render it as a separate line |
| 258 | reason = constraint.__doc__.replace("\n", " \n") |
| 259 | lines.append(f"- {reason}") |
Jonas Ohlsson | 45e653d | 2021-07-26 16:13:12 +0200 | [diff] [blame] | 260 | for constraint in supported.generic_constraints: |
| 261 | # Markdown needs two spaces at the end of a line to render it as a separate line |
| 262 | reason = constraint.__doc__.replace("\n", " \n") |
| 263 | lines.append(f"- {reason}") |
| 264 | for op, name in op_constraint_links: |
| 265 | lines += [ |
| 266 | "", |
| 267 | f"### {network_type.name} {name} Constraints", |
| 268 | "", |
| 269 | f"This is a list of constraints that the {name} operator must satisfy in order to be scheduled on the" |
| 270 | " NPU.", |
| 271 | "", |
| 272 | ] |
| 273 | for constraint in semantic_checker.specific_constraints[op]: |
| 274 | # Markdown needs two spaces at the end of a line to render it as a separate line |
| 275 | reason = constraint.__doc__.replace("\n", " \n") |
| 276 | lines.append(f"- {reason}") |
| 277 | for constraint in supported.specific_constraints[op]: |
| 278 | # Markdown needs two spaces at the end of a line to render it as a separate line |
| 279 | reason = constraint.__doc__.replace("\n", " \n") |
| 280 | lines.append(f"- {reason}") |
Michael McGeagh | 837dc1b | 2020-11-10 12:38:25 +0000 | [diff] [blame] | 281 | |
| 282 | # Note. this will generate the file in the CWD |
| 283 | filepath = os.path.join(os.getcwd(), "SUPPORTED_OPS.md") |
| 284 | with open(filepath, "wt") as md: |
| 285 | md.writelines(line + "\n" for line in lines) |
| 286 | print(f"Report file: {filepath}") |
| 287 | |
| 288 | |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 289 | def list_config_files(): |
Rickard Bolin | 9b8b448 | 2022-05-24 07:43:03 +0000 | [diff] [blame] | 290 | print("Available config files:") |
| 291 | path_length = len(CONFIG_FILES_PATH + os.path.sep) |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 292 | for config in glob.glob(os.path.join(CONFIG_FILES_PATH, "*", "*.ini")): |
Rickard Bolin | 9b8b448 | 2022-05-24 07:43:03 +0000 | [diff] [blame] | 293 | print(config[path_length:]) |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 294 | |
| 295 | |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 296 | def main(args=None): |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 297 | try: |
| 298 | if args is None: |
| 299 | args = sys.argv[1:] |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 300 | |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 301 | parser = argparse.ArgumentParser(prog="vela", description="Neural network model compiler for Arm Ethos-U NPUs") |
| 302 | parser.add_argument("--version", action="version", version=__version__) |
| 303 | parser.add_argument( |
| 304 | "--api-version", action="version", version=API_VERSION, help="Displays the version of the external API." |
| 305 | ) |
| 306 | parser.add_argument( |
| 307 | "--supported-ops-report", |
| 308 | action="store_true", |
| 309 | help="Generate the SUPPORTED_OPS.md file in the current working directory and exit", |
Tim Hall | b9b515c | 2020-11-01 21:27:19 +0000 | [diff] [blame] | 310 | ) |
Jacob Bohlin | 0628a8c | 2020-08-28 13:25:14 +0200 | [diff] [blame] | 311 | |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 312 | parser.add_argument( |
| 313 | "--list-config-files", |
| 314 | action="store_true", |
| 315 | help=( |
| 316 | "Display all available configurations in the `config_files` folder and exit. To select config file, " |
| 317 | "use the --config argument with one of the listed config files (For example: --config Arm/vela.ini )" |
| 318 | ), |
| 319 | ) |
| 320 | |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 321 | # set network nargs to be optional to allow the support-ops-report CLI option to be used standalone |
| 322 | parser.add_argument( |
| 323 | "network", |
| 324 | metavar="NETWORK", |
| 325 | type=str, |
| 326 | default=None, |
| 327 | nargs="?", |
| 328 | help="Filename of the input TensorFlow Lite for Microcontrollers network", |
| 329 | ) |
| 330 | parser.add_argument( |
| 331 | "--output-dir", type=str, default="output", help="Output directory to write files to (default: %(default)s)" |
| 332 | ) |
| 333 | parser.add_argument( |
| 334 | "--enable-debug-db", |
| 335 | action="store_true", |
| 336 | default=None, |
| 337 | help="Enables the calculation and writing of a network debug database to output directory", |
| 338 | ) |
| 339 | parser.add_argument( |
| 340 | "--config", |
| 341 | type=str, |
| 342 | action="append", |
| 343 | help="Vela configuration file(s) in Python ConfigParser .ini file format", |
| 344 | ) |
| 345 | parser.add_argument("--verbose-all", action="store_true", help="Enable all verbose options") |
| 346 | parser.add_argument( |
| 347 | "--verbose-config", action="store_true", help="Verbose system configuration and memory mode" |
| 348 | ) |
| 349 | parser.add_argument("--verbose-graph", action="store_true", help="Verbose graph rewriter") |
| 350 | parser.add_argument("--verbose-quantization", action="store_true", help="Verbose quantization") |
| 351 | parser.add_argument("--verbose-packing", action="store_true", help="Verbose pass packing") |
| 352 | parser.add_argument("--verbose-tensor-purpose", action="store_true", help="Verbose tensor purpose") |
| 353 | parser.add_argument("--verbose-tensor-format", action="store_true", help="Verbose tensor format") |
| 354 | parser.add_argument("--verbose-schedule", action="store_true", help="Verbose schedule") |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 355 | parser.add_argument("--verbose-allocation", action="store_true", help="Verbose tensor allocation") |
| 356 | parser.add_argument( |
| 357 | "--verbose-high-level-command-stream", action="store_true", help="Verbose high level command stream" |
| 358 | ) |
| 359 | parser.add_argument( |
| 360 | "--verbose-register-command-stream", action="store_true", help="Verbose register command stream" |
| 361 | ) |
| 362 | parser.add_argument("--verbose-operators", action="store_true", help="Verbose operator list") |
Fredrik Svedberg | f5c07c4 | 2021-04-23 14:36:42 +0200 | [diff] [blame] | 363 | parser.add_argument("--verbose-weights", action="store_true", help="Verbose weights information") |
Tim Hall | c1be087 | 2022-03-03 17:50:52 +0000 | [diff] [blame] | 364 | parser.add_argument("--verbose-performance", action="store_true", help="Verbose performance information") |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 365 | parser.add_argument( |
| 366 | "--show-cpu-operations", action="store_true", help="Show the operations that fall back to the CPU" |
| 367 | ) |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 368 | parser.add_argument("--timing", action="store_true", help="Time the compiler doing operations") |
| 369 | parser.add_argument( |
| 370 | "--accelerator-config", |
| 371 | type=str, |
| 372 | default="ethos-u55-256", |
| 373 | choices=list(architecture_features.Accelerator.member_list()), |
| 374 | help="Accelerator configuration to use (default: %(default)s)", |
| 375 | ) |
| 376 | parser.add_argument( |
| 377 | "--system-config", |
| 378 | type=str, |
| 379 | default=architecture_features.ArchitectureFeatures.DEFAULT_CONFIG, |
| 380 | help="System configuration to select from the Vela configuration file (default: %(default)s)", |
| 381 | ) |
| 382 | parser.add_argument( |
| 383 | "--memory-mode", |
| 384 | type=str, |
| 385 | default=architecture_features.ArchitectureFeatures.DEFAULT_CONFIG, |
| 386 | help="Memory mode to select from the Vela configuration file (default: %(default)s)", |
| 387 | ) |
| 388 | parser.add_argument( |
| 389 | "--tensor-allocator", |
| 390 | default=TensorAllocator.HillClimb, |
| 391 | type=lambda s: TensorAllocator[s], |
| 392 | choices=list(TensorAllocator), |
| 393 | help="Tensor Allocator algorithm (default: %(default)s)", |
| 394 | ) |
| 395 | parser.add_argument( |
| 396 | "--show-subgraph-io-summary", |
| 397 | action="store_true", |
| 398 | help="Shows a summary of all the subgraphs and their inputs and outputs", |
| 399 | ) |
| 400 | parser.add_argument( |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 401 | "--max-block-dependency", |
| 402 | type=int, |
| 403 | default=architecture_features.ArchitectureFeatures.MAX_BLOCKDEP, |
| 404 | choices=range(0, architecture_features.ArchitectureFeatures.MAX_BLOCKDEP + 1), |
| 405 | help=( |
| 406 | "Set the maximum value that can be used for the block dependency between npu kernel operations" |
| 407 | " (default: %(default)s)" |
| 408 | ), |
| 409 | ) |
| 410 | parser.add_argument( |
Tim Hall | d8339a7 | 2021-05-27 18:49:40 +0100 | [diff] [blame] | 411 | "--optimise", |
| 412 | type=lambda s: scheduler.OptimizationStrategy[s], |
| 413 | default=scheduler.OptimizationStrategy.Performance, |
| 414 | choices=list(scheduler.OptimizationStrategy), |
| 415 | help=( |
| 416 | "Set the optimisation strategy. The Size strategy results in minimal SRAM usage (does not use" |
| 417 | " arena-cache-size). The Performance strategy results in maximal performance (uses the arena-cache-size" |
| 418 | " if specified) (default: %(default)s)" |
| 419 | ), |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 420 | ) |
| 421 | parser.add_argument( |
Tim Hall | d8339a7 | 2021-05-27 18:49:40 +0100 | [diff] [blame] | 422 | "--arena-cache-size", |
| 423 | type=int, |
| 424 | help=( |
| 425 | "Set the size of the arena cache memory area, in bytes. If specified, this option overrides the memory" |
| 426 | " mode attribute with the same name in a Vela configuration file" |
| 427 | ), |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 428 | ) |
| 429 | parser.add_argument( |
| 430 | "--cpu-tensor-alignment", |
| 431 | type=int, |
| 432 | default=Tensor.AllocationQuantum, |
| 433 | help=( |
| 434 | "Controls the allocation byte alignment of cpu tensors including Ethos-U Custom" |
| 435 | " operator inputs and outputs (default: %(default)s)" |
| 436 | ), |
| 437 | ) |
Dwight Lidman | b9c9542 | 2021-08-18 19:24:14 +0200 | [diff] [blame] | 438 | parser.add_argument( |
| 439 | "--recursion-limit", |
| 440 | type=int, |
| 441 | default=1000, |
| 442 | help="Set the recursion depth limit, may result in RecursionError if too low (default: %(default)s)", |
| 443 | ) |
Tim Hall | cda4fcb | 2022-05-19 12:36:58 +0100 | [diff] [blame] | 444 | parser.add_argument( |
| 445 | "--hillclimb-max-iterations", |
| 446 | type=int, |
| 447 | default=HillClimbAllocator.MAX_ITERATIONS, |
| 448 | help=( |
| 449 | "Set the maximum number of iterations the Hill Climb tensor allocator will run (default: %(default)s)" |
| 450 | ), |
| 451 | ) |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 452 | args = parser.parse_args(args=args) |
Louis Verhaard | 5207830 | 2020-11-18 13:35:06 +0100 | [diff] [blame] | 453 | |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 454 | # Generate the supported ops report and exit |
| 455 | if args.supported_ops_report: |
| 456 | generate_supported_ops() |
| 457 | return 0 |
Louis Verhaard | 5207830 | 2020-11-18 13:35:06 +0100 | [diff] [blame] | 458 | |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 459 | if args.list_config_files: |
| 460 | list_config_files() |
| 461 | return 0 |
| 462 | |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 463 | if args.network is None: |
| 464 | parser.error("the following argument is required: NETWORK") |
Michael McGeagh | 2fa40ae | 2020-12-02 10:55:04 +0000 | [diff] [blame] | 465 | |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 466 | def _parse_config(config): |
Rickard Bolin | 7ce6b32 | 2022-06-02 09:30:33 +0000 | [diff] [blame] | 467 | # Make sure the correct separator is used depending on OS |
| 468 | config = os.path.normpath(config) |
| 469 | |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 470 | if not config.endswith(".ini"): |
| 471 | raise InputFileError(config, "Configuration files must use the .ini extension") |
| 472 | |
Rickard Bolin | 6d7a4f0 | 2022-05-24 14:17:58 +0000 | [diff] [blame] | 473 | if ( |
| 474 | len(config.split(os.path.sep)) == 2 |
| 475 | and not config.startswith(os.path.sep) |
| 476 | and not config.startswith(".") |
| 477 | and not config.startswith("~") |
| 478 | ): |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 479 | config_path = os.path.join(CONFIG_FILES_PATH, config) |
| 480 | else: |
Rickard Bolin | 6d7a4f0 | 2022-05-24 14:17:58 +0000 | [diff] [blame] | 481 | # Check if the configuration file is correctly placed inside the config_files directory |
| 482 | if os.access(os.path.join(CONFIG_FILES_PATH, *config.split(os.path.sep)[-2:]), os.R_OK): |
| 483 | rel_path = os.path.join(*config.split(os.path.sep)[-2:]) |
| 484 | print( |
| 485 | f"Warning: Consider accessing the configuration by --config {rel_path} since it is located " |
| 486 | "inside the config_files directory." |
| 487 | ) |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 488 | config_path = config |
| 489 | |
| 490 | if not os.access(config_path, os.R_OK): |
Rickard Bolin | 6d7a4f0 | 2022-05-24 14:17:58 +0000 | [diff] [blame] | 491 | raise InputFileError( |
| 492 | config_path, |
| 493 | "File not found or is not readable. The configuration file is either not located in a folder " |
| 494 | "directly under the `config_files` directory or its path has not been provided correctly.", |
| 495 | ) |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 496 | |
| 497 | return config_path |
| 498 | |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 499 | # check all config files exist because they will be read as a group |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 500 | config_files = [_parse_config(cfg) for cfg in args.config] if args.config else None |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 501 | |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 502 | if args.cpu_tensor_alignment < 16 or args.cpu_tensor_alignment & (args.cpu_tensor_alignment - 1) != 0: |
| 503 | parser.error( |
| 504 | "Invalid argument to --cpu-tensor-alignment = {} (must be greater than or equal to 16 and a power of 2)" |
| 505 | "".format(args.cpu_tensor_alignment) |
| 506 | ) |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 507 | |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 508 | if args.system_config == ArchitectureFeatures.DEFAULT_CONFIG: |
| 509 | print(f"Warning: Using {ArchitectureFeatures.DEFAULT_CONFIG} values for system configuration") |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 510 | |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 511 | if args.memory_mode == ArchitectureFeatures.DEFAULT_CONFIG: |
| 512 | print(f"Warning: Using {ArchitectureFeatures.DEFAULT_CONFIG} values for memory mode") |
Tim Hall | 79d07d2 | 2020-04-27 18:20:16 +0100 | [diff] [blame] | 513 | |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 514 | if args.verbose_all: |
| 515 | for v in vars(args): |
| 516 | if v.startswith("verbose") and v != "verbose_all": |
| 517 | setattr(args, v, True) |
| 518 | |
Dwight Lidman | b9c9542 | 2021-08-18 19:24:14 +0200 | [diff] [blame] | 519 | sys.setrecursionlimit(args.recursion_limit) |
| 520 | |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 521 | arch = architecture_features.ArchitectureFeatures( |
Rickard Bolin | 1538dce | 2022-04-25 11:07:56 +0000 | [diff] [blame] | 522 | vela_config_files=config_files, |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 523 | system_config=args.system_config, |
| 524 | memory_mode=args.memory_mode, |
| 525 | accelerator_config=args.accelerator_config, |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 526 | max_blockdep=args.max_block_dependency, |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 527 | verbose_config=args.verbose_config, |
Tim Hall | d8339a7 | 2021-05-27 18:49:40 +0100 | [diff] [blame] | 528 | arena_cache_size=args.arena_cache_size, |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 529 | ) |
| 530 | |
| 531 | compiler_options = compiler_driver.CompilerOptions( |
| 532 | verbose_graph=args.verbose_graph, |
| 533 | verbose_quantization=args.verbose_quantization, |
| 534 | verbose_packing=args.verbose_packing, |
| 535 | verbose_tensor_purpose=args.verbose_tensor_purpose, |
| 536 | verbose_tensor_format=args.verbose_tensor_format, |
| 537 | verbose_allocation=args.verbose_allocation, |
| 538 | verbose_high_level_command_stream=args.verbose_high_level_command_stream, |
| 539 | verbose_register_command_stream=args.verbose_register_command_stream, |
| 540 | verbose_operators=args.verbose_operators, |
Fredrik Svedberg | f5c07c4 | 2021-04-23 14:36:42 +0200 | [diff] [blame] | 541 | verbose_weights=args.verbose_weights, |
Tim Hall | c1be087 | 2022-03-03 17:50:52 +0000 | [diff] [blame] | 542 | verbose_performance=args.verbose_performance, |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 543 | show_cpu_operations=args.show_cpu_operations, |
| 544 | tensor_allocator=args.tensor_allocator, |
| 545 | timing=args.timing, |
| 546 | output_dir=args.output_dir, |
| 547 | cpu_tensor_alignment=args.cpu_tensor_alignment, |
Tim Hall | cda4fcb | 2022-05-19 12:36:58 +0100 | [diff] [blame] | 548 | hillclimb_max_iterations=args.hillclimb_max_iterations, |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 549 | ) |
| 550 | |
| 551 | scheduler_options = scheduler.SchedulerOptions( |
Tim Hall | d8339a7 | 2021-05-27 18:49:40 +0100 | [diff] [blame] | 552 | optimization_strategy=args.optimise, |
| 553 | sram_target=arch.arena_cache_size, |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 554 | verbose_schedule=args.verbose_schedule, |
Henrik G Olsson | ea9b23c | 2021-03-23 17:34:49 +0100 | [diff] [blame] | 555 | ) |
| 556 | |
| 557 | model_reader_options = model_reader.ModelReaderOptions() |
| 558 | |
| 559 | nng = process( |
| 560 | args.network, args.enable_debug_db, arch, model_reader_options, compiler_options, scheduler_options |
| 561 | ) |
| 562 | |
| 563 | if args.show_subgraph_io_summary: |
| 564 | print_subgraph_io_summary(nng) |
| 565 | |
| 566 | return 0 |
| 567 | except VelaError as e: |
| 568 | print(e.data) |
| 569 | return 1 |