Начало работы

Processing Block API (API процессинг-блоков) является масштабируемым интерфейсом, замещающим существующее Legacy API для более легкой интеграции возможностей Face SDK в ваше приложение.

Основные возможности

• Объединение многочисленных компонентов в единую интеграцию
• Простота и легкость изучения
• Быстрое внедрение
• Долгосрочная поддержка и обновления

Требования

• Операционная система Windows x86 64-bit или Linux x86 64-bit.
• Установлен пакет Face SDK windows_x86_64 или linux_x86_64 (см. Начало работы).

Context-контейнер

Ключевой концепцией API процессинг-блоков является использование контейнеров Context.

Context — это гетерогенный контейнер, состоящий из набора иерархически организованных данных, представленных как пары ключ-значение. Ближайший аналог Context — объект JSON. Каждый объект Context может содержать: скалярный объект (integer, real, boolean, string), указатель на область памяти, массив объектов Context, ассоциативный контейнер пар <string, Context> с неограниченной вложенностью.

Как создать и использовать Context-контейнер

1. Создайте FacerecService.

2. Создайте Context-контейнер:

   C++

   auto array_elem0 = service->createContext();

   Python

   array_elem0 = service.createContext({})

   Flutter

   Context array_elem0 = service.createContext({});

   C#

   Context array_elem0 = service.CreateContext(new());

   Java

   Context array_elem0 = service.createContext();

   Kotlin

   val array_elem0 = service.createContext()

3. Общий набор операций с Context:

• создание ассоциативного контейнера по ключу ["key"] на пустом контейнере Context:

  C++

  array_elem0["name"] = "Julius Zeleny";      // передать string
  array_elem0["phone"] = 11111111111l;        // передать integer (long)
  array_elem0["social_score"] = 0.999;        // передать double
  array_elem0["verified"] = true;             // передать bool

  Python

  array_elem0["name"] = "Julius Zeleny"       # передать string
  array_elem0["phone"] = 11111111111          # передать integer
  array_elem0["social_score"] = 0.999         # передать double
  array_elem0["verified"] = True              # передать bool

  Flutter

  array_elem0["name"] = "Julius Zeleny";       // передать string
  array_elem0["phone"] = 11111111111;          // передать integer
  array_elem0["social_score"] = 0.999;         // передать double
  array_elem0["verified"] = true;              // передать bool

  C#

  array_elem0["name"] = "Julius Zeleny";       // передать string
  array_elem0["phone"] = 11111111111L;         // передать integer
  array_elem0["social_score"] = 0.999;         // передать double
  array_elem0["verified"] = true;              // передать bool

  Java

  array_elem0.get("name").setString("Julius Zeleny");       // передать string
  array_elem0.get("phone").setLong(11111111111l);           // передать integer
  array_elem0.get("social_score").setDouble(0.99);          // передать double
  array_elem0.get("verified").setBool(true);                // передать bool

  Kotlin

  array_elem0["name"].string = "Julius Zeleny"       // передать string
  array_elem0["phone"].long = 11111111111L           // передать integer
  array_elem0["social_score"].double = 0.999         // передать double
  array_elem0["verified"].bool = true                // передать bool

• геттеры:

  C++

  ASSERT_EQ( array_elem0["name"].getString(), "Julius Zeleny" );
  ASSERT_EQ( array_elem0["phone"].getLong(), 11111111111l );
  ASSERT_EQ( array_elem0["social_score"].getDouble(),  0.999 );
  ASSERT_EQ( array_elem0["verified"].getBool(), true );

  Python

  assert array_elem0["name"].get_value(), "Julius Zeleny"
  assert array_elem0["phone"].get_value() == 11111111111
  assert array_elem0["social_score"].get_value() ==  0.999
  assert array_elem0["verified"].get_value() == True

  Flutter

  assert (array_elem0["name"].get_value() == "Julius Zeleny");
  assert (array_elem0["phone"].get_value() == 11111111111);
  assert (array_elem0["social_score"].get_value() ==  0.999);
  assert (array_elem0["verified"].get_value() == true);

  C#

  Debug.Assert(array_elem0["name"].GetString() == "Julius Zeleny");
  Debug.Assert(array_elem0["phone"].GetLong() == 11111111111L);
  Debug.Assert(array_elem0["social_score"].GetDouble() ==  0.999);
  Debug.Assert(array_elem0["verified"].GetBool() == true);

  Java

  assertTrue(array_elem0.get("name").getString().equals("Julius Zeleny"));
  assertTrue(array_elem0.get("phone").getLong() == 11111111111l);
  assertTrue(array_elem0.get("social_score").getDouble() == 0.99);
  assertTrue(array_elem0.get("verified").getBool() == true);

  Kotlin

  assert(array_elem0["name"].string() == "Julius Zeleny")
  assert(array_elem0["phone"].long == 11111111111L)
  assert(array_elem0["social_score"].double ==  0.999)
  assert(array_elem0["verified"].bool == true)

