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.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 873d468bfc342c517678e5cafb1fdf2d615182a1d28311b9321d411d6170737c |
|
MD5 | 9d8f24eb013264c1cb4e7a308d91a99e |
|
BLAKE2b-256 | 657c30586418f28fe4d02481060fc737fa5f26ac641457d7203c8f45360e085f |
Close
Hashes for docs_ranking_metrics-0.0.4.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fbe2709b08d7d21681184f6acc990462e9c870bc400e112a91fe4d0b4ba4a18 |
|
MD5 | 8f1475c05317902614a892b964508cab |
|
BLAKE2b-256 | e6495aa7aa5f7d2ca96c803a35ff2b886c2e4e874fde2151272ec687efde2e52 |