Skip to content

Commit

Permalink
Initial Commit of Coral Compatibility Test Suite
Browse files Browse the repository at this point in the history 
The Coral CTS allows Coral partners to verify the performance
and reliability of their Coral platforms. This is required for
partners wishing to release products labeled "Made with Coral
Intelligence".

The repo does not need to be cloned, the release artifacts should
be used.
  • Loading branch information
@mbrooksx
mbrooksx committed Feb 2, 2021
0 parents commit 7cb7f21
Show file tree
Hide file tree
Showing 10 changed files with 74,805 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
cts.txt
test_data
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# How to Contribute

We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.

## Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution;
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one
(even if it was for a different project), you probably don't need to do it
again.

## Code reviews

All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.

## Community Guidelines

This project follows [Google's Open Source Community
Guidelines](https://opensource.google.com/conduct/).
202 changes: 202 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

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.
145 changes: 145 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# Coral Compatibility Test Suite

The Coral Compatibility Test Suite (CTS) allows Coral partners to evaluate
their hardware designs that contain Coral devices. The test acts as both
a validation test and a stress test. Passing CTS indicates the device works
as expected and performance/reliability matches official Coral platforms.

CTS is required for launching products branded "Made with Coral Intelligence".
For more information on marketing and branding, see
[Approval Requirements](#approval-requirements).

## What's in the CTS
The CTS is a collection of pre-compiled tests, all taken from
[libcoral](https://github.com/google-coral/libcoral). The tests have been
compiled for multiple CPU architectures (ARM64, ARMv7a, and x86_64) as well
as multiple OSes (Linux, Windows, MacOS).

The test includes:

* Inference stress testing
* Model loading stress testing
* Accuracy testing for classification, detection, and segmentation.
* Multi-TPU / Pipelining tests for devices with multiple TPUs.
* Benchmarking

## Getting CTS Packages
It is not necessary to clone this entire repo, rather just download the
appropriate archive for each architecture and OS you need to test. More
info about which packages are needed for approval can be found in
[Approval Requirements](#approval-requirements).

(To be filled in once submitted to GitHub)

If your system doesn't have a package, you can build the appropriate
libcoral binaries.
See [Building for Other Platforms](#building-for-other-platforms).

## Running CTS

The first step is to download the appropriate archive for your test. Each
archive contains the compiled binaries and the coral_cts.py script.

### Preparing for the test
The test is designed to have as few system requirements as possible. The
binaries are all statically built with the Coral libraries, so all that is
needed is libusb (for USB) or the PCIe driver (see
[installation steps](https://coral.ai/docs/m2/get-started/#2-install-the-pcie-driver-and-edge-tpu-runtime)).

It is recommended that before running the test, you set your CPU governor to
max performance to ensure consistent benchmark readings (and for better
comparison to the Coral boards, included in the
[example_outputs](example_outputs) folder).
In Linux this can be done by running:
```
sudo apt install linux-cpupower
sudo cpupower frequency-set --governor performance
```

Once you have the archive, you're ready to extract it and run. Note that the
test begins with downloading
[Coral Test Data](https://github.com/google-coral/test_data) if there is not
a folder named "test_data" in the extracted directory. Test data
is the entire repository of Coral models, it takes up > 1 GB of storage. If
you already have this repo on your system and want to skip the download, simply
link the folder into the working directory with coral_cts.py.

### Running the test
The test runs in python, with no extra packages needed. To run:
```
python3 coral_cts.py
```

There is only one argument, `--output`, which sets the output txt file. By
default, this is `cts.txt` in the current directory.

## Approval Requirements
In order to be approved for "Made with Coral Intelligence" branding, you should
first talk with your Coral contact or reach out on the
[Coral Sales Form](https://g.co/coral/sales) for legal questions.

Once it's time to run CTS, the requirements will vary based on the platform
you have designed (and what it's intended to pair with):

**PCIe Card (M.2, mPCIe, x1):**

You will need to run three different CTS configurations: ARM64 Linux,
x86_64 Linux, and x86_64 Windows.

**PCIe Card (x16)**

You will need to run two different CTS configurations: x86_64 Linux
and x86_64 Windows.

**USB Accessory**

You will need to run three different CTS configurations: ARM64 Linux,
x86_64 Linux, and x86_64 Windows. x86_64 macOS is also recommended,
but is not required.

**End product**

If the design is a end product (i.e. not a an accessory intended to pair with
other hosts), CTS is just run for the OS/Arch of the system (for example, an
IP camera with Coral inside that runs on 64-bit ARM Linux would only need to
run that test).

## Building for Other Platforms
It is possible that your system doesn't work with the included binaries. You
will need to build the `examples`, `benchmarks`, and `tests` targets
from the [libcoral](https://github.com/google-coral/libcoral) repo.

Once built, your outputs will be in the `out` folder of libcoral. You'll want
to get the following binaries:
```
From out/<arch>/examples/coral:
lstpu
From out/<arch>/tests/coral:
tflite_utils_test
inference_stress_test
model_loading_stress_test
inference_repeatability_test
segmentation_models_test
multiple_tpus_inference_stress_test
From out/<arch>/tests/coral/classification:
classification_models_test
From out/<arch>/tests/coral/detection:
models_test (this must be renamed to detection_models_test)
From out/<arch>/benchmarks/coral/:
models_benchmark
```

Place these binaries in the same folder as coral_cts.py and run the script as
described above.

## Issues
If you have technical issues, please reach out to [email protected].

For marketing/partnership questions, please reach out to your Coral contact or
the [Coral Sales Form](https://g.co/coral/sales).


Loading

0 comments on commit 7cb7f21

Please sign in to comment.