• создание массива вызовом метода push_back на пустом контейнере Context:

  C++

  auto array == service->createContext();
  array.push_back(array_elem0);

  Python

  array = service.create_context([])
  array.push_back(array_elem0)

  Flutter

  Context array = service.createContext([]);
  array.pushBack(array_elem0);

  C#

  Context array == service->CreateContext(new());
  array.PushBack(array_elem0);

  Java

  Context array = service.createContext();
  array.pushBack(array_elem0);

  Kotlin

  val array = service.createContext()
  array.pushBack(array_elem0)

• итерации по массиву:

  C++

  
  // получить значение по индексу
  ASSERT_EQ( array[0]["phone"].getLong(), 11111111111l );
  
  // выполнить итерацию с индексом
  size_t array_sz = array.size();
  for(size_t i = 0; i < array_sz; ++i)
    array[i]["phone"];
  
  // или с итераторами
  for(auto iter = array.begin(); iter != array.end(); ++iter)
    (*iter)["phone"]; // возвращается вложенный Context
  
  // или с foreach
  for(auto val : array)
    val["phone"];

  Python

  # получить значение по индексу
  assert array[0]["phone"].get_value() == 11111111111
  
  # выполнить итерацию с индексом
  for i in range(len(array)):
      array[i]["phone"]
  
  # или с итераторами
  for elem in array:
      elem["phone"]

  Flutter

  // получить значение по индексу
  assert (array[0]["phone"].get_value() == 11111111111);
  
  // выполнить итерацию с индексом
  for (int i = 0; i < array.len(); i++)
    array[i]["phone"];

  C#

  // получить значение по индексу
  Debug.Assert(array[0]["phone"].GetLong() == 11111111111L);
  
  // выполнить итерацию с индексом
  for (long i = 0; i < array.Length(); i++)
    array[i]["phone"];

  Java

  // получить значение по индексу
  assertTrue(array.get(0).get("phone").getLong() == 11111111111l);
  
  // выполнить итерацию с индексом
  for (int i = 0; i < array.size(); i++)
    array.get(i).get("phone");

  Kotlin

  // получить значение по индексу
  assert(array[0]["phone"].long == 11111111111L);
  
  // выполнить итерацию с индексом
  for (i in 0 until array.size())
    array[i]["phone"]

• операции со вложенными ассоциативными контейнерами:

  C++

  auto full = service->createContext();
  full["friends"] = std::move(array); // использование семантики перемещения без копирования
  
  // доступ к вложенному объекту
  ASSERT_EQ( full["friends"][0]["social_score"].getDouble(), 0.999 );
  
  // перебор значений ассоциативного контейнера
  for(auto iter = full.begin(); iter != full.end(); ++iter) {
    iter.key(); // получить значение ключа из итератора
    (*iter)[0]["social_score"].getDouble(); // получить значение
  }
  
  // с foreach
  for(auto val : full)
    val[0]["social_score"].getDouble();

  Python

  full = service.create_context({})
  full["friends"] = array.to_dict()
  
  # доступ к вложенному объекту
  assert full["friends"][0]["social_score"].get_value() == 0.999
  
  # перебор значений ассоциативного контейнера
  for key in full.keys():
      full[key][0]["social_score"].get_value()
  

  Flutter

  Context full = service.createContext({});
  full["friends"] = array.toMap();
  
  // доступ к вложенному объекту
  assert (full["friends"][0]["social_score"].get_value() == 0.999);
  
  // перебор значений ассоциативного контейнера
  for (var key in full.getKeys())
    full[key][0]["social_score"].get_value();

  C#

  Context full = service.createContext(new());
  full["friends"] = array;
  
  // доступ к вложенному объекту
  Debug.Assert(full["friends"][0]["social_score"].GetDouble() == 0.999);
  
  // перебор значений ассоциативного контейнера
  foreach (String key in full.GetKeys())
    full[key][0]["social_score"].GetDouble();

  Java

  Context full = service.createContext();
  full.get("friends").setContext(array);
  
  // доступ к вложенному объекту
  assertTrue(full.get("friends").get(0).get("social_score").getDouble() == 0.999);
  
  // перебор значений ассоциативного контейнера
  for (String key : full.getKeys())
  {
    full.get(key).get(0).get("social_score").getDouble();
  }

  Kotlin

  val full = service.createContext()
  full["friends"].setContext(array)
  
  // доступ к вложенному объекту
  assert(full["friends"][0]["social_score"].double == 0.999)
  
  // перебор значений ассоциативного контейнера
  for (key in full.keys)
  {
    full[key][0]["social_score"].double
  }
  

