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.dev2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 011a2a9ef8f2489e8e432b31cc3adae64edfb52d885d941f70d94c05fc74e65b |
|
MD5 | 9dd634ab951e70c86ffd631238f1cfe0 |
|
BLAKE2b-256 | fb8219240b3365381fba4c7157967d8987dd191789e9df3f683514bfa7188961 |
Close
Hashes for docs_ranking_metrics-0.0.4.dev2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f559823542cdd9b7ebdddf14d293d649463ec94c3275bada58419b1c5e2d4fb4 |
|
MD5 | 9bfa20a012c9f546bd8e5929e4789aa7 |
|
BLAKE2b-256 | b8cf7de4a53fc9b34fbe5f81088edb1d63d1dbe857e8d9e48bd28e10a74f3863 |