Merge pull request #6 from kavlab/mulyavin_aa_api

README.md

@@ -9,7 +9,7 @@ app_file: run.py
 pinned: false
 ---
 
-# Программная инженерия. Практическое задание №2
+# Программная инженерия. Практическое задание №2 и №3
 
 Приложение разработано с использованием фреймворка [Streamlit](https://streamlit.io/).
 Состоит из двух страниц и Главной страницы:
@@ -21,19 +21,26 @@ pinned: false
 3. Описание изображения - позволяет получить описание изображения на русском языке. Использует 1 модель:
     - Классификация и описание изображений
 
+API разработано с использованием фреймворка [FastAPI]('https://fastapi.tiangolo.com/'). API доступные для использования:
+1. ```/langdetector/detect``` - Определение языка текста
+2. ```/translator/translate``` - Перевод текста с языка Ru на En
+
 ## Используемые модели
 - Определение языка текста - [papluca/xlm-roberta-base-language-detection](https://huggingface.co/papluca/xlm-roberta-base-language-detection)
 - Перевод текста с языка Ru на En - [Helsinki-NLP/opus-mt-ru-en](https://huggingface.co/Helsinki-NLP/opus-mt-ru-en)
 - Озвучивание текста на английском языке - [microsoft/speecht5_tts](https://huggingface.co/microsoft/speecht5_tts)
 - Классификация и описание изображений. Модель описания изображения [Salesforce/blip-image-captioning-large](https://huggingface.co/Salesforce/blip-image-captioning-large)
 
-## Как запустить
+## Как запустить Web-приложение
 Запуск осуществляется через модуль streamlit:
 ```
 streamlit run run.py
 ```
 
-## Как использовать
+## Как запустить API-сервер
+```uvicorn api:app``` либо ```python api.py```
+
+## Как использовать Web-приложение
 После запуска приложение открывается на Главной странице. Выбор режима работы приложения доступен слева в меню
 
 ### Генератор аудио
@@ -46,3 +53,52 @@ streamlit run run.py
 Необходимо выбрать изображение и нажать кнопку "Получить описание изображения". В результате появится текстовое описание изображения на русском языке.
 
 ![Результат работы моделей "Классификации и описания изображений"](https://raw.githubusercontent.com/kavlab/urfu_iml_2023_1_3_hw2/main/zvereva_ev/image_result.jpg)
+
+### Как использовать API
+Описание методов API генерируется Swagger и доступно по адресу
+```
+<hots>/docs
+```
+
+#### Пример вызова сервиса Определение языка текста
+Вызвать url сервиса ```<host>/langdetector/detect``` методом POST
+
+![img.png](https://raw.githubusercontent.com/kavlab/urfu_iml_2023_1_3_hw2/main/mulyavin_aa/PostmanLangDetect.png)
+
+Передаваемые параметры:
+```
+{
+    "text": "Приветик от Мити кота"
+}
+```
+
+Результат выполнения:
+```
+{
+    "langs": [
+        {
+            "label": "bg",
+            "score": 0.9945043921470642
+        }
+    ]
+}
+```
+
+#### Пример вызова сервиса Перевод текста с языка Ru на En
+Вызвать url сервиса ```<host>/translator/translate``` методом POST
+
+![img.png](https://raw.githubusercontent.com/kavlab/urfu_iml_2023_1_3_hw2/main/mulyavin_aa/PostmanTranslate.png)
+
+Передаваемые параметры:
+```
+{
+    "text": "Приветик от Мити кота"
+}
+```
+
+Результат выполнения:
+```
+{
+    "text": "Hello from Michi Cat."
+}
+```

api.py

@@ -0,0 +1,50 @@
+import uvicorn
+from fastapi import FastAPI
+
+import mulyavin_aa.langdetector
+import mulyavin_aa.translator
+import mulyavin_aa.model.langdetector
+import mulyavin_aa.model.translator
+
+app = FastAPI()
+
+
+# Представление проекта урлом по умолчанию
+@app.get("/")
+async def root():
+    """Получение базовой информации об API"""
+    return {"message": "Проект ДЗ: Модуль 3. Разработка API для приложений искусственного интеллекта (vo_HW)",
+            "git": "https://github.com/kavlab/urfu_iml_2023_1_3_hw2",
+            "apis": [
+                {
+                    "descr": "API для определения языка текста ",
+                    "base_url": "/langdetector"
+                },
+                {
+                    "descr": "API для перевода текста из Ru в En",
+                    "base_url": "/translator"}
+            ]}
+
+
+@app.post("/langdetector/detect")
+def lang_detect(request: mulyavin_aa.model.langdetector.Request) \
+        -> mulyavin_aa.model.langdetector.Response:
+    """Определение языка текста"""
+    pipe = mulyavin_aa.langdetector.load_text_detection_model()
+    langs = pipe(request.text, )
+    return mulyavin_aa.model.langdetector.Response(langs=langs)
+
+
+@app.post("/translator/translate")
+def lang_detect(request: mulyavin_aa.model.translator.Request) \
+        -> mulyavin_aa.model.translator.Response:
+    """Перевод текста из Ru в En"""
+    pipe = mulyavin_aa.translator.load_text_translator_model()
+    text = mulyavin_aa.translator.translate_to_en(request.text, pipe)
+
+    return mulyavin_aa.model.translator.Response(text=text)
+
+
+# Запуск как приложения
+if __name__ == '__main__':
+    uvicorn.run(app, port=8000, host='127.0.0.1')

mulyavin_aa/langdetector.py

@@ -12,7 +12,9 @@ def load_text_detection_model() -> transformers.pipelines.base.Pipeline:
     return pipeline("text-classification", model="papluca/xlm-roberta-base-language-detection")
 
 
-def lang_detect(text: str, langdetector: transformers.pipelines.base.Pipeline) -> str | None:
+def lang_detect(text: str,
+                langdetector: transformers.pipelines.base.Pipeline,
+                is_any: bool = False) -> str:
     """
     Определение языка для введенного текста
     :param text: Текст
@@ -30,5 +32,7 @@ def lang_detect(text: str, langdetector: transformers.pipelines.base.Pipeline) -
         print(text_langs[i])
         if text_langs[i]['label'] in ['ru', 'en']:
             return text_langs[i]['label']
+        if is_any:
+            return text_langs[i]['label']
 
     return None

mulyavin_aa/model/langdetector.py

@@ -0,0 +1,17 @@
+from pydantic import BaseModel
+
+
+class Request(BaseModel):
+    """Структура запроса"""
+    text: str
+
+
+class LangInfo(BaseModel):
+    """Информация об определении языка"""
+    label: str
+    score: float
+
+
+class Response(BaseModel):
+    """Структура ответа"""
+    langs: list[LangInfo]

mulyavin_aa/model/translator.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel
+
+
+class Request(BaseModel):
+    """Структура запроса"""
+    text: str
+
+
+class Response(BaseModel):
+    """Структура ответа"""
+    text: str

requirements.txt

@@ -8,3 +8,6 @@ sacremoses==0.1.1
 translate==3.6.1
 fastapi==0.104.1
 uvicorn==0.24.0
+
+pillow~=10.1.0
+pydantic~=2.5.2