• другие удобные методы Context:

  C++

  void clear();
  bool contains(const std::string& key);       // для ассоциативного контейнера
  Context operator[](size_t index);            // для последовательного массива, элемент с указанием доступа и проверкой границ
  Context operator[](const std::string& key);  // для ассоциативного контейнера, доступ или вставка данных
  Context at(const std::string& key);          // для ассоциативного контейнера, с проверкой границ
  size_t size();                               // возвращается число элементов контейнера
  bool isNone();                               // проверка на пустоту
  bool isArray();                              // проверка на последовательный массив
  bool isObject();                             // проверка на ассоциативный контейнер
  bool isLong(), isDouble(), isString(), isBool(); // проверка на содержание скалярного типа данных

  Python

  def to_dict(self) -> dict                          # преобразует context в словарь
  def is_none(self) -> bool                          # проверка на пустоту
  def is_array(self) -> bool                         # проверка на последовательный массив
  def is_object(self) -> bool                        # проверка на ассоциативный контейнер
  def is_long, is_double, is_string, is_bool -> bool # проверка на содержание скалярного типа данных

  Flutter

  Context operator[](int index)                // для последовательного массива, элемент с указанием доступа и проверкой границ
  Context operator[](String key)               // для ассоциативного контейнера, доступ или вставка данных
  int len()                                    // возвращается число элементов контейнера
  bool is_none()                               // проверка на пустоту
  bool is_array()                              // проверка на последовательный массив
  bool is_object()                             // проверка на ассоциативный контейнер
  bool is_long(), is_double(), is_string(), is_bool() // проверка на содержание скалярного типа данных

  C#

  bool Contains(string key);                   // для ассоциативного контейнера
  Context this[int index];                     // для последовательного массива, элемент с указанием доступа и проверкой границ
  Context this[string key];                    // для ассоциативного контейнера, доступ или вставка данных
  Context GetByKey(string key);               // для ассоциативного контейнера, с проверкой границ
  Context GetByIndex(int index);               // для ассоциативного контейнера, с проверкой границ
  ulong Length();                              // возвращается число элементов контейнера
  bool IsNone();                               // проверка на пустоту
  bool IsArray();                              // проверка на последовательный массив
  bool IsObject();                             // проверка на ассоциативный контейнер
  bool IsLong(), IsDouble(), IsString(), IsBool(); // проверка на содержание скалярного типа данных

  Java

  void clear();
  boolean contains(String key);                   // для ассоциативного контейнера
  Context get(long index);                        // для последовательного массива, элемент с указанием доступа и проверкой границ
  Context get(String key);                        // для ассоциативного контейнера, доступ или вставка данных
  long size();                                    // возвращается число элементов контейнера
  boolean isNone();                               // проверка на пустоту
  boolean isArray();                              // проверка на последовательный массив
  boolean isObject();                             // проверка на ассоциативный контейнер
  boolean isLong(), isDouble(), isString(), isBool(); // проверка на содержание скалярного типа данных

  Kotlin

  fun clear();
  fun contains(key: String?): Boolean?                 // для ассоциативного контейнера
  fun get(index: Long): Context?                       // для последовательного массива, элемент с указанием доступа и проверкой границ
  fun get(key: String): Context?                       // для ассоциативного контейнера, доступ или вставка данных
  fun size(): Long                                     // возвращается число элементов контейнера
  fun isNone(): Boolean?                               // проверка на пустоту
  fun isArray(): Boolean?                              // проверка на последовательный массив
  fun isObject(): Boolean?                             // проверка на ассоциативный контейнер
  fun isLong(): Boolean? isDouble(), isString(), isBool(); // проверка на содержание скалярного типа данных

