disk0dancer commited on
Commit
cdfc388
·
verified ·
1 Parent(s): 7cdcd70

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -1
README.md CHANGED
@@ -10,4 +10,29 @@ pinned: false
10
  license: mit
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  license: mit
11
  ---
12
 
13
+ # Gradio demo application
14
+
15
+ Эта директория содержит код демонстрационного веб приложения с веб интерфейсом для взаимодействия с моделью.
16
+
17
+ Приложение развернуто на бесплатном хостинге: [Hugging Face](https://huggingface.co/spaces/disk0dancer/demo-rubert-base-finetuned-pos)
18
+
19
+ # Описание работы приложения
20
+
21
+ - Пользователь вводит в поле `Input` текст на русском языке
22
+ - Приложение выполняет REST запрос к модели развернтой на бесплатном хостинге: [Hugging Face](https://huggingface.co/disk0dancer/ruBert-base-finetuned-pos)
23
+ - Приложение получает ответ от сервера
24
+ - Приложение выводит скелетную структуру предложения в поле `Output`
25
+
26
+ # Описание файлов
27
+
28
+ - app.py - код веб-приложения
29
+ - /tests - содержит модульные тесты и интеграционные тесты веб-приложения, написаные с фреймворком PyTest
30
+ - requirements.txt - требования к наличию установленных модулей Python 3 для запуска веб-приложения
31
+ - Dockerfile - инструкции к запуску контейнера веб-приложения
32
+ - docker-compose.yml - инструкции к запуску сети с контейнером веб-приложения
33
+
34
+ # Запуск
35
+
36
+ Требуется: установленный на машине Docker, установить переменные окружения: `AUTH_TOKEN`, `API_URL`
37
+
38
+ ```docker compose up -d```