Browse Source

Добавлено описание сообщений администратору

Вадим Королёв 1 month ago
parent
commit
ef43981f64
1 changed files with 96 additions and 2 deletions
  1. 96 2
      Пояснительная записка.odt

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

@@ -652,6 +652,7 @@ USB 
 -
 
 приложение д
+============
 
 (обязательное)
 
@@ -665,7 +666,25 @@ USB 
 
 2025
 
+Аннотация
+
+Документ представляет руководство по сбору и обработке
+фотографий в медиатеке техникума с использованием
+системы распознавания лиц. Описаны основные возможности
+системы, такие как идентификация людей, ведение базы данных
+и развертывание HTTP API. Уровень подготовки пользователей
+требует базовых навыков работы с компьютером.
+
+В разделе «Подготовка системы» указаны требования к
+программному обеспечению и шаги по настройке,
+включая сбор ресурсов интерфейса, настройку SSL, загрузку
+фотографий и запуск нейродвижка. Раздел "Аварийные ситуации"
+содержит информацию о возможных ошибках и рекомендации по их
+устранению. Документ служит справочным материалом для
+пользователей и администраторов системы.
+
 1 Введение
+==========
 
 Область применения: сбор фотографий медиатеки техникума.
 
@@ -751,13 +770,19 @@ src/web/package-lock.json 
 создания защищённого соединения, потребуется настройка
 apache для работы с SSL сертификатами.
 
-3 Запустить нейродвижок. Команда для запуска нейродвижка должна
+3 Загрузить фотографии в систему. За загрузку отвечает скрипт по
+пути src/face-api/scan-dir.py. Скрипт принимает как аргументы
+путь к базе данных (sqlite файл) и путь к папке, в которой
+хранятся фотографии. Скрипт рекурсивно собирает фотографии,
+распознаёт лица и загружает данные в систему.
+
+4 Запустить нейродвижок. Команда для запуска нейродвижка должна
 быть похоже на что-то подобное:
 
 uvicorn api:app --host 0.0.0.0 --port 8000 --ssl-keyfile <ПУТЬ К
 ФАЙЛУ .key> --ssl-certfile <ПУТЬ К ФАЙЛУ .pem>
 
-4 Запустить файловое API на клиенте. Файловое API требуется для
+5 Запустить файловое API на клиенте. Файловое API требуется для
 сохранения результата работы системы. Скрипт запуска
 расположен по пути src/file-api/start.sh.
 
@@ -769,3 +794,72 @@ uvicorn api:app --host 0.0.0.0 --port 8000 --ssl-keyfile <
 (больше 10 сек.), вероятнее всего, возникла проблема при
 запуске нейродвижка.
 
+3 Аварийные ситуации
+
+В процессе запуска или эскплуатации системы, может быть выдано
+множество сообщений об ошибках. В таблице Д.2 приведены
+описания сообщений и рекомендуемые действия при их
+получении.
+
+Таблица Д.2 — Описание сообщений
+
+Компонент системы
+
+Сообщение
+
+Рекомендуемые действия
+
+scan-dir.py
+
+Файл настроек по указанному пути не найден
+
+Убедиться что по указанному пути файл настроек существует
+
+Ключ настроек не найден
+
+В файле настроек отсутствует требуемый ключ
+
+Файл настроек содержит неверный JSON
+
+Исправить форматирование файла настроек
+
+Не удалось открыть файл базы данных
+
+Убедиться что путь к базе данных существует и есть права на его
+запись и чтение
+
+Каталог не найден
+
+Убедиться что путь к папке с фотографиями действительно
+существует
+
+Не обнаружено новых изображений
+
+- (не обработано ни одной отографии потому что новых изображений
+не найдено)
+
+api.py
+
+Started server process
+
+- (api успешно запущено)
+
+Finished server process
+
+- (api успешно выключено)
+
+Интерфейс пользователя
+
+На фотографии не обнаружено ни одного лица
+
+Попробовать сфотографироваться, убрав с лица закрывающие его
+предметы
+
+На фотографии обнаружено больше одного лица
+
+Оставить в кадре только одно лицо
+
+Нет связанных с тобой фотографий
+
+- (фотографий не найдено)
+