• методы FacerecService связанные с Context:

  C++

  // получение Context из файла изображения
  pbio::Context createContextFromEncodedImage(const uint8_t* data, uint64_t dataSize);
  pbio::Context createContextFromEncodedImage(const std::vector<uint8_t>& data);
  pbio::Context createContextFromEncodedImage(const std::string& data);
  pbio::Context createContextFromEncodedImage(const std::vector<char>& data);
  
  // получение Context из байтов изображения
  pbio::Context createContextFromFrame(uint8_t* data, int32_t width, int32_t height, pbio::Context::Format format, int32_t baseAngle);

  Python

  # получение Context из файла изображения
  def create_context_from_encoded_image(self, data: bytes) -> Context
  
  # получение Context из байтов изображения
  def create_context_from_frame(self, data: bytes, width: int, height: int, format: ContextFormat, base_angle: int) -> Context:

  Flutter

  // получение Context из файла изображения
  Context createContextFromEncodedImage(Uint8List data);
  
  // получение Context из байтов изображения
  Context createContextFromFrame(Uint8List data, int width, int height, {ContextFormat format, int baseAngle});

  C#

  // получение Context из файла изображения
  Context CreateContextFromImage(byte[] data);
  
  // получение Context из байтов изображения
  Context CreateContextFromFrame(byte[] data, int width, int height, Context.Format format, int baseAngle);

  Java

  // получение Context из файла изображения
  Context createContextFromEncodedImage(byte[] data);
  
  // получение Context из байтов изображения
  Context createContextFromFrame(byte[] data, int width, int height, Context.Format format, int baseAngle);

  Kotlin

  // получение Context из файла изображения
  fun createContextFromEncodedImage(data: ByteArray?): Context?
  
  // получение Context из байтов изображения
  fun createContextFromFrame(data: ByteArray?, width: Int, height: Int, format: Context.Format?, baseAngle: Int): Context?

Бинарный формат изображений

Большинство процессинг-блоков выполняют операции с Context-контейнерами, содержащими изображения в бинарном формате:

{
    "image" : {
        "format": "NDARRAY",
        "blob": "data pointer",
        "dtype": "uint8_t",
        "shape": [height, width, channels]
    }
}

Ключ "blob" содержит умный указатель на данные. Указатель устанавливается функцией void Context::setDataPtr(void* ptr, int copy_sz), где copy_sz — размер памяти в байтах, который будет скопирован, и затем автоматически освобождается, когда заканчивается время жизни объекта Context.

Копирование не будет выполнено, если в качестве аргумента copy_sz будет передан 0. В этом случае объект Context не контролирует время жизни объекта, на который он указывает. Вы также можете аллоцировать "сырую" память, например, чтобы скопировать данные позже, передавая nullptr и размер в качестве аргументов setDataPtr.

Ключ "dtype" может содержать одно из следующих значений: "uint8_t", "int8_t", "uint16_t", "int16_t", "int32_t", "float", "double". Каждому значению соответствует определенный тип OpenCV: CV_8U, CV_8S, CV_16U, CV_16S, CV_32S, CV_32F, CV_64F.

Создание Context-контейнера c RGB-изображением

1. Создайте FacerecService.

C++

2. Прочитайте изображение из файла:

// read the image from file
std::string inputImagePath = "{path_to_image}";
std::ifstream imageFile(inputImagePath, std::ios::binary);
std::istreambuf_iterator<char> start(file);
std::vector<char> imageData(start, std::istreambuf_iterator<char>());

3 Создайте контейнер с изображением

pbio::Context ioData = service->createContextFromEncodedImage(imageData);

Python

2. Прочитайте изображение из файла:

# read the image from file
input_image_path = "{path_to_image}"
image_data = bytes()
with open(input_image_path, "rb") as image_file:
    image_data = image_file.read()

3. Создайте контейнер с изображением:

ioData = service.create_context_from_encoded_image(image_data)

Flutter

