The package contains functions for calculating ranking metrics
Project description
Описание
Данный репозиторий содержит реализацию алгоритмов ранжирования Bm25, LaBSE с подсчетом метрик:
- Top@1;
- Top@3;
- Top@5;
- Средняя позиция в выдачах (AverageLoc);
- Оценка как часто фейковый документ выше релевантных (FDARO)
Установка
Для установки пакета воспользуйтесь командой
pip install docs-ranking-metrics
Пример использования
Пример использования представлен в examples/using_metrics.py
# Объявление метрик
metrics = [LaBSE(), Bm25()]
# Объявление класса агрегирующего обновление метрик
rank_metrics = RankingMetrics(metrics)
...
'''
Обновление значений метрик, где
query - запрос по которому сгенерирован документ,
sentences - массив документов,
labels - метки документов
'''
rank_metrics.update(query, sentences, labels)
...
# Получение значений подсчитанных метрик ввиде словаря
rank_metrics.get()
Возможный вывод метода get:
{
'LaBSE_AverageLoc': 10.5,
'Bm25_AverageLoc': 1.13513,
'LaBSE_Top@1': 0.0,
'LaBSE_Top@3': 0.013513,
'LaBSE_Top@5': 0.013513,
'Bm25_Top@1': 0.91891,
'Bm25_Top@3': 1.0,
'Bm25_Top@5': 1.0,
'LaBSE_FDARO': 0.6216,
'Bm25_FDARO': 1.0
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for docs-ranking-metrics-0.0.2.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc80879899cff9817a126accfd1195ebbbe6afb7fd109ac09d64325b137fd854 |
|
MD5 | c591ff91762f25799f889d8dbcd0b742 |
|
BLAKE2b-256 | 8458c31578d85258ccd72e7d597636eb6815ccf19ca87b8836702cbd696affaa |
Close
Hashes for docs_ranking_metrics-0.0.2.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea559cbf2b2875fa0df3df1cfec76d6366c9a07d6df4543cfe91602a88db7207 |
|
MD5 | b3519f2e9f82e4dc43cff414c2a51d75 |
|
BLAKE2b-256 | 5c61329fc8fc8b411f183dcc3d740991227cbfe7fca1f51e692b00ca247951e4 |