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