README.txt
1Copyright 2017 The Android Open Source Project
2
3Licensed under the Apache License, Version 2.0 (the "License");
4you may not use this file except in compliance with the License.
5You may obtain a copy of the License at
6
7 http://www.apache.org/licenses/LICENSE-2.0
8
9Unless required by applicable law or agreed to in writing, software
10distributed under the License is distributed on an "AS IS" BASIS,
11WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12See the License for the specific language governing permissions and
13limitations under the License.
14------------------------------------------------------------------
15
16This directory contains files for the Android Neural Networks API.
17
18CONTENTS OF THIS DIRECTORY
19
20./runtime: Implementation of the NN API runtime.
21 Includes source code and internal header files.
22./runtime/include: The header files that an external developer would use.
23 These will be packaged with the NDK. Includes a
24 C++ wrapper around the C API to make it easier to use.
25./runtime/test: Test files.
26
27./sample_driver: Sample driver that uses the CPU to execute queries.
28 NOT TO BE SHIPPED. Only to be used as a testing and
29 learning tool.
30
31./common: Contains files that can be useful for multiple components,
32 e.g. runtime, driver, or tests. Includes source code and
33 internal header files.
34./common/include: Header files to be used by the components using common.
35./common/operations: CPU implementation of the operations.
36
37RELATED DIRECTORIES
38
39/hardware/interfaces/neuralnetworks: Definition of the HAL.
40/hardware/interfaces/neuralnetworks/*/vts: The VTS tests.
41/test/vts-testcase/hal/neuralnetworks: Configuration for the VTS tests
42
43THE FOLLOWING SUBDIRECTORIES ARE EXPECTED IN LATER RELEASES:
44
45./tools: Tools used to develop the API, i.e. not external developer tools
46./tools/benchmark: To test performance.
47/cts/tests/tests/ml/nn: The CTS tests
48