From 05b7f065376e64fdce4e393ac2642cc95cbbedf9 Mon Sep 17 00:00:00 2001 From: Jeremy Johnson Date: Tue, 14 Jun 2022 17:45:03 +0100 Subject: Set up repo with READMEs, structure and pre-commit check Change-Id: Ic1659c79a73cf0622e0188ba570d4da87585811a Signed-off-by: Jeremy Johnson --- .gitignore | 6 ++ .pre-commit-config.yaml | 8 ++ NOTICE | 204 +++++++++++++++++++++++++++++++++++++ README.md | 68 +++++++++++++ frameworks/tflite/operators/README | 1 + operators/activation/README | 1 + operators/comparison/README | 1 + operators/control_flow/README | 1 + operators/data_layout/README | 1 + operators/data_nodes/README | 1 + operators/ew_binary/README | 1 + operators/ew_ternary/README | 1 + operators/ew_unary/README | 1 + operators/image/README | 1 + operators/reduction/README | 1 + operators/scatter_gather/README | 1 + operators/tensor/README | 1 + operators/type_conversion/README | 1 + 18 files changed, 300 insertions(+) create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 NOTICE create mode 100644 README.md create mode 100644 frameworks/tflite/operators/README create mode 100644 operators/activation/README create mode 100644 operators/comparison/README create mode 100644 operators/control_flow/README create mode 100644 operators/data_layout/README create mode 100644 operators/data_nodes/README create mode 100644 operators/ew_binary/README create mode 100644 operators/ew_ternary/README create mode 100644 operators/ew_unary/README create mode 100644 operators/image/README create mode 100644 operators/reduction/README create mode 100644 operators/scatter_gather/README create mode 100644 operators/tensor/README create mode 100644 operators/type_conversion/README diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..cdd3a9043 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +# Ignore binary files +*.npy +*.tosa +model.tflite +ref-result-*.json +desc_binary.json \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 000000000..ab8169d10 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,8 @@ +# Copyright (c) 2021-2022 Arm Limited. +# SPDX-License-Identifier: Apache-2.0 + +repos: +- repo: https://github.com/markdownlint/markdownlint + rev: v0.9.0 + hooks: + - id: markdownlint diff --git a/NOTICE b/NOTICE new file mode 100644 index 000000000..9f1fb161e --- /dev/null +++ b/NOTICE @@ -0,0 +1,204 @@ +Copyright (c) 2020-2022 ARM Limited. + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 000000000..33fd1d396 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# TOSA Conformance Tests + +## Introduction + +This repository contains the conformance tests for the *Tensor +Operator Set Architecture (TOSA) Specification +*. + +## Coverage + +These conformance tests cover the Base Inference profile (TOSA-BI) only. + +There are tests included that cover examples of TensorFlow Lite framework operators +converted to TOSA. + +## Versioning + +The conformance tests repository has branches that correspond to each +TOSA version (major.minor), and tags (major.minor.patch) that match to specific versions. + +Perform the following command to check out a specific version: + +``` bash +git checkout --recurse-submodules VERSION +``` + +Where `VERSION` can be for example: `v0.23` or `v0.23.0` + +## Test Contents + +Typical test contents will be: + +* `test*.json` - TOSA test in flatbuffer JSON format +* `input-*.json` or `placeholder-*.json` - input files (e.g. tensors) in JSON format +* `Conformance-*.json` - expected output file in JSON format +* `desc.json` - test meta-data in JSON format +* `model-*` - optional framework model file, used to create the TOSA test + +## Usage + +### Flatbuffer Schema + +A JSON flatbuffer TOSA test file needs to be used with a +corresponding version of the schema file. The schema is linked via git submodules +and should be checked out with the specific version chosen above. You can find +the schema: + +``` bash +ls -l third_party/serialization_lib/schema/tosa.fbs +``` + +If you have not checked out a specific conformance version, then use the +following command to initialise the necessary submodule: + +``` bash +git submodule update --init --recursive +``` + +### Running + +It is recommended to use these tests with the Unit Test Runner from the +TOSA Unit Test Infrastructure in the *TOSA Reference Model +*, +please see that repository for more information. + +## License + +The TOSA Conformance tests are licensed under Apache-2.0 unless otherwise noted. diff --git a/frameworks/tflite/operators/README b/frameworks/tflite/operators/README new file mode 100644 index 000000000..ccd75579c --- /dev/null +++ b/frameworks/tflite/operators/README @@ -0,0 +1 @@ +This directory contains tests equivalent to the TF Lite framwork operators. diff --git a/operators/activation/README b/operators/activation/README new file mode 100644 index 000000000..cd1360367 --- /dev/null +++ b/operators/activation/README @@ -0,0 +1 @@ +This directory contains activation function tests. diff --git a/operators/comparison/README b/operators/comparison/README new file mode 100644 index 000000000..8e8f9de57 --- /dev/null +++ b/operators/comparison/README @@ -0,0 +1 @@ +This directory contains comparison operator tests. diff --git a/operators/control_flow/README b/operators/control_flow/README new file mode 100644 index 000000000..ad77f7e0f --- /dev/null +++ b/operators/control_flow/README @@ -0,0 +1 @@ +This directory contains control flow operator tests. diff --git a/operators/data_layout/README b/operators/data_layout/README new file mode 100644 index 000000000..6962f937a --- /dev/null +++ b/operators/data_layout/README @@ -0,0 +1 @@ +This directory contains data layout tests. diff --git a/operators/data_nodes/README b/operators/data_nodes/README new file mode 100644 index 000000000..847f202f5 --- /dev/null +++ b/operators/data_nodes/README @@ -0,0 +1 @@ +This directory contains data node tests. diff --git a/operators/ew_binary/README b/operators/ew_binary/README new file mode 100644 index 000000000..668347a23 --- /dev/null +++ b/operators/ew_binary/README @@ -0,0 +1 @@ +This directory contains elementwise binary operator tests. diff --git a/operators/ew_ternary/README b/operators/ew_ternary/README new file mode 100644 index 000000000..887c895eb --- /dev/null +++ b/operators/ew_ternary/README @@ -0,0 +1 @@ +This directory contains elementwise ternary operator tests. diff --git a/operators/ew_unary/README b/operators/ew_unary/README new file mode 100644 index 000000000..9bdcbd2af --- /dev/null +++ b/operators/ew_unary/README @@ -0,0 +1 @@ +This directory contains elementwise unary operator tests. diff --git a/operators/image/README b/operators/image/README new file mode 100644 index 000000000..e48490e84 --- /dev/null +++ b/operators/image/README @@ -0,0 +1 @@ +This directory contains image operator tests. diff --git a/operators/reduction/README b/operators/reduction/README new file mode 100644 index 000000000..cb2985c22 --- /dev/null +++ b/operators/reduction/README @@ -0,0 +1 @@ +This directory contains reduction operator tests. diff --git a/operators/scatter_gather/README b/operators/scatter_gather/README new file mode 100644 index 000000000..f64b86d7f --- /dev/null +++ b/operators/scatter_gather/README @@ -0,0 +1 @@ +This directory contains scatter/gather operator tests. diff --git a/operators/tensor/README b/operators/tensor/README new file mode 100644 index 000000000..fd78a544b --- /dev/null +++ b/operators/tensor/README @@ -0,0 +1 @@ +This directory contains tensor operator tests. diff --git a/operators/type_conversion/README b/operators/type_conversion/README new file mode 100644 index 000000000..f54e6ccab --- /dev/null +++ b/operators/type_conversion/README @@ -0,0 +1 @@ +This directory contains type conversion tests. -- cgit v1.2.1