Описание функциональных характеристик

Программное обеспечение «Система нейросетевая Care Mentor AI» предназначена для анализа рентгенографических исследований различных модальностей и последующего формирования протокола по ним.



При этом система предоставляет следующие функциональные возможности для внешних информационных систем через RESTful API:
  1. Аутентификацию/Авторизацию в системе. Зарегистрированный пользователь системы (информационная система), может аутентифицироваться/авторизоваться в системе под данными, которые были выданы. Аутентификационные механизмы соответствуют стандарту JSON Web Token. После Аутентификацию/Авторизацию пользователя доступна возможность выполнять отправку исследований на обработку/анализ.
  2. Загрузку «Исследования» для обработки/анализа. Пользователю (информационная система), который авторизован в системе, доступна возможность отправлять исследования на обработку/анализ. Перед отправкой исследование его необходимо загрузить в систему используя соответствующий программный вызов API. После успешной загрузки всех файлов исследования его необходимо поставить в очередь на анализ.
  3. Создание «Записи на обработку/анализ» исследования. Пользователю (информационная система), который авторизован в системе, и который загрузил исследование в систему доступна возможность отправлять исследования на обработку/анализ. Для этого необходимо выполнить соответствующий программный вызов API. Далее необходимо дождаться результатов обработки/анализа исследования системой.
  4. Получение «Результата обработки/анализа». Пользователю (информационная система), который авторизован в системе, и который поставил исследование на обработку/анализ, дождался окончание обработки/анализа исследования (через статус о готовности результата), предоставляется возможность получения результата в машиночитаемом формате (JSON) или сообщение об ошибке.
  5. Получение списка «Записей на обработку/анализ». Пользователю (информационная система), который авторизован в системе, через вызов соответствующего программного интерфейса API, предоставляется возможность получить список всех исследований, которые были ранее отправлены на обработку/анализ и получить результаты по ним.


Информация, необходимая для установки ПО
Программное обеспечение «Система нейросетевая Care Mentor AI» предназначено для анализа рентгенографических исследований различных модальностей и последующего формирования протокола по ним.
«Система нейросетевая Care Mentor AI» может предоставляться в различных конфигурациях (облачное решение, локальная установка).
В случае «облачного решения», программное обеспечение распространяется в виде интернет-сервиса, специальные действия по установке программного обеспечения на стороне пользователя не требуются.
В случае «локальной установки» программное обеспечение разворачивается на оборудовании заказчика.

  • Поставка дистрибутива
Дистрибутив поставляется виде архивного файла (перед установкой необходимо распаковать) и который содержит все скрипты, модули, компоненты необходимые для развертывания
  • Программного обеспечения. Содержимое поставки (скрипы/компоненты):
    • *.sh – Различные скрипы установки
    • api_webserver – RESTful API
    • broker_mq – Брокер сообщений
    • db_nosql – NoSQL СУБД
    • db_sql – SQL СУБД
    • Python – Python
    • Pytorch – Фреймворк машинного обучения
    • tfs – Система для развертывания нейросетевых моделей
    • ml-xray* – Модели, отвечающие за модальность: Рентгены
    • ml-mammography* – Модели, отвечающие за модальность: ММГ
    • ml-ct* – КТ/низкодозные КТ
    • ml-mri* – МРТ
  • Предустановленное окружение
Программное обеспечение для функционирования серверных компонент системы должно соответствовать требованиям:
  • ОС: Linux Ubuntu 18.04 LTS и выше;
  • Web-server: Nginx 1.17 и выше;
  • СУБД PostgreSQL 12.1 и выше;
  • Docker 19.03.5 и выше.
При этом при развертывании программного-аппаратного комплекса долдны быть установлены и настроены необходимые драйвера и пакеты (CUDA, docker, docker-compose, nvidia-docker2, git, git-lfs etc).

Для проверки успешности установки необходимых компонент может быть использован скрипт "preinstall.sh". Результатом успешного выполнения считается проверка версий всех установленных компонентов.
Например:
Docker version 23.0.6, build ef23cbc
docker-compose version 1.28.4, build cabd5cfb
ii nvidia-docker2 2.13.0-1 all nvidia-docker CLI wrapper
Cuda compilation tools, release 12.1, V12.1.105

  • Инструкция по установке (базовая часть)

Запустить (после развертывания и настройки программного-аппаратного комплекса, на котором будет функционировать программное обеспечение), последовательно следующие скрипты из дистрибутива:

- preinstall.sh (после выполнения сервер будет перезагружен)
- base_install.sh

После успешной установки будет предоставлена ссылка на панель администратора, логин и пароль.
Например:
Please use the http://10.0.12.251/backend
Login: 'admin' Password: 'Iusi0ewpNQqcC8FXx9KLnmkdWw9EGx'

  • Инструкция по установке (компоненты обработки отдельных модальностей)
В зависимости от того, какие модальности будут обрабатываться программным обеспечением, они устанавливаются отдельными скриптами:
  • Рентгены, обработка РГ/ФЛГ лёгких
    Для установки используется скрипт - install_ml_xray.sh
Результатом успешного запуска считается подобное сообщение:
Creating volume "ml-xray_cache_result" with default driver
Creating ml-xray-tfs ... done
Creating ml-xray-seg-api ... done
Creating ml-xray-cls-api ... done
Конфигурационный файл - ml_xray/.env

  • Рентгены, обработка РГ стопы
Для установки используется скрипт - install_ml_xray_flatfoot.sh
Результатом успешного запуска считается подобное сообщение:
Creating ml-xray-flatfoot-api ... done
Creating ml-xray-flatfoot-tfs ... done
Конфигурационный файл - ml_xray_flatfoot/.env
  • ММГ, выявление рака молочной железы
Для установки используется скрипт - install_ml_mammography.sh
Результатом успешного запуска считается подобное сообщение:
Creating ml-mammography ... done
Конфигурационный файл - ml_mammography/.env
  • КТ/низкодозные КТ, выявление рака легких
Для установки используется скрипт - install_ml_ct_cancer.sh
Результатом успешного запуска считается подобное сообщение:
Creating ml-ct-cancer-nodule-cls-api ... done
Creating ml-ct-cancer-lobes-onko-seg ... done
Creating ml-ct-cancer-nodule-seg-api ... done
Конфигурационный файл - ml_ct_cancer/.env
  • КТ/низкодозные КТ, выявление COVID'а
Для установки используется скрипт - install_ml_ct_covid.sh
Результатом успешного запуска считается подобное сообщение:
Creating volume "ml-ct-covid_cache_result" with default driver
Creating ml-ct-covid-seg-api ... done
Creating ml-ct-covid-lobes-api ... done
Creating ml-ct-covid-filter-api ... done
Конфигурационный файл - ml_ct_covid/.env

  • Добавление пользователя для доступа к системе через RESTful API
  • Чтобы создать пользователя, необходимо перейти по ссылке и авторизоваться под учетными данными, представленными в пункте «Инструкция по установке (базовая часть)»:
Далее:
  • перейти в меню "Пользователи";
  • нажать "Новый пользователь";
  • заполнить поля "Имя", "Фамилия", "Email", "Создать пароль", "Подтверждение пароля";
  • снять radio button напротив "Отправить приглашение по почте";
  • поставить radio button напротив "Registered";
  • нажать кнопку "Создать";
  • в появившемся предупреждающем сообщение выбрать "Активировать этого пользователя вручную".


Эксплуатация ПО


Программное обеспечение «Система нейросетевая Care Mentor AI» предназначена для анализа рентгенографических исследований различных модальностей и последующего формирования протокола по ним.

Взаимодействие с системой осуществляется исключительно через RESTful API, для чего используются внешние информационные системы или приложения (например, POSTMAN).

Базовый сценарий по взаимодействия по обработке/анализу Исследования в системе может быть представлен последовательным прохождением следующих шагов:

  1. Пройти аутентификацию/авторизацию

  2. Загрузить «Исследование»

  3. Создать «Запись на обработку» для Исследования

  4. Дождаться результатов обработки/анализа

  5. Получить и визуализировать результаты обработки/анализа

По ссылке находится архив с документацией, коллекциями/окружением, примерами исследований и JSON ответов, которые реализуют вышеописанный сценарий, а именно:
  1. файл "API_v2.pdf" - подробное описание API v2 для всех нейросетевых сервисов на уровне методов, с примерами
  2. файл "ENV API for Client (PRODUCTION).postman_environment.json" - POSTMAN окружение для PRODUCTION контура. Перед выполнением методов из POSTMAN коллекций, необходимо чтобы в POSTMAN окружении были заданы параметры ("login", "password") - для каждого клиента предоставляются отдельно.
  3. папка "modes" - данные для тестирования через POSTMAN
В папке данные сгруппированы по режимам (нейросетевым продуктам), при этом для каждого режима представлены:
  • файлы "*.postman_collection.json" - POSTMAN коллекция с вызовами методов по соответствующему режиму (все вызовы пронумерованы и выполняются последовательно);
  • папки "pat" и "no_pat" - примеры исследований с патологиями и без (перед выполнениям метода "02_Create_files" в параметр file[] необходимо добавить dicom файлы исследования из этих папок);
  • файлы "*.json" - примеры ответов на данные их папки "data", которые выдает нейросетевой сервис (результат вызова метода "04_Get_record").