Update README.md

README.md

@@ -1,37 +1,55 @@
----
-title: AnyNameHack
-emoji: 🔥
-colorFrom: purple
-colorTo: blue
-sdk: streamlit
-app_file: app.py
-pinned: false
----
+# Система предсказаний поисковых тегов
 
-# Configuration
+## Структура проекта
 
-`title`: _string_  
-Display title for the Space
+Для того, чтобы вам было проще ориентироваться в репозитории, ниже приведён список файлов и их назначение:
 
-`emoji`: _string_  
-Space emoji (emoji-only character allowed)
+- `app.py` - основной файл приложения для HF Spaces
+- `indexer.py` - реализация класса для работы с FAISS (заполнение индекса, поиск, подбор тегов)
+- `new_index.index`, `new_vectors.pkl` - файлы для инициализации модели обученными значениями
+- `utils.py` - вспомогательные функции (отбор тегов)
 
-`colorFrom`: _string_  
-Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray)
+## Примеры использования
 
-`colorTo`: _string_  
-Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray)
+### Инициализация индекса готовыми значениями
 
-`sdk`: _string_  
-Can be either `gradio` or `streamlit`
+```python
+from indexer import FAISS
 
-`sdk_version` : _string_  
-Only applicable for `streamlit` SDK.  
-See [doc](https://hf.co/docs/hub/spaces) for more info on supported versions.
+indexer_vector_dim = 384
+indexer = FAISS(indexer_vector_dim)
+indexer.init_index('new_index.index')
+indexer.init_vectors('new_vectors.pkl')
+```
 
-`app_file`: _string_  
-Path to your main application file (which contains either `gradio` or `streamlit` Python code).  
-Path is relative to the root of the repository.
+### Запрос к индексу
 
-`pinned`: _boolean_  
-Whether the Space stays on top of your list.
+```python
+indexer.suggest_tags("куртка оверсайз")
+```
+
+### Заполнение индекса
+
+Пусть у нас есть список запросов `queries` и `DataFrame` `popularities`, в котором присутствуют поля `query` и `query_popularity`, тогда мы можем самостоятельно заполнить поисковый индекс:
+
+```python
+indexer.fill(queries, popularities)
+```
+
+### Сохранение заполненного индекса
+
+Если мы не хотим потерять заполненные данные, их можно сохранить и затем переиспользовать:
+
+```python
+indexer.save_vectors("my_vectors.pkl")
+indexer.save_index("my_index.index")
+```
+# Запуск из Spaces
+
+Есть возможно запустить прям в браузере. Перейти во вкладку App (это около Files and Versions) и дождаться строки. Дальше можно написать свой запрос и будет выведен результат. Возможно через некоторое время, так как это платформа бесплатная. Но мы удовлетворяем требованиям к допустимым мощностям
+
+# Запуск из консоли, если скачать репозиторий
+
+```bash
+streamlit run app.py
+```