Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2cae5c8b authored by David Gross's avatar David Gross
Browse files

Replace sync_enums_to_hal.py with generate_api.{py,sh} and regenerate */types.hal 

There are certain pieces of NeuralNetworks.h and of our various *.hal
files that ought to be kept in sync -- most notably the operand type
and operation type definitions and descriptions in our
NeuralNetworks.h and types.hal files.  To avoid having to do this
manually, a tool can be employed.

The old solution to this problem is sync_enums_to_hal.py, which parses
the existing NeuralNetworks.h and types.hal files, and then rewrites
the types.hal files: It identifies the operand type and operation type
portions of the files, and in the types.hal files replaces them with
transformed versions of the portions from NeuralNetworks.h.  This
approach is brittle -- it is very sensitive to the structure of the
files, as was recognized when this tool was created.  Changes to those
files since the script was last updated essentially broke the script,
as noted in http://b/140132458.

The new solution employs a new tool generate_api.py to combine a
single "specification file" with one "template file" per API file
(NeuralNetworks.h or types.hal) to produce that API file.  The script
generate_api.sh invokes generate_api.py once per API file, passing
appropriate arguments.  See frameworks/ml/nn/tools/api/README.md for
more details.

In the process of combining information from NeuralNetworks.h and
*/types.hal, some formatting, syntactic, and semantic changes have
been made to those files.  For example:
- types.hal files no longer refer to API levels or (similarly)
  to HAL versions other than earlier HAL versions

Bug: 130169064
Bug: 140132458

Test: cd neuralnetworks ; mma

Change-Id: Iceb38effc2c7e6c32344e49225b85256144c0945
parent 4f9195a6

current.txt

+3 −0
Original line number Original line Diff line number Diff line
@@ -575,8 +575,11 @@ cfa81f229b69f9011c58f48264fcb552447430fe68610eac514e811e65bc306a android.hardwar 
2410dd02d67786a732d36e80b0f8ccf55086604ef37f9838e2013ff2c571e404 android.hardware.camera.device@3.5::types

2410dd02d67786a732d36e80b0f8ccf55086604ef37f9838e2013ff2c571e404 android.hardware.camera.device@3.5::types

b69a7615c508acf5c5201efd1bfa3262167874fc3594e2db5a3ff93addd8ac75 android.hardware.keymaster@4.0::IKeymasterDevice

b69a7615c508acf5c5201efd1bfa3262167874fc3594e2db5a3ff93addd8ac75 android.hardware.keymaster@4.0::IKeymasterDevice

eb2fa0c883c2185d514be0b84c179b283753ef0c1b77b45b4f359bd23bba8b75 android.hardware.neuralnetworks@1.0::IPreparedModel

eb2fa0c883c2185d514be0b84c179b283753ef0c1b77b45b4f359bd23bba8b75 android.hardware.neuralnetworks@1.0::IPreparedModel

f1109cbb10297b7429a11fab42afa912710b303c9bf20bd5cdb8bd57b9c84186 android.hardware.neuralnetworks@1.0::types

9d8ee57c490ffeaa28f702eaea8d198cb510e4bbfb99e6cb5f63e73341057c7c android.hardware.neuralnetworks@1.1::types

fb382e986c10b8fbb797a8546e8f9ea6d1107bfe6f3fb7e57f6bbbf1f807a906 android.hardware.neuralnetworks@1.2::IDevice

fb382e986c10b8fbb797a8546e8f9ea6d1107bfe6f3fb7e57f6bbbf1f807a906 android.hardware.neuralnetworks@1.2::IDevice

40e71cd693de5b832325c5d8f081f2ff20a7ba2b89d401cee5b4b3eb0e241681 android.hardware.neuralnetworks@1.2::IPreparedModel

40e71cd693de5b832325c5d8f081f2ff20a7ba2b89d401cee5b4b3eb0e241681 android.hardware.neuralnetworks@1.2::IPreparedModel

