1 /* 2 * Copyright (C) 2017 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package android.hardware.neuralnetworks@1.0; 18 19 import IExecutionCallback; 20 21 /** 22 * IPreparedModel describes a model that has been prepared for execution and 23 * is used to launch executions. 24 */ 25 interface IPreparedModel { 26 /** 27 * Launches an asynchronous execution on a prepared model. 28 * 29 * The execution is performed asynchronously with respect to the caller. 30 * execute must verify the inputs to the function are correct. If there is 31 * an error, execute must immediately invoke the callback with the 32 * appropriate ErrorStatus value, then return with the same ErrorStatus. If 33 * the inputs to the function are valid and there is no error, execute must 34 * launch an asynchronous task to perform the execution in the background, 35 * and immediately return with ErrorStatus::NONE. If the asynchronous task 36 * fails to launch, execute must immediately invoke the callback with 37 * ErrorStatus::GENERAL_FAILURE, then return with 38 * ErrorStatus::GENERAL_FAILURE. 39 * 40 * When the asynchronous task has finished its execution, it must 41 * immediately invoke the callback object provided as an input to the 42 * execute function. This callback must be provided with the ErrorStatus of 43 * the execution. 44 * 45 * Multiple threads can call the execute function on the same IPreparedModel 46 * object concurrently with different requests. 47 * 48 * @param request The input and output information on which the prepared 49 * model is to be executed. 50 * @param callback A callback object used to return the error status of 51 * the execution. The callback object's notify function must 52 * be called exactly once, even if the execution was 53 * unsuccessful. 54 * @return status Error status of the call, must be: 55 * - NONE if task is successfully launched 56 * - DEVICE_UNAVAILABLE if driver is offline or busy 57 * - GENERAL_FAILURE if there is an unspecified error 58 * - OUTPUT_INSUFFICIENT_SIZE if provided output buffer is 59 * not large enough to store the resultant values 60 * - INVALID_ARGUMENT if one of the input arguments is 61 * invalid 62 */ 63 execute(Request request, IExecutionCallback callback) 64 generates (ErrorStatus status); 65 }; 66