2. Прочитайте изображение из файла:

// read the image from file
File file = File("{imagePath}");
final Uint8List bytes = await file.readAsBytes();

3. Создайте контейнер с изображением:

Context ioData = service.createContextFromEncodedImage(bytes);

C#

2. Прочитайте изображение из файла:

// read the image from file
string inputImagePath = "<path_to_image>"
byte[] imageData = File.ReadAllBytes(inputImagePath);

3. Создайте контейнер с изображением:

Context ioData = service.CreateContextFromImage(imageData);

Java

2. Прочитайте изображение из файла:

// read the image from file
final String inputImagePath = "<path_to_image>";
byte[] imageData = Files.readAllBytes(Paths.get(inputImagePath));

3. Создайте контейнер с изображением:

Context ioData = service.createContextFromEncodedImage(imageData);

Kotlin

2. Прочитайте изображение из файла:

const val inputImagePath = "<path_to_image>"
var imageData: ByteArray = Files.readAllBytes(Paths.get(inputImagePath))

3. Создайте контейнер с изображением:

var ioData: Context = service.createContextFromEncodedImage(imageData)

Процессинг-блоки

Типы процессинг-блоков

• FACE_DETECTOR
• HUMAN_BODY_DETECTOR
• HUMAN_POSE_ESTIMATOR
• OBJECT_DETECTOR
• FACE_FITTER
• EMOTION_ESTIMATOR
• AGE_ESTIMATOR
• GENDER_ESTIMATOR
• MASK_ESTIMATOR
• GLASSES_ESTIMATOR
• LIVENESS_ESTIMATOR
• QUALITY_ASSESSMENT_ESTIMATOR
• FACE_TEMPLATE_EXTRACTOR
• TEMPLATE_INDEX
• MATCHER_MODULE
• VERIFICATION_MODULE

примечание

Примеры использования Processing Block API демонстрируются в:

• Сэмпле processing_block_demo на C++
• Примерах examples/python/processing_blocks/ на Python
• Сэмпле processing_block_demo на Flutter

Настраиваемые параметры процессинг-блоков

• unit_type: string — главный параметр процессинг-блока, определяет тип создаваемого модуля.
• modification: string — опциональный параметр, определяет модификацию процессинг-блока. Если не указан, то будет использоваться значение по умолчанию.
• version: int64 — опциональный параметр, определяет версию модификации процессинг-блока. Если не указан, то будет использоваться значение по умолчанию.
• model_path: string — опциональный параметр, определяет путь до модели процессинг-блока. Если не указан, то будет использоваться значение по умолчанию.
• use_cuda: bool — опциональный параметр, отвечает за запук процессинг-блока на GPU. Значение по умолчанию — false.
• use_legacy: bool — опциональный параметр, нужен для использования более старой билиотеки onnxruntime. Значение по умолчанию — false.
• ONNXRuntime — ключ для параметров конфигурации onnxruntime:
  • library_path: string — путь до библиотек onnxruntime, по умолчанию путь до директории с libfacerec.so.
  • intra_op_num_threads: int64 – число потоков для распараллеливания модуля, по умолчанию равно 1.

Создание процессинг-блока

