nnfw.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * 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.
 */
 
#ifndef __NNFW_H__
#define __NNFW_H__
 
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct nnfw_session nnfw_session;
 
typedef enum
{
  NNFW_TYPE_TENSOR_FLOAT32 = 0,
  NNFW_TYPE_TENSOR_INT32 = 1,
  NNFW_TYPE_TENSOR_QUANT8_ASYMM = 2,
  NNFW_TYPE_TENSOR_BOOL = 3,
 
  NNFW_TYPE_TENSOR_UINT8 = 4,
 
  NNFW_TYPE_TENSOR_INT64 = 5,
 
  NNFW_TYPE_TENSOR_QUANT8_ASYMM_SIGNED = 6,
 
  NNFW_TYPE_TENSOR_QUANT16_SYMM_SIGNED = 7,
 
} NNFW_TYPE;
 
typedef enum
{
  NNFW_STATUS_NO_ERROR = 0,
  NNFW_STATUS_ERROR = 1,
  NNFW_STATUS_UNEXPECTED_NULL = 2,
  NNFW_STATUS_INVALID_STATE = 3,
  NNFW_STATUS_OUT_OF_MEMORY = 4,
  NNFW_STATUS_INSUFFICIENT_OUTPUT_SIZE = 5,
  NNFW_STATUS_DEPRECATED_API = 6,
} NNFW_STATUS;
 
typedef enum
{
  NNFW_LAYOUT_NONE = 0,
  NNFW_LAYOUT_CHANNELS_LAST = 1,
  NNFW_LAYOUT_CHANNELS_FIRST = 2,
} NNFW_LAYOUT;
 
typedef enum
{
  NNFW_INFO_ID_VERSION = 0,
} NNFW_INFO_ID;
 
#define NNFW_MAX_RANK (6)
 
typedef struct nnfw_tensorinfo
{
  NNFW_TYPE dtype;
  int32_t rank;
  int32_t dims[NNFW_MAX_RANK];
} nnfw_tensorinfo;
 
NNFW_STATUS nnfw_create_session(nnfw_session **session);
 
NNFW_STATUS nnfw_close_session(nnfw_session *session);
 
NNFW_STATUS nnfw_load_model_from_file(nnfw_session *session, const char *path);
 
NNFW_STATUS nnfw_apply_tensorinfo(nnfw_session *session, uint32_t index,
                                  nnfw_tensorinfo tensor_info);
 
NNFW_STATUS nnfw_set_input_tensorinfo(nnfw_session *session, uint32_t index,
                                      const nnfw_tensorinfo *tensor_info);
 
NNFW_STATUS nnfw_prepare(nnfw_session *session);
 
NNFW_STATUS nnfw_run(nnfw_session *session);
 
NNFW_STATUS nnfw_run_async(nnfw_session *session);
 
NNFW_STATUS nnfw_await(nnfw_session *session);
 
NNFW_STATUS nnfw_set_input(nnfw_session *session, uint32_t index, NNFW_TYPE type,
                           const void *buffer, size_t length);
 
NNFW_STATUS nnfw_set_output(nnfw_session *session, uint32_t index, NNFW_TYPE type, void *buffer,
                            size_t length);
 
NNFW_STATUS nnfw_input_size(nnfw_session *session, uint32_t *number);
 
NNFW_STATUS nnfw_output_size(nnfw_session *session, uint32_t *number);
 
NNFW_STATUS nnfw_set_input_layout(nnfw_session *session, uint32_t index, NNFW_LAYOUT layout);
 
NNFW_STATUS nnfw_set_output_layout(nnfw_session *session, uint32_t index, NNFW_LAYOUT layout);
 
NNFW_STATUS nnfw_input_tensorinfo(nnfw_session *session, uint32_t index,
                                  nnfw_tensorinfo *tensor_info);
 
NNFW_STATUS nnfw_output_tensorinfo(nnfw_session *session, uint32_t index,
                                   nnfw_tensorinfo *tensor_info);
 
NNFW_STATUS nnfw_set_available_backends(nnfw_session *session, const char *backends);
 
NNFW_STATUS nnfw_set_op_backend(nnfw_session *session, const char *op, const char *backend);
 
NNFW_STATUS nnfw_query_info_u32(nnfw_session *session, NNFW_INFO_ID id, uint32_t *val);
 
NNFW_STATUS nnfw_set_workspace(nnfw_session *session, const char *dir);
 
#ifdef __cplusplus
}
#endif
 
#endif