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.4.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c33bb97b63b3e11a87ccdf8016e746530596fd13268042d54c55bf195ddded87 |
|
MD5 | 39084ca9a8b0e216ca99bb2fccdf437c |
|
BLAKE2b-256 | 4c70a10572d70d2e54e99c4fc2b2bae1b830c29d871b9ffda2201d8cdfa3b2ae |
Close
Hashes for docs_ranking_metrics-0.0.4.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ac76d980caf8d6284a1876ba6416151fc36aa327a3a55cd262c56e3e923b66d |
|
MD5 | 4f60930e068a593aef438510ac73a4c9 |
|
BLAKE2b-256 | 12bdf9b14465af4e65811526f606930a85102147d4738787edb8996be0a8bdd4 |