ส่วนขยายผู้ให้บริการ

ส่วนขยายของผู้ให้บริการ Neural Networks API (NNAPI) ซึ่งเปิดตัวใน Android 10 คือชุดการดำเนินการและประเภทข้อมูลที่ผู้ให้บริการกำหนด ในอุปกรณ์ที่ใช้ NN HAL 1.2 ขึ้นไป โปรแกรมควบคุมสามารถดำเนินการที่เร่งด้วยฮาร์ดแวร์ที่กำหนดเองได้โดยรองรับส่วนขยายของผู้ให้บริการที่เกี่ยวข้อง ส่วนขยายผู้ให้บริการจะไม่ปรับเปลี่ยน ลักษณะการทำงานของการดำเนินการที่มีอยู่

ส่วนขยายผู้ให้บริการมีทางเลือกที่มีโครงสร้างมากกว่าการดำเนินการและประเภทข้อมูล OEM ซึ่งเลิกใช้งานแล้วใน Android 10 ดูข้อมูลเพิ่มเติมได้ที่การดำเนินการและประเภทข้อมูล OEM

รายการที่อนุญาตของการใช้งานส่วนขยาย

ส่วนขยายของผู้ให้บริการใช้ได้กับแอป Android และไบนารีเนทีฟที่ระบุไว้อย่างชัดเจนในพาร์ติชัน /product, /vendor, /odm และ /data เท่านั้น แอปและไบนารีแบบเนทีฟที่อยู่ในพาร์ติชัน /system จะใช้ส่วนขยายของผู้ให้บริการไม่ได้

ระบบจะจัดเก็บรายการแอปและไบนารี Android ที่อนุญาตให้ใช้ส่วนขยายของผู้ให้บริการ NNAPI ใน /vendor/etc/nnapi_extensions_app_allowlist แต่ละบรรทัดของไฟล์จะมีรายการใหม่ รายการอาจเป็นเส้นทางไบนารีแบบเนทีฟที่ขึ้นต้นด้วยเครื่องหมายทับ (/) เช่น /data/foo หรือชื่อแพ็กเกจแอป Android เช่น com.foo.bar

มีการบังคับใช้รายการที่อนุญาตจากไลบรารีที่ใช้ร่วมกันของรันไทม์ NNAPI ไลบรารีนี้ช่วยป้องกันการใช้งานโดยไม่ตั้งใจ แต่ไม่สามารถป้องกันการหลบเลี่ยงโดยเจตนาของแอปที่ใช้อินเทอร์เฟซ HAL ของไดรเวอร์ NNAPI โดยตรง

คำจำกัดความของส่วนขยายผู้ให้บริการ

ผู้ให้บริการสร้างและดูแลรักษาไฟล์ส่วนหัวที่มีการกำหนดส่วนขยาย ดูตัวอย่างคำจำกัดความของส่วนขยายที่สมบูรณ์ได้ใน example/fibonacci/FibonacciExtension.h

ส่วนขยายแต่ละรายการต้องมีชื่อที่ไม่ซ้ำกันซึ่งขึ้นต้นด้วยชื่อโดเมนที่ย้อนกลับของผู้ให้บริการ

const char EXAMPLE_EXTENSION_NAME[] = "com.example.my_extension";

ชื่อนี้ทำหน้าที่เป็นเนมสเปซสำหรับการดำเนินการและประเภทข้อมูล NNAPI ใช้ชื่อนี้เพื่อแยกความแตกต่างระหว่างส่วนขยายของผู้ให้บริการ

ระบบจะประกาศการดำเนินการและประเภทข้อมูลในลักษณะเดียวกับใน runtime/include/NeuralNetworks.h

enum {
    /**
     * A custom scalar type.
     */
    EXAMPLE_SCALAR = 0,

    /**
     * A custom tensor type.
     *
     * Attached to this tensor is {@link ExampleTensorParams}.
     */
    EXAMPLE_TENSOR = 1,
};

enum {
    /**
     * Computes example function.
     *
     * Inputs:
     * * 0: A scalar of {@link EXAMPLE_SCALAR}.
     *
     * Outputs:
     * * 0: A tensor of {@link EXAMPLE_TENSOR}.
     */
    EXAMPLE_FUNCTION = 0,
};

การดำเนินการของส่วนขยายสามารถใช้โอเปอเรนด์ประเภทใดก็ได้ รวมถึงโอเปอเรนด์ที่ไม่ใช่ส่วนขยายและโอเปอเรนด์จากส่วนขยายอื่นๆ เมื่อใช้ประเภทตัวถูกดำเนินการจากส่วนขยายอื่น ไดรเวอร์ต้องรองรับส่วนขยายอื่น

ส่วนขยายยังสามารถประกาศโครงสร้างที่กำหนดเองร่วมกับตัวถูกดำเนินการของส่วนขยาย

/**
 * Quantization parameters for {@link EXAMPLE_TENSOR}.
 */
typedef struct ExampleTensorParams {
    double scale;
    int64_t zeroPoint;
} ExampleTensorParams;

ใช้ส่วนขยายในไคลเอ็นต์ NNAPI

ไฟล์ runtime/include/NeuralNetworksExtensions.h (C API) รองรับส่วนขยายรันไทม์ ส่วนนี้จะแสดงภาพรวมของ C API

หากต้องการตรวจสอบว่าอุปกรณ์รองรับส่วนขยายหรือไม่ ให้ใช้ ANeuralNetworksDevice_getExtensionSupport

bool isExtensionSupported;
CHECK_EQ(ANeuralNetworksDevice_getExtensionSupport(device, EXAMPLE_EXTENSION_NAME,
                                                   &isExtensionSupported),
         ANEURALNETWORKS_NO_ERROR);
if (isExtensionSupported) {
    // The device supports the extension.
    ...
}

หากต้องการสร้างโมเดลที่มีตัวดำเนินการส่วนขยาย ให้ใช้ ANeuralNetworksModel_getExtensionOperandType เพื่อรับประเภทตัวดำเนินการและเรียกใช้ ANeuralNetworksModel_addOperand

int32_t type;
CHECK_EQ(ANeuralNetworksModel_getExtensionOperandType(model, EXAMPLE_EXTENSION_NAME, EXAMPLE_TENSOR, &type),
         ANEURALNETWORKS_NO_ERROR);
ANeuralNetworksOperandType operandType{
        .type = type,
        .dimensionCount = dimensionCount,
        .dimensions = dimensions,
};
CHECK_EQ(ANeuralNetworksModel_addOperand(model, &operandType), ANEURALNETWORKS_NO_ERROR);

(ไม่บังคับ) ใช้ ANeuralNetworksModel_setOperandExtensionData เพื่อเชื่อมโยงข้อมูลเพิ่มเติมกับตัวถูกดำเนินการของส่วนขยาย

ExampleTensorParams params{
        .scale = 0.5,
        .zeroPoint = 128,
};
CHECK_EQ(ANeuralNetworksModel_setOperandExtensionData(model, operandIndex, &params, sizeof(params)),
         ANEURALNETWORKS_NO_ERROR);

หากต้องการสร้างโมเดลที่มีการดำเนินการขยาย ให้ใช้ ANeuralNetworksModel_getExtensionOperationType เพื่อรับประเภทการดำเนินการและเรียกใช้ ANeuralNetworksModel_addOperation

ANeuralNetworksOperationType type;
CHECK_EQ(ANeuralNetworksModel_getExtensionOperationType(model, EXAMPLE_EXTENSION_NAME, EXAMPLE_FUNCTION,
                                                        &type),
         ANEURALNETWORKS_NO_ERROR);
CHECK_EQ(ANeuralNetworksModel_addOperation(model, type, inputCount, inputs, outputCount, outputs),
         ANEURALNETWORKS_NO_ERROR);

เพิ่มการรองรับส่วนขยายไปยังไดรเวอร์ NNAPI

โปรแกรมควบคุมจะรายงานส่วนขยายที่รองรับผ่านเมธอด IDevice::getSupportedExtensions รายการที่ส่งคืนต้องมีรายการที่อธิบายส่วนขยายที่สนับสนุนแต่ละรายการ

Extension {
    .name = EXAMPLE_EXTENSION_NAME,
    .operandTypes = {
        {
            .type = EXAMPLE_SCALAR,
            .isTensor = false,
            .byteSize = 8,
        },
        {
            .type = EXAMPLE_TENSOR,
            .isTensor = true,
            .byteSize = 8,
        },
    },
}

จาก 32 บิตที่ใช้ระบุประเภทและการดำเนินการ บิตที่สูง Model::ExtensionTypeEncoding::HIGH_BITS_PREFIX จะเป็นคำนำหน้าของส่วนขยาย ส่วนบิตที่ต่ำ Model::ExtensionTypeEncoding::LOW_BITS_TYPE จะแสดงถึงประเภทหรือการดำเนินการของส่วนขยาย

เมื่อจัดการการดำเนินการหรือประเภทตัวถูกดำเนินการ ไดรเวอร์ต้องตรวจสอบคำนำหน้าส่วนขยาย หากคำนำหน้าส่วนขยายมีค่าที่ไม่ใช่ 0 ประเภทการดำเนินการหรือออปเรอเรนซ์จะเป็นประเภทส่วนขยาย หากค่าคือ 0 แสดงว่าการดำเนินการหรือประเภทออปเรอเรนซ์ไม่ใช่ประเภทส่วนขยาย

หากต้องการแมปคำนำหน้ากับชื่อส่วนขยาย ให้ค้นหาใน model.extensionNameToPrefix การแมปจากคํานําหน้าไปยังชื่อส่วนขยายเป็นการติดต่อแบบ 1 ต่อ 1 สําหรับโมเดลที่ระบุ ค่านำหน้าที่แตกต่างกันอาจสอดคล้องกับชื่อส่วนขยายเดียวกันในรูปแบบต่างๆ

ไดรเวอร์ต้องตรวจสอบการดำเนินการและประเภทข้อมูลของส่วนขยาย เนื่องจากรันไทม์ NNAPI ไม่สามารถตรวจสอบการดำเนินการและประเภทข้อมูลของส่วนขยายบางรายการได้

ตัวถูกดำเนินการของส่วนขยายอาจมีข้อมูลที่เชื่อมโยงใน operand.extraParams.extension ซึ่งรันไทม์ถือว่าเป็น BLOB ข้อมูลดิบของขนาดที่กำหนดเอง

ประเภทข้อมูลและการดำเนินการ OEM

NNAPI มีการดำเนินการ OEM และประเภทข้อมูล OEM เพื่ออนุญาตให้ผู้ผลิตอุปกรณ์ระบุฟังก์ชันการทำงานที่กำหนดเองสำหรับไดรเวอร์โดยเฉพาะ การดำเนินการและประเภทข้อมูลเหล่านี้ใช้โดยแอปพลิเคชันของ OEM เท่านั้น ความหมายของการดำเนินการและประเภทข้อมูล OEM จะเฉพาะเจาะจงสำหรับ OEM และอาจเปลี่ยนแปลงได้ทุกเมื่อ ระบบจะเข้ารหัสการดำเนินการและประเภทข้อมูลของ OEM โดยใช้ OperationType::OEM_OPERATION, OperandType::OEM และ OperandType::TENSOR_OEM_BYTE