Danil commited on
Commit
ed526e6
1 Parent(s): 8a1c948

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -55
README.md DELETED
@@ -1,55 +0,0 @@
1
- # Система предсказаний поисковых тегов
2
-
3
- ## Структура проекта
4
-
5
- Для того, чтобы вам было проще ориентироваться в репозитории, ниже приведён список файлов и их назначение:
6
-
7
- - `app.py` - основной файл приложения для HF Spaces
8
- - `indexer.py` - реализация класса для работы с FAISS (заполнение индекса, поиск, подбор тегов)
9
- - `new_index.index`, `new_vectors.pkl` - файлы для инициализации модели обученными значениями
10
- - `utils.py` - вспомогательные функции (отбор тегов)
11
-
12
- ## Примеры использования
13
-
14
- ### Инициализация индекса готовыми значениями
15
-
16
- ```python
17
- from indexer import FAISS
18
-
19
- indexer_vector_dim = 384
20
- indexer = FAISS(indexer_vector_dim)
21
- indexer.init_index('new_index.index')
22
- indexer.init_vectors('new_vectors.pkl')
23
- ```
24
-
25
- ### Запрос к индексу
26
-
27
- ```python
28
- indexer.suggest_tags("куртка оверсайз")
29
- ```
30
-
31
- ### Заполнение индекса
32
-
33
- Пусть у нас есть список запросов `queries` и `DataFrame` `popularities`, в котором присутствуют поля `query` и `query_popularity`, тогда мы можем самостоятельно заполнить поисковый индекс:
34
-
35
- ```python
36
- indexer.fill(queries, popularities)
37
- ```
38
-
39
- ### Сохранение заполненного индекса
40
-
41
- Если мы не хотим потерять заполненные данные, их можно сохранить и затем переиспользовать:
42
-
43
- ```python
44
- indexer.save_vectors("my_vectors.pkl")
45
- indexer.save_index("my_index.index")
46
- ```
47
- # Запуск из Spaces
48
-
49
- Есть возможно запустить прям в браузере. Перейти во вкладку App (это около Files and Versions) и дождаться строки. Дальше можно написать свой запрос и будет выведен результат. Возможно через некоторое время, так как это платформа бесплатная. Но мы удовлетворяем требованиям к допустимым мощностям
50
-
51
- # Запуск из консоли, если скачать репозиторий
52
-
53
- ```bash
54
- streamlit run app.py
55
- ```