edit

README.md

@@ -1,13 +1,24 @@
----
-title: NoteMaker
-emoji: 🏢
-colorFrom: blue
-colorTo: yellow
-sdk: gradio
-sdk_version: 6.0.2
-app_file: app.py
-pinned: false
-short_description: Make your own notes
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# NoteMaker
+
+## Краткое описание
+
+Проект представляет собой систему, которая принимает на вход изображение с английским текстом
+и последовательно выполняет три шага: 
+- распознавание текста, 
+- анализ тональности текста, 
+- составление сжатого конспекта, 
+- озвучивание полученного конспекта.
+
+## Архитектура системы
+
+[Архитектура](UML.mmd)
+
+## Использованные модели
+
+Распознавание текста выполняется **EasyOCR**.
+
+Распознанный текст подаётся в модель **distilbert-base-uncased-finetuned-sst-2-english** для определения тональности.
+
+Для сжатия текста до конспекта используется модель **sshleifer/distilbart-cnn-12-6**. 
+
+Полученный конспект передаётся в модель **facebook/mms-tts-eng (VITS)**, которая генерирует аудио в формате WAV.

UML.mmd

@@ -0,0 +1,37 @@
+## Архитектура приложения
+
+```mermaid
+flowchart LR
+ subgraph UserBrowser["<br>"]
+        U["Пользователь"]
+  end
+ subgraph UI["Gradio UI"]
+        G["Интерфейс ввода и вывода"]
+  end
+ subgraph App["app"]
+        F["full_flow(изображение, макс_длина)"]
+        O["run_ocr(изображение)"]
+        C["run_text_classification(текст)"]
+        S["run_summarization(текст, макс_длина)"]
+        T["run_tts(конспект)"]
+  end
+ subgraph HFSpace["Hugging Face Space"]
+        UI
+        App
+  end
+ subgraph ExternalLibs["Внешние библиотеки"]
+        E["EasyOCR"]
+  end
+ subgraph HFHub["Трансформеры"]
+        M1["Трансформер-классификатор текста"]
+        M2["Трансформер для суммаризации"]
+        M3["Трансформер для озвучки"]
+  end
+    U <--> G
+    G --> F
+    F --> O & C & S & T
+    O --> E
+    C --> M1
+    S --> M2
+    T --> M3
+```