1. Создайте Context-контейнер, укажите нужные вам параметры и передайте его в метод FacerecService.createProcessingBlock().

   C++

   // обязательно, укажите имя процессинг-блока
   auto configCtx = service->createContext();
   configCtx["unit_type"] = "{name_of_processing_block}";
   
   // если не указать, то будет использоваться значение по умолчанию
   configCtx["modification"] = "{modification}";
   
   // если не указать, то будет использоваться первая версия модификации
   configCtx["version"] = {version};
   
   // модели по умолчанию расположены в директории дистрибутива Face SDK: share/processing_block/{modification}/({version}/ или {version}.enc)
   // вы можете задать ваш собственный путь до модели
   configCtx["model_path"] = "{path_to_model_file}";
   
   // библиотека onnxruntime по умолчанию расположена в директории дистрибутива Face SDK: "lib" для платформы Linux или "bin" для платформы Windows
   // вы можете задать ваш собственный путь до библиотеки onnxruntime
   // если путь до библиотеки не указан, то будет использоваться стандартный порядок поиска, используемый в данной ОС
   configCtx["ONNXRuntime"]["library_path"] = "../lib"; // для Linux
   configCtx["ONNXRuntime"]["library_path"] = "../bin"; // для Windows
   
   // опционально, значение "true" для ускорения процессинг-блоков на GPU (только для блоков с поддержкой CUDA)
   configCtx["use_cuda"] = false;
   pbio::ProcessingBlock processing_block = service->createProcessingBlock(configCtx);

   Python

   configDict = {};
   # обязательно, укажите имя процессинг-блока
   configDict["unit_type"] = "{name_of_processing_block}"
   
   # если не указать, то будет использоваться значение по умолчанию
   configDict["modification"] = "{modification}"
   
   # если не указать, то будет использоваться первая версия модификации
   configDict["version"] = {version}
   
   # модели по умолчанию расположены в директории дистрибутива Face SDK: share/processing_block/{modification}/({version}/ или {version}.enc)
   # вы можете задать ваш собственный путь до модели
   configDict["model_path"] = "{path_to_model_file}"
   
   # библиотека onnxruntime по умолчанию расположена в директории дистрибутива Face SDK: "lib" для платформы Linux или "bin" для платформы Windows
   # вы можете задать ваш собственный путь до библиотеки onnxruntime
   # если путь до библиотеки не указан, то будет использоваться стандартный порядок поиска, используемый в данной ОС
   configDict["ONNXRuntime"]["library_path"] = "../lib" # для Linux
   configDict["ONNXRuntime"]["library_path"] = "../bin" # для Windows
   
   # опционально, значение "true" для ускорения процессинг-блоков на GPU (только для блоков с поддержкой CUDA)
   configDict["use_cuda"] = False
   
   processing_block = service.create_processing_block(configDict);

   Flutter

   Map<String, dynamic> configMap = {};
   // обязательно, укажите имя процессинг-блока
   configMap["unit_type"] = "{name_of_processing_block}";
   
   // если не указать, то будет использоваться значение по умолчанию
   configMap["modification"] = "{modification}";
   
   // если не указать, то будет использоваться первая версия модификации
   configMap["version"] = {version};
   
   // модели по умолчанию расположены в директории дистрибутива Face SDK: share/processing_block/{modification}/({version}/ или {version}.enc)
   // вы можете задать ваш собственный путь до модели
   configMap["model_path"] = "{path_to_model_file}";
   
   processing_block = service.createProcessingBlock(configMap);

   C#

   Dictionary<object, object> configDict = new Dictionary<object, object>();
   // обязательно, укажите имя процессинг-блока
   configDict["unit_type"] = "<name_of_processing_block>";
   
   // если не указать, то будет использоваться значение по умолчанию
   configDict["modification"] = "<modification>";
   
   // если не указать, то будет использоваться первая версия модификации
   configDict["version"] = <version>;
   
   // модели по умолчанию расположены в директории дистрибутива Face SDK: share/processing_block/<modification>/(<version>/ или <version>.enc)
   // вы можете задать ваш собственный путь до модели
   configDict["model_path"] = "<path_to_model_file>";
   
   // библиотека onnxruntime по умолчанию расположена в директории дистрибутива Face SDK: "lib" для платформы Linux или "bin" для платформы Windows
   // вы можете задать ваш собственный путь до библиотеки onnxruntime
   // если путь до библиотеки не указан, то будет использоваться стандартный порядок поиска, используемый в данной ОС
   configDict["ONNXRuntime"]["library_path"] = "../lib"; # для Linux
   configDict["ONNXRuntime"]["library_path"] = "../bin"; # для Windows
   
   // опционально, значение "true" для ускорения процессинг-блоков на GPU (только для блоков с поддержкой CUDA)
   configDict["use_cuda"] = False;
   ProcessingBlock processingBlock = service.CreateProcessingBlock(configDict);

   Java

   // обязательно, укажите имя процессинг-блока
   Context configCtx = service.createContext();
   configCtx.get("unit_type").setString("{name_of_processing_block}");
   
   // если не указать, то будет использоваться значение по умолчанию
   configCtx.get("modification").setString("{modification}");
   
   // если не указать, то будет использоваться первая версия модификации
   configCtx.get("version").setLong({version});
   
   // модели по умолчанию расположены в директории дистрибутива Face SDK: share/processing_block/{modification}/({version}/ или {version}.enc)
   // вы можете задать ваш собственный путь до модели
   configCtx.get("model_path").setString("{path_to_model_file}");
   
   // библиотека onnxruntime по умолчанию расположена в директории дистрибутива Face SDK: "lib" для платформы Linux или "bin" для платформы Windows
   // вы можете задать ваш собственный путь до библиотеки onnxruntime
   // если путь до библиотеки не указан, то будет использоваться стандартный порядок поиска, используемый в данной ОС
   configCtx.get("ONNXRuntime").get("library_path").setString("../lib"); // для Linux
   configCtx.get("ONNXRuntime").get("library_path").setString("../bin"); // для Windows
   
   // опционально, значение "true" для ускорения процессинг-блоков на GPU (только для блоков с поддержкой CUDA)
   configCtx["use_cuda"] = false;
   configCtx.get("use_cuda").setBool(false);
   
   ProcessingBlock processing_block = service.createProcessingBlock(configCtx);

   Kotlin

   // обязательно, укажите имя процессинг-блока
   val configCtx = service.createContext();
   configCtx["unit_type"].string = "{name_of_processing_block}"
   
    // если не указать, то будет использоваться значение по умолчанию
   configCtx["modification"].string  = "{modification}"
   
   // если не указать, то будет использоваться первая версия модификации
   configCtx["version"]. long = {version}
   
   // модели по умолчанию расположены в директории дистрибутива Face SDK: share/processing_block/{modification}/({version}/ или {version}.enc)
   // вы можете задать ваш собственный путь до модели
   configCtx["model_path"]).string = "{path_to_model_file}"
   
   val processing_block = service.createProcessingBlock(configCtx);

