README.md

---
title: PaperClassification
emoji: 📚
colorFrom: gray
colorTo: yellow
models:
  - oracat/bert-paper-classifier-arxiv
  - oracat/bert-paper-classifier
sdk: streamlit
sdk_version: 1.44.1
app_file: app.py
pinned: false
short_description: Different models for paper classification
---

# Как запустить локально

Для начала нужно создать venv и загрузить зависимости (это нужно сделать только один раз). Для Linux-подобных систем это делается следующим образом:

```sh
    python -m venv venv               # Создать виртуальной среды
    chmod +x venv/bin/activate        # Добавить права на исполнение скрипту, который активирует среду
    source venv/bin/activate          # Активировать среду
    pip install -r requirements.txt   # Установить все зависимости
```

Находясь в корневой директории репозитория:

```sh
    streamlit run app.py
```

Для выхода из виртуальной среды выполните:

```sh
    deactivate
```

# Как добавить модель

В директории `category_classification/models` создайте директорию для новой модели. Название директории: либо `название_модели` либо `автор__название_модели`.  
В этой директории создайте файл `model.py`, в котором опишите архитектуру новой модели. В этом же модуле обязательно должен быть строковый атрибут `name`, соответствующий имени новой модели и функция `get_model`, которая возвращает объект модели. Объект модели должен быть callable, в него будет передаваться аргумент типа `Input` (см. [common.py](src/common.py)).  
Объект модели должен быть pickable.