Ver código fonte

Добавлено руководство пользователя и администратора

Вадим Королёв 2 semanas atrás
pai
commit
bc80a12473
1 arquivos alterados com 303 adições e 2 exclusões
  1. 303 2
      Пояснительная записка.odt

+ 303 - 2
Пояснительная записка.odt

@@ -123,6 +123,7 @@ Google Photos [2],
 автоматической компоновки результата.
 
 2 Проектирование информационной системы
+---------------------------------------
 
 При проектировании системы были выделены два типа
 пользователей: студенты и администраторы, а так же
@@ -406,7 +407,7 @@ text
 
 Путь к фотографии в медиатеке.
 
--
+UNIQUE
 
 Таблица В.2 — Словарь данных сущности Student
 
@@ -461,10 +462,310 @@ FOREIGN KEY
 
 student_id
 
-Int
+int
 
 Ссылается на студента, которому, как считает система,
 принадлежит данное лицо.
 
 FOREIGN KEY
 
+приложение г
+============
+
+(обязательное)
+
+ИНФОРМАЦИОННАЯ СИСТЕМА «ЛИЦО УСПЕХА»
+
+МОДУЛЬ «ИНТЕРФЕЙС ПОЛЬЗОВАТЕЛЯ»
+
+РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ
+
+ВЕРСИЯ 1.0
+
+2025
+
+1 Введение
+==========
+
+1.1 Область применения
+
+Областью применения Модуля является взаимодействие пользователя
+с системой.
+
+1.2 Краткое описание возможностей
+
+Информационная система «Лицо успеха» предназначена для
+обработки медиатеки техникума, поиска и идентификации
+лиц, найденных на фотографиях.
+
+В Модуле реализованы следующие возможности:
+
+Снятие фотографии пользователя;
+
+Автоматический поиск подключенных устройств внешнего хранения;
+
+Сохранение результата работы системы на внешнее хранилище.
+
+1.3 Уровень подготовки пользователя
+
+Пользователь должен иметь базовые навыки работы с компьютером.
+
+1.4 Перечень эксплуатационной документации, с которой необходимо
+ознакомиться пользователю
+
+Настоящее Руководство.
+
+2 Назначение и условия применения
+=================================
+
+Модуль «Интерфейс пользователя» в составе системы «Лицо успеха»
+предназначен для предоставления возможности пользователю
+взаимодействовать с системой. В модуле реализована
+возможность снятия фотографии и сохранения результата
+работы системы.
+
+Работа с Модулем доступна всем пользователям. Работа с Модулем
+доступна всегда, когда есть необходимость в получении или
+подаче информации.
+
+3 Подготовка к работе
+=====================
+
+Для работы с системой «Лицо успеха» необходимо следующее
+аппаратное обеспечение:
+
+• Внешнее хранилище данных, подключаемое по USB.
+
+4 Описание операций
+===================
+
+4.1 Выполняемые функции и задачи
+
+Модуль «Интерфейс пользователя» в составе системы «Лицо успеха»
+выполняет задачи, приведённые в таблице ниже:
+
+Таблица Г.1 — Описание функций и задач
+
+Задачи
+
+Описание
+
+Снятие фотографии
+
+Пользователю предоставляется возможность снять фотографию
+своего лица, с живым предпросмотром.
+
+Просмотр результата работы системы
+
+Пользователю предоставляется возможность просмотреть результат
+работы системы. Отображается до 6 фотографий.
+
+Сохранение результата работы системы
+
+Пользователю предоставляется возможность сохранить результат
+работы системы на внешнее хранилище. Хранилище должно быть
+подключено перед началом работы системы.
+
+4.2 Описание операций технологического процесса обработки
+данных, необходимых для выполнения задач
+
+Ниже приведено описание пользовательских операций для
+выполнения каждой из задач.
+
+Задача: «Снятие фотографии»
+
+Действия для выполнения:
+
+1 Нажать на кнопку «Начать»;
+
+2 Оставить своё лицо в кадре;
+
+3 Нажать на кнопку «Сфотографироваться»;
+
+Задача: «Просмотр результата работы системы»
+
+Действия для выполнения:
+
+1 Сфотографироваться;
+
+2 Подождать от 2 до 10 секунд;
+
+3 Просмотреть результат.
+
+Задача «Сохранение результата работы системы»
+
+Действия для выполнения:
+
+1 Подключить внешнее хранилище;
+
+2 Сфотографироваться;
+
+3 Нажать на кнопку «Сохранить»;
+
+4 Подтвердить местоположение файла;
+
+5 Отключить внешнее хранилище.
+
+5 Аварийные ситуации
+====================
+
+В случае возникновения ошибок при работе системы «Лицо успеха»,
+не описанных ниже в данном разделе, необходимо обращаться к
+сотруднику подразделения технической поддержки, либо к
+ответственному Администратору системы «Лицо успеха».
+
+Таблица Г.2 — Описание аварийных ситуаций
+
+Ошибка
+
+Описание ошибки
+
+Требуемые действия пользователя при возникновении ошибки
+
+USB хранилище не подключено
+
+Пользователь пытается начать работу с системой, не подключив
+внешнее хранилище данных.
+
+Подключить в терминал внешнее хранилище данных (флешка, ssd
+накопитель)
+
+На фотографии не обнаружено ни одного лица
+
+Системе не удалось распознать ни одного лица на сделанной
+фотографии.
+
+Принять другую позу лица, снять любые предметы одежды,
+закрывающие лицо.
+
+На фотографии обнаружено больше одного лица
+
+Система распознала на фотографии больше одного лица.
+
+Оставьте в кадре только одно лицо.
+
+Нет связанных с тобой фотографий
+
+Система распознала пользователя, но не нашла ни одной
+фотографии, на котором запечатлено его лицо.
+
+-
+
+приложение д
+
+(обязательное)
+
+ИНФОРМАЦИОННАЯ СИСТЕМА «ЛИЦО УСПЕХА»
+
+МОДУЛЬ «НЕЙРОДВИЖОК»
+
+РУКОВОДСТВО АДМИНИСТРАТОРА
+
+ВЕРСИЯ 1.0
+
+2025
+
+1 Введение
+
+Область применения: сбор фотографий медиатеки техникума.
+
+Краткое описание возможностей:
+
+Распознавание лиц на фотографиях;
+
+Идентификация людей на снимках, формирование выборки фотографий
+по снимку пользователя;
+
+Ведение базы данных;
+
+Развертывание HTTP API для взаимодействия с системой.
+
+Уровень подготовки пользователей: от пользователей требуются
+базовые знания работы с компьютером.
+
+Перечень эксплуатационной информации:
+
+uvicorn (https://www.uvicorn.org/)
+
+веб-сервер для развертывания интерфейса пользователя — apache
+(https://apache.org/)
+
+установка ssl сертификата для apache
+(https://losst.pro/ustanovka-ssl-sertifikata-apache-ot-lets-encrypt)
+
+2 Подготовка системы к работе
+=============================
+
+Система была протестирована, работает корректно в следующем
+окружении (таблица Д.1).
+
+Таблица Д.1 — Версии компонентов
+
+Компонент
+
+Версия
+
+Операционная система
+
+Ubuntu Linux, ядро 6.8.0-60-generic
+
+Разрядность процессора
+
+x64
+
+Веб-сервер
+
+Apache 2.4.58
+
+Версия python
+
+3.12.3
+
+Версия npm
+
+9.2.0
+
+Пакеты ОС
+
+build-essential python3-venv libopenblas-dev liblapack-dev
+net-tools
+
+Веб-браузер
+
+Firefox 137.0.2
+
+Версии пакетов python и node.js приведены репозиториях проекта
+и находятся по пути src/face-api/requirements.txt и
+src/web/package-lock.json соответственно.
+
+Для запуска системы, требуется выполнить следующие действия:
+
+1 Собрать все ресурсы пользовательского интерфейса в пакет с
+помощью команды npm run build, выгрузить пакет на
+веб-сервер. Пакет представляет собой папку (обычно
+создаётся под названием dist после выполнения команды).
+
+2 Так как интерфейс системы запускается как сайт, то подключение
+должно быть защищено, так как некоторые возможности системы
+недоступны без безопасного контекста исполнения. Для
+создания защищённого соединения, потребуется настройка
+apache для работы с SSL сертификатами.
+
+3 Запустить нейродвижок. Команда для запуска нейродвижка должна
+быть похоже на что-то подобное:
+
+uvicorn api:app --host 0.0.0.0 --port 8000 --ssl-keyfile <ПУТЬ К
+ФАЙЛУ .key> --ssl-certfile <ПУТЬ К ФАЙЛУ .pem>
+
+4 Запустить файловое API на клиенте. Файловое API требуется для
+сохранения результата работы системы. Скрипт запуска
+расположен по пути src/file-api/start.sh.
+
+Для проверки работы системы, необходимо открыть адрес, на
+котором развёрнут веб-сервер. Для проверки подключения
+внешнего хранилища, нужно нажать на кнопку «Начать». Если
+хранилище подключено, система покажет страницу снятия
+фотографии. Если система выдаёт результат слишком долго
+(больше 10 сек.), вероятнее всего, возникла проблема при
+запуске нейродвижка.
+