71c0f7127335e5b74d1615d5e7f129831b43ffbae5318ad0924d7d8d8910a859 android.hardware.neuralnetworks@1.2::types

a785a57447a81e9c130eef6904c3a5c256076c6a04588c40620ebd6fa2660d77 android.hardware.radio@1.2::types

a785a57447a81e9c130eef6904c3a5c256076c6a04588c40620ebd6fa2660d77 android.hardware.radio@1.2::types

1a6e2bd289f22931c526b21916910f1d4c436b7acb9556e4243de4ce8e6cc2e4 android.hardware.soundtrigger@2.0::ISoundTriggerHwCallback

1a6e2bd289f22931c526b21916910f1d4c436b7acb9556e4243de4ce8e6cc2e4 android.hardware.soundtrigger@2.0::ISoundTriggerHwCallback

fd65298e1e09e0e3c781ab18305920d757dbe55a3b459ce17814ec5cf6dfee99 android.hardware.wifi@1.0::IWifiP2pIface

fd65298e1e09e0e3c781ab18305920d757dbe55a3b459ce17814ec5cf6dfee99 android.hardware.wifi@1.0::IWifiP2pIface

neuralnetworks/1.0/types.hal

+228 −239

File changed.

Preview size limit exceeded, changes collapsed.

neuralnetworks/1.0/types.t

0 → 100644
+431 −0
Original line number Original line Diff line number Diff line 
%% template file for generating types.hal.

%% see frameworks/ml/nn/tools/api/README.md.

/*

 * Copyright (C) 2017 The Android Open Source Project

 *

 * 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.

 */



package android.hardware.neuralnetworks@1.0;



%insert Operand_1.0_Comment

enum OperandType : int32_t {

%insert Operand_1.0



    /**

     * DEPRECATED. Since HAL version 1.2, extensions are the preferred

     * alternative to OEM operation and data types.

     *

     * OEM specific scalar value.

     */

    OEM                 = 10000,



    /**

     * DEPRECATED. Since HAL version 1.2, extensions are the preferred

     * alternative to OEM operation and data types.

     *

     * A tensor of OEM specific values.

     */

    TENSOR_OEM_BYTE     = 10001,

};



%insert Operation_1.0_Comment

enum OperationType : int32_t {

%insert Operation_1.0



    /**

     * DEPRECATED. Since NNAPI 1.2, extensions are the preferred alternative to

     * OEM operation and data types.

     *

     * This operation is OEM specific. It should only be used for OEM

     * applications.

     */

    OEM_OPERATION = 10000,

};



/**

 * Fused activation function types.

 */

enum FusedActivationFunc : int32_t {

    NONE  = 0,

    RELU  = 1,

    RELU1 = 2,

    RELU6 = 3,

};



/**

 * How an operand is used.

 */

enum OperandLifeTime : int32_t {

    /**

     * The operand is internal to the model. It's created by an operation and

     * consumed by other operations. It must be an output operand of

     * exactly one operation.

     */

    TEMPORARY_VARIABLE,



    /**

     * The operand is an input of the model. It must not be an output

     * operand of any operation.

     *

     * An operand can't be both input and output of a model.

     */

    MODEL_INPUT,



    /**

     * The operand is an output of the model. It must be an output

     * operand of exactly one operation.

     *

     * An operand can't be both input and output of a model.

     */

    MODEL_OUTPUT,



    /**

     * The operand is a constant found in Model.operandValues. It must

     * not be an output operand of any operation.

     */

    CONSTANT_COPY,



    /**

     * The operand is a constant that was specified via a Memory

     * object. It must not be an output operand of any operation.

     */

    CONSTANT_REFERENCE,



    /**

     * The operand does not have a value. This is valid only for optional

     * arguments of operations.

     */

    NO_VALUE,

};



/**

 * Status of a device.

 */

enum DeviceStatus : int32_t {

    AVAILABLE,

    BUSY,

    OFFLINE,

    UNKNOWN,

};



/**

 * Performance information for the reference workload.

 *

 * Used by a driver to report its performance characteristics.

 */

