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.dev2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ced357148b0fc66c5658917049f6e7ff034b276d91baa0eaf070a1266327793c |
|
MD5 | 1e01f90e114618493df0561101fba0cc |
|
BLAKE2b-256 | de2c782f81bdad4fe45ca7036678f92bbd45e57efdc44fb5f1e766e6244fcd77 |
Close
Hashes for docs_ranking_metrics-0.0.2.dev2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 781c9dde70d9f8c0fca478efa68e86ad0ff851d68cc902a8af452802a06a3c2d |
|
MD5 | 61eb7605771925a6b6ee816bd5f72305 |
|
BLAKE2b-256 | eba7077b070cb8ed465ae596a2ae0d788a08542fcaf4737dd72dca6938cb1ae2 |