2. Подготовьте входной Context-контейнер с изображением и передайте в процессинг-блок.

   C++

   std::string inputImagePath = "{path_to_image}";
   std::ifstream imageFile(inputImagePath, std::ios::binary);
   std::istreambuf_iterator<char> start(file);
   std::vector<char> imageData(start, std::istreambuf_iterator<char>());
   
   // формирование входного контейнера Context
   pbio::Context ioData = service->createContextFromEncodedImage(imageData);
   
   // Вызов процессинг-блока
   processing_block(ioData);

   Python

   input_image_path = "{path_to_image}"
   image_data = bytes()
   
   with open(input_image_path, "rb") as image_file:
     image_data = image_file.read()
   
   # Формирование входного контейнера Context
   ioData = service.create_context_from_encoded_image(image_data)
   
   # Вызов процессинг-блока
   processing_block(ioData);

   Flutter

   File file = File("{imagePath}");
   final Uint8List bytes = await file.readAsBytes();
   Context imgCtx =
   
   // Формирование входного контейнера Context
   Context ioData = service.createContextFromEncodedImage(bytes);
   
   // Вызов процессинг-блока
   processing_block.process(ioData);

   C#

   string inputImagePath = "<path_to_image>"
   byte[] imageData = File.ReadAllBytes(inputImagePath);
   
   // формирование контейнера Context с бинарным изображением
   Context ioData = service.CreateContextFromImage(imageData);
   
   // Вызов процессинг-блока
   processingBlock.Invoke(ioData);

   Java

   final String inputImagePath = "<path_to_image>";
   byte[] imageData = Files.readAllBytes(Paths.get(inputImagePath));
   
   // формирование входного контейнера Context
   Context ioData = service.createContextFromEncodedImage(imageData);
   
   // Вызов процессинг-блока
   processing_block.process(ioData);

   Kotlin

   val inputImagePath = "<path_to_image>"
   val imageData: ByteArray = Files.readAllBytes(Paths.get(inputImagePath))
   
   // формирование входного контейнера Context
   val ioData = service.createContextFromEncodedImage(imageData);
   
   // Вызов процессинг-блока
   processing_block.process(ioData);

Ускорение на GPU

Процессинг-блоки могут быть использованы с ускорением на GPU. Для этого необходимо определить ключ "use_cuda" со значением true для Context-контейнера процессинг-блока.

Для запуска процессинг-блоков на CUDA версии 10.1 необходимо дополнительно определить ключ "use_legacy" со значением true для Context-контейнера процессинг-блока. (См. Настраиваемые параметры процессинг-блоков).

Поддерживаемые версии CUDA см. на странице Системные требования для использования GPU