struct PerformanceInfo {

    /**

     * Ratio of the time taken by the driver to execute the

     * workload compared to the time the CPU would take for the

     * same workload. A lower number is better.

     */

    float execTime;



    /**

     * Ratio of the energy used by the driver compared to what

     * the CPU would use for doing the same workload. A lower number

     * is better.

     */

    float powerUsage;

};



/**

 * The capabilities of a driver.

 */

struct Capabilities {

    /**

     * Driver performance when operating on float32 data.

     */

    PerformanceInfo float32Performance;



    /**

     * Driver performance when operating on asymmetric 8-bit quantized data.

     */

    PerformanceInfo quantized8Performance;

};



/**

 * Describes the location of a data object.

 */

struct DataLocation {

    /**

     * The index of the memory pool where this location is found.

     */

    uint32_t poolIndex;



    /**

     * Offset in bytes from the start of the pool.

     */

    uint32_t offset;



    /**

     * The length of the data in bytes.

     */

    uint32_t length;

};



/**

 * Describes one operand of the model's graph.

 */

struct Operand {

    /**

     * Data type of the operand.

     */

    OperandType type;



    /**

     * Dimensions of the operand.

     *

     * For a scalar operand, dimensions.size() must be 0.

     *

     * For a tensor operand, dimensions.size() must be at least 1;

     * however, any of the dimensions may be unspecified.

     *

     * A tensor operand with all dimensions specified has "fully

     * specified" dimensions. Whenever possible (i.e., whenever the

     * dimensions are known at model construction time), a tensor

     * operand should have (but is not required to have) fully

     * specified dimensions, in order to enable the best possible

     * performance.

     *

     * If a tensor operand's dimensions are not fully specified, the

     * dimensions of the operand are deduced from the operand

     * dimensions and values of the operation for which that operand

     * is an output.

     *

     * In the following situations, a tensor operand's dimensions must

     * be fully specified:

     *

     *     . The operand has lifetime CONSTANT_COPY or

     *       CONSTANT_REFERENCE.

     *

     *     . The operand has lifetime MODEL_INPUT or MODEL_OUTPUT. Fully

     *       specified dimensions must either be present in the

     *       Operand or they must be provided in the corresponding

     *       RequestArgument.

     *       EXCEPTION: If the input or output is optional and omitted

     *       (by setting the hasNoValue field of the corresponding

     *       RequestArgument to true) then it need not have fully

     *       specified dimensions.

     *

     * A tensor operand with some number of unspecified dimensions is

     * represented by setting each unspecified dimension to 0.

     */

    vec<uint32_t> dimensions;



    /**

     * The number of times this operand appears as an operation input.

     *

     * (For example, if this operand appears once in one operation's

     * input list, and three times in another operation's input list,

     * then numberOfConsumers = 4.)

     */

    uint32_t numberOfConsumers;



    /**

     * Quantized scale of the operand.

     *

     * Only applicable if the operand is of type TENSOR_QUANT8_ASYMM or

     * TENSOR_INT32.

     */

    float scale;



    /**

     * Quantized zero-point offset of the operand.

     *

     * Only applicable if the operand is of type TENSOR_QUANT8_ASYMM.

     */

    int32_t zeroPoint;



    /**

     * How the operand is used.

     */

    OperandLifeTime lifetime;



    /**

     * Where to find the data for this operand.

     * If the lifetime is TEMPORARY_VARIABLE, MODEL_INPUT, MODEL_OUTPUT, or

     * NO_VALUE:

     * - All the fields must be 0.

     * If the lifetime is CONSTANT_COPY:

     * - location.poolIndex is 0.

     * - location.offset is the offset in bytes into Model.operandValues.

     * - location.length is set.

     * If the lifetime is CONSTANT_REFERENCE:

     * - location.poolIndex is set.

     * - location.offset is the offset in bytes into the specified pool.

     * - location.length is set.

     */

    DataLocation location;

};



/**

 * Describes one operation of the model's graph.

 */

struct Operation {

    /**

     * The operation type.

     */

    OperationType type;



    /**

     * Describes the table that contains the indexes of the inputs of the

     * operation. The offset is the index in the operandIndexes table.

     */

    vec<uint32_t> inputs;



    /**

     * Describes the table that contains the indexes of the outputs of the

     * operation. The offset is the index in the operandIndexes table.

     */

    vec<uint32_t> outputs;

};



/**

 * A Neural Network Model.

 *

 * This includes not only the execution graph, but also constant data such as

 * weights or scalars added at construction time. The only information that

 * might not be known is the shape of the input tensors.

 */

struct Model {

    /**

     * All operands included in the model.

     */

    vec<Operand> operands;



    /**

     * All operations included in the model.

     *

     * The operations are sorted into execution order. Every operand

     * with lifetime MODEL_OUTPUT or TEMPORARY_VARIABLE must be

     * written before it is read.

     */

    vec<Operation> operations;



    /**

     * Input indexes of the model. There must be at least one.

     *

     * Each value corresponds to the index of the operand in "operands".

     */

    vec<uint32_t> inputIndexes;



    /**

     * Output indexes of the model. There must be at least one.

     *

     * Each value corresponds to the index of the operand in "operands".

     */

    vec<uint32_t> outputIndexes;



    /**

     * A byte buffer containing operand data that were copied into the model.

     *

     * An operand's value must be located here if and only if Operand::lifetime

     * equals OperandLifeTime::CONSTANT_COPY.

     */

    vec<uint8_t> operandValues;



    /**

     * A collection of shared memory pools containing operand values.

     *

     * An operand's value must be located here if and only if Operand::lifetime

     * equals OperandLifeTime::CONSTANT_REFERENCE.

     */

    vec<memory> pools;

};



/**

 * Metadata information specifying the location of the input or output data and

 * any updates to the input or output operand.

 */

struct RequestArgument {

    /**

     * If true, the argument does not have a value. This can be used for

     * operations that take optional arguments. If true, the fields of location

     * are set to 0 and the dimensions vector is left empty.

     */

    bool hasNoValue;



    /**

     * The location within one of the memory pools passed in the Request.

     */

    DataLocation location;



    /**

     * Updated dimension information.

     *

     * If dimensions.size() > 0, dimension information was provided

     * along with the argument. This can be the case for models that

     * accept inputs of varying size. This can't change the rank, just

     * the value of the dimensions that were unspecified in the

     * model. If dimensions.size() > 0, then all dimensions must be

     * specified here; and any dimension that was specified in the

     * model must have the same value here.

     *

     * If the dimensions in the model are not fully specified, then

     * they must be fully specified here, unless hasNoValue is set to

     * true. If the dimensions in the model are fully specified, then

     * either dimensions.size() may be 0, or the dimensions in the

     * model must be identical to the dimensions here.

     */

    vec<uint32_t> dimensions;

};



/**

 * Inputs to be sent to and outputs to be retrieved from a prepared model.

 *

 * A Request serves two primary tasks:

 * 1) Provides the input and output data to be used when executing the model.

 * 2) Specifies any updates to the input operand metadata that were left

 *    unspecified at model preparation time.

 *

 * An output must not overlap with any other output, with an input, or

 * with an operand of lifetime CONSTANT_REFERENCE.

 */

struct Request {

    /**

     * Input data and information to be used in the execution of a prepared

     * model.

     *

     * The index of the input corresponds to the index in Model.inputIndexes.

     *   E.g., input[i] corresponds to Model.inputIndexes[i].

     */

    vec<RequestArgument> inputs;



    /**

     * Output data and information to be used in the execution of a prepared

     * model.

     *

     * The index of the output corresponds to the index in Model.outputIndexes.

     *   E.g., output[i] corresponds to Model.outputIndexes[i].

     */

    vec<RequestArgument> outputs;



    /**

     * A collection of shared memory pools containing operand data for both the

     * inputs and the outputs to a model.

     */

    vec<memory> pools;

};



/**

 * Return status of a function.

 */

enum ErrorStatus : int32_t {

    NONE,

    DEVICE_UNAVAILABLE,

    GENERAL_FAILURE,

    OUTPUT_INSUFFICIENT_SIZE,

    INVALID_ARGUMENT,

};

neuralnetworks/1.1/types.hal

+21 −26
Original line number Original line Diff line number Diff line
@@ -26,7 +26,6 @@ import @1.0::PerformanceInfo; 
 * The type of an operation in a model.

 * The type of an operation in a model.

 */

 */

enum OperationType : @1.0::OperationType {

enum OperationType : @1.0::OperationType {



    /**

    /**

     * BatchToSpace for N-dimensional tensors.

     * BatchToSpace for N-dimensional tensors.

     *

     *
@@ -41,7 +40,8 @@ enum OperationType : @1.0::OperationType { 
     * * {@link OperandType::TENSOR_FLOAT32}

     * * {@link OperandType::TENSOR_FLOAT32}

     * * {@link OperandType::TENSOR_QUANT8_ASYMM}

     * * {@link OperandType::TENSOR_QUANT8_ASYMM}

     *

     *

     * Supported tensor rank: 4

     * Supported tensor rank: 4, with "NHWC" (i.e., Num_samples, Height, Width,

     * and Channels) data layout.

     *

     *

     * Inputs:

     * Inputs:

     * * 0: An n-D tensor, specifying the tensor to be reshaped

     * * 0: An n-D tensor, specifying the tensor to be reshaped
@@ -51,8 +51,8 @@ enum OperationType : @1.0::OperationType { 
     *

     *

     * Outputs:

     * Outputs:

     * * 0: A tensor of the same {@link OperandType} as input0.

     * * 0: A tensor of the same {@link OperandType} as input0.

     *

     *      For a {@link OperandType::TENSOR_QUANT8_ASYMM} tensor,

     * Available since API level 28.

     *      the scale and zeroPoint must be the same as input0.

     */

     */

    BATCH_TO_SPACE_ND = 29,

    BATCH_TO_SPACE_ND = 29,
@@ -91,8 +91,6 @@ enum OperationType : @1.0::OperationType { 
     *

     *

     * Outputs:

     * Outputs:

     * * 0: A tensor of the same {@link OperandType} as input0.

     * * 0: A tensor of the same {@link OperandType} as input0.

     *

     * Available since API level 28.

     */

     */

    DIV = 30,

    DIV = 30,
@@ -126,8 +124,8 @@ enum OperationType : @1.0::OperationType { 
     *

     *

     * Outputs:

     * Outputs:

     * * 0: A tensor of the same {@link OperandType} as input0.

     * * 0: A tensor of the same {@link OperandType} as input0.

     *

     *      For a {@link OperandType::TENSOR_QUANT8_ASYMM} tensor,

     * Available since API level 28.

     *      the scale and zeroPoint must be same as input0.

     */

     */

    MEAN = 31,

    MEAN = 31,
@@ -138,7 +136,8 @@ enum OperationType : @1.0::OperationType { 
     *

     *

     * Supported tensor {@link OperandType}:

     * Supported tensor {@link OperandType}:

     * * {@link OperandType::TENSOR_FLOAT32}

     * * {@link OperandType::TENSOR_FLOAT32}

     * * {@link OperandType::TENSOR_QUANT8_ASYMM} (the pad value is undefined)

     * * {@link OperandType::TENSOR_QUANT8_ASYMM}

     *   (the pad value is undefined)

     *

     *

     * Supported tensor rank: up to 4

     * Supported tensor rank: up to 4

     *

     *
@@ -160,11 +159,8 @@ enum OperationType : @1.0::OperationType { 
     *      of the padding:

     *      of the padding:

     *          output0.dimension[i] =

     *          output0.dimension[i] =

     *              padding[i, 0] + input0.dimension[i] + padding[i, 1]

     *              padding[i, 0] + input0.dimension[i] + padding[i, 1]

     *

     *      For a {@link OperandType::TENSOR_QUANT8_ASYMM} tensor,

     *      NOTE: The pad value for {@link ANEURALNETWORKS_TENSOR_QUANT8_ASYMM}

     *      the scale and zeroPoint must be the same as input0.

     *      is undefined.

     *

     * Available since API level 28.

     */

     */

    PAD = 32,

    PAD = 32,
@@ -182,8 +178,10 @@ enum OperationType : @1.0::OperationType { 
     * Supported tensor {@link OperandType}:

     * Supported tensor {@link OperandType}:

     * * {@link OperandType::TENSOR_FLOAT32}

     * * {@link OperandType::TENSOR_FLOAT32}

     * * {@link OperandType::TENSOR_QUANT8_ASYMM}

     * * {@link OperandType::TENSOR_QUANT8_ASYMM}

     *   (the pad value is undefined)

     *

     *

     * Supported tensor rank: 4

     * Supported tensor rank: 4, with "NHWC" (i.e., Num_samples, Height, Width,

     * and Channels) data layout.

     *

     *

     * Inputs:

     * Inputs:

     * * 0: An n-D tensor, specifying the input.

     * * 0: An n-D tensor, specifying the input.
@@ -201,8 +199,8 @@ enum OperationType : @1.0::OperationType { 
     *

     *

     * Outputs:

     * Outputs:

     * * 0: A tensor of the same {@link OperandType} as input0.

     * * 0: A tensor of the same {@link OperandType} as input0.

     *

     *      For a {@link OperandType::TENSOR_QUANT8_ASYMM} tensor,

     * Available since API level 28.

     *      the scale and zeroPoint must be the same as input0.

     */

     */

    SPACE_TO_BATCH_ND = 33,

    SPACE_TO_BATCH_ND = 33,
@@ -232,8 +230,8 @@ enum OperationType : @1.0::OperationType { 
     * * 0: A tensor of the same {@link OperandType} as input0. Contains the

     * * 0: A tensor of the same {@link OperandType} as input0. Contains the

     *      same data as input, but has one or more dimensions of size 1

     *      same data as input, but has one or more dimensions of size 1

     *      removed.

     *      removed.

     *

     *      For a {@link OperandType::TENSOR_QUANT8_ASYMM} tensor,

     * Available since API level 28.

     *      the scale and zeroPoint must be the same as input0.

     */

     */

    SQUEEZE = 34,

    SQUEEZE = 34,
@@ -278,8 +276,8 @@ enum OperationType : @1.0::OperationType { 
     * Outputs:

     * Outputs:

     * * 0: A tensor of the same {@link OperandType} as input0 and rank (n - k),

     * * 0: A tensor of the same {@link OperandType} as input0 and rank (n - k),

     *      where k is the number of bits set in shrink_axis_mask.

     *      where k is the number of bits set in shrink_axis_mask.

     *

     *      For a {@link OperandType::TENSOR_QUANT8_ASYMM} tensor,

     * Available since API level 28.

     *      the scale and zeroPoint must be the same as input0.

     */

     */

    STRIDED_SLICE = 35,

    STRIDED_SLICE = 35,
@@ -318,8 +316,6 @@ enum OperationType : @1.0::OperationType { 
     *

     *

     * Outputs:

     * Outputs:

     * * 0: A tensor of the same {@link OperandType} as input0.

     * * 0: A tensor of the same {@link OperandType} as input0.

     *

     * Available since API level 28.

     */

     */

    SUB = 36,

    SUB = 36,
@@ -345,11 +341,10 @@ enum OperationType : @1.0::OperationType { 
     *

     *

     * Outputs:

     * Outputs:

     * * 0: A tensor of the same {@link OperandType} as input0.

     * * 0: A tensor of the same {@link OperandType} as input0.

     *

     *      For a {@link OperandType::TENSOR_QUANT8_ASYMM} tensor,

     * Available since API level 28.

     *      the scale and zeroPoint must be the same as input0.

     */

     */

    TRANSPOSE = 37,

    TRANSPOSE = 37,



};

};





/**

/**

neuralnetworks/1.1/types.t

0 → 100644
+158 −0
Original line number Original line Diff line number Diff line 
%% template file for generating types.hal.

%% see frameworks/ml/nn/tools/api/README.md.

/*

 * Copyright (C) 2018 The Android Open Source Project

 *

 * 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.

 */



package android.hardware.neuralnetworks@1.1;



import @1.0::Operand;

import @1.0::OperationType;

import @1.0::PerformanceInfo;



/**

 * Operation types.

 *

 * The type of an operation in a model.

 */

enum OperationType : @1.0::OperationType {

%insert Operation_1.1

};



/**

 * The capabilities of a driver.

 */

struct Capabilities {

    /**

     * Driver performance when operating on float32 data.

     */

    PerformanceInfo float32Performance;



    /**

     * Driver performance when operating on asymmetric 8-bit quantized data.

     */

    PerformanceInfo quantized8Performance;



    /**

     * Driver performance when operating on float32 data but performing

     * calculations with range and/or precision as low as that of the IEEE

     * 754 16-bit floating-point format.

     */

    PerformanceInfo relaxedFloat32toFloat16Performance;

};



/**

 * Describes one operation of the model's graph.

 */

struct Operation {

    /**

     * The operation type.

     */

    OperationType type;



    /**

     * Describes the table that contains the indexes of the inputs of the

     * operation. The offset is the index in the operandIndexes table.

     */

    vec<uint32_t> inputs;



    /**

     * Describes the table that contains the indexes of the outputs of the

     * operation. The offset is the index in the operandIndexes table.

     */

    vec<uint32_t> outputs;

};



/**

 * A Neural Network Model.

 *

 * This includes not only the execution graph, but also constant data such as

 * weights or scalars added at construction time. The only information that

 * may not be known is the shape of the input tensors.

 */

struct Model {

    /**

     * All operands included in the model.

     */

    vec<Operand> operands;



    /**

     * All operations included in the model.

     *

     * The operations are sorted into execution order. Every operand

     * with lifetime MODEL_OUTPUT or TEMPORARY_VARIABLE must be

     * written before it is read.

     */

    vec<Operation> operations;



    /**

     * Input indexes of the model. There must be at least one.

     *

     * Each value corresponds to the index of the operand in "operands".

     */

    vec<uint32_t> inputIndexes;



    /**

     * Output indexes of the model. There must be at least one.

     *

     * Each value corresponds to the index of the operand in "operands".

     */

    vec<uint32_t> outputIndexes;



    /**

     * A byte buffer containing operand data that were copied into the model.

     *

     * An operand's value must be located here if and only if Operand::lifetime

     * equals OperandLifeTime::CONSTANT_COPY.

     */

    vec<uint8_t> operandValues;



    /**

     * A collection of shared memory pools containing operand values.

     *

     * An operand's value must be located here if and only if Operand::lifetime

     * equals OperandLifeTime::CONSTANT_REFERENCE.

     */

    vec<memory> pools;



    /**

     * 'true' indicates TENSOR_FLOAT32 may be calculated with range and/or

     * precision as low as that of the IEEE 754 16-bit floating-point format.

     * 'false' indicates TENSOR_FLOAT32 must be calculated using at least the

     * range and precision of the IEEE 754 32-bit floating-point format.

     */

    bool relaxComputationFloat32toFloat16;

};



/**

 * Execution preferences.

 */

enum ExecutionPreference : int32_t {

    /**

     * Prefer executing in a way that minimizes battery drain.

     * This is desirable for compilations that will be executed often.

     */

    LOW_POWER = 0,

    /**

     * Prefer returning a single answer as fast as possible, even if this causes

     * more power consumption.

     */

    FAST_SINGLE_ANSWER = 1,

    /**

     * Prefer maximizing the throughput of successive frames, for example when

     * processing successive frames coming from the camera.

     */

    SUSTAINED_SPEED = 2,

};