hse-python-assistant/README.md

53 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# hse-python-assistant
## Ссылки
Тестирующая система: https://dsworks.ru/champ/hse-2024-october \
Лендинг: https://www.hse.ru/ai-assistant-hack-python/
## Запуск
Перед запуском необходимо загрузить модель. В данный момент мы её выгружаем, скинем ссылку ASAP. После этого поменяйте параметр `model_path` в `main.py` на абсолютный путь к модели.
### Docker
```
docker compose up
```
### Poetry
```
poetry install
poetry run python main.py
```
## Структура проекта
```
.
├── app
│   ├── __init__.py
│   ├── models <------------------------ Подключаемые модели
│   └── utils <------------------------ Утилиты
├── data
│   ├── processed <----------------------- Промежуточный этап подготовки данных
│   └── raw <----------------------------- Исходные данные
│   ├── submit_example.csv
│   ├── test
│   │   ├── solutions.xlsx
│   │   ├── tasks.xlsx
│   │   └── tests.xlsx
│   └── train
│   ├── solutions.xlsx
│   ├── tasks.xlsx
│   └── tests.xlsx
├── main.py <---------------------------- [ВАЖНО] Именно этот скрипт мы будем запускать при проверке ваших решений. Он должен генерировать финальный сабмит.
├── notebooks
│ └── finetuning.ipynb <---------------------------- Процесс файнтюнинга модели
├── poetry.lock
├── pyproject.toml
├── README.md
└── tests
├── test_correctness.py <------------------------ Проверить на корректность сабмит
└── test_embedding_generation.py <--------------- Попробовать генерацию эмбеддингов и подсчёт метрики
```