Более полная инструкция
Перед загрузкой пакета необходимо зарегистрироваться на PyPi и написать в discord свой ник чтобы я добавил в соавторы.
Далее необходимо установить все зависимости:
pip install twine wheel
Для создания пакета необходимо воспользоваться командой (перед этим удалите все старые генерации пакетов):
python3 setup.py sdist bdist_wheel
Для загрузки пакета необходимо воспользоваться командой:
python3 -m twine upload dist/*
Далее будут запрошены логин и пароль, вместо логина можно указать __token__, а вместо пароля API-токен,
который можно получить в личном кабинете PyPi.
Twine также поддерживает настройку с помощью переменных среды. Поэтому параметры авторизации можно передать через переменные среды:
TWINE_USERNAME- имя пользователя, которое будет использоваться для аутентификации в репозитории.TWINE_PASSWORD- пароль, используемый для аутентификации в репозитории.
Для генерации документации воспользуйтесь командой:
bash tools/run_docsgen.sh
Будет запущен docker-контейнер, который сгенерирует документацию в папку docs.
Что можно сделать (идеи приветствуются):
- Исправить подсчет метрик под документы разной релевантности
- Внедрить модель https://huggingface.co/cross-encoder/ms-marco-MiniLM-L-6-v2
- Придумать дополнительные метрики
- Завернуть все в пакет
- Написать тесты, workflows