Как посчитать NDCG@K при разной полезности RAG-документов

Перед запуском запишите, какие данные считаются входом, что является ожидаемым результатом, что именно означает отказ и кому предстоит разбирать расхождение. Для такой проверки храните тестовый вход, ожидаемый результат и фактический исход раздельно: если они смешаны, тест может подтверждать сам себя. Используйте стабильные синтетические ID, чтобы видеть ошибку в журнале, не раскрывая содержимое клиентских обращений.

Сначала прогоните тест на маленьком входе, где правильное поведение известно вручную. Затем внесите одну контролируемую ошибку и убедитесь, что код её замечает. После этого верните корректный набор и только тогда расширяйте проверку до реальных данных. Не переносите демонстрационные численные значения или пороги в производство без отдельного обоснования: они выбраны для наглядности, а не рассчитаны по вашей аудитории.

Вход и ожидаемый результат

Выдача [B,A] с оценками A=2, B=1 уступает идеальному порядку [A,B]. [A,B] даёт 1, [B,A] даёт значение меньше 1; точное число печатает запущенный код. Перед тем как применять правило к закрытым данным, обсудите пограничные случаи, которые могут поменять интерпретацию входа. Запись в документации о границах теста не менее важна, чем зелёный check.

Пошаговые действия

1. Создайте scripts/check.py в корне репозитория и вставьте код из блока ниже. Он использует названия функций стандартной библиотеки, указанные в официальных ссылках в конце статьи.
2. Выполните python scripts/check.py локально. Не продолжайте, если уже демонстрационная фикстура даёт иной результат: сначала проверьте копирование кода и кодировку файла.
3. Запишите шкалу grade и независимую разметку до вычисления. Выполните тест идеального порядка, который обязан вернуть единицу. Потом поменяйте местами A и B: значение должно стать меньше единицы. Для рабочего корпуса решите, как поступать с неизвестными ID: в примере им присваивается ноль, что требует обязательной проверки полноты эталона. Сравнивайте версии при том же K, той же шкале и том же способе gain; сохраняйте документы с наибольшим изменением позиции для ручного разбора.
4. Создайте .github/workflows/ai-corpus-check.yml из YAML-шаблона. Событие pull_request полезно для проверки данных до слияния; чтение репозитория ограничено permissions: contents: read. Скрипт не должен получать ключ внешней модели или реальные секреты.
5. В разделе Actions откройте job check, сопоставьте его код завершения с локальным прогоном и зафиксируйте ссылку на проверенный коммит в PR. Не принимайте зелёный результат на старой ревизии за проверку последнего изменения.

# scripts/check.py
from math import log2
grades={"A":2,"B":1,"C":0}
def dcg(values):
    return sum(v/log2(i+2) for i,v in enumerate(values))
def ndcg(ranked,k):
    if k<=0 or len(ranked)!=len(set(ranked)):
        raise ValueError("bad ranking")
    values=[grades.get(doc,0) for doc in ranked[:k]]
    ideal=dcg(sorted(grades.values(),reverse=True)[:k])
    if not ideal: raise ValueError("no relevant documents")
    return dcg(values)/ideal
assert abs(ndcg(["A","B"],2)-1)<1e-12
assert 0<ndcg(["B","A"],2)<1
print("NDCG@2:",round(ndcg(["B","A"],2),4))

name: AI corpus checks
on:
  pull_request:
permissions:
  contents: read
jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-python@v7
        with:
          python-version: '3.13'
      - run: python scripts/check.py

Ошибки интерпретации и границы

Масштаб 0–2 и линейный gain — локальное соглашение этой статьи, не универсальный стандарт. При неполной разметке неизвестный полезный документ неверно получит ноль. Если вы расширяете набор случаев, добавляйте не только новые примеры, но и отрицательные случаи, на которых тест обязан упасть. Проверяйте, что изменение expected прошло ревью отдельно от изменения кода: иначе можно незаметно изменить правило под текущий ответ системы. Избегайте вывода полного приватного набора в CI и не сохраняйте в артефактах ответ закрытой модели без решения о доступе и хранении.

Ошибка выполнения самого Python, нераспознанный формат входа и обнаруженный бизнес-дефект — разные ситуации. В сообщении теста указывайте тип проблемы и безопасный ID. Если тест требует внешний сервис, вынесите его из PR с недоверенным кодом и явно ограничьте доступ к токенам; этот пример намеренно работает локально. Перед публикацией каких-либо результатов опишите методику, область применения и происхождение примеров, иначе читатель воспримет демонстрационную арифметику как характеристику продукта.

Практический разбор именно этого контроля

Учитывать порядок документов и градации полезности, когда один источник лучше другого. Для самостоятельной проверки сначала выпишите три наблюдаемых состояния: допустимый вход, намеренно недопустимый вход и видимый сигнал отказа. В данной фикстуре это выглядит так: Выдача [B,A] с оценками A=2, B=1 уступает идеальному порядку [A,B]. При успешном тесте ожидается: [A,B] даёт 1, [B,A] даёт значение меньше 1; точное число печатает запущенный код. Не превращайте это в числовой KPI: здесь проверяется контракт на конкретных примерах, а не поведение модели на пользовательском трафике.

Масштаб 0–2 и линейный gain — локальное соглашение этой статьи, не универсальный стандарт. При неполной разметке неизвестный полезный документ неверно получит ноль. Подключая проверку к продукту, расположите её до той операции, ради которой она написана: парсинга, сохранения, отображения или экспорта. Для каждого нового формата добавляйте отдельный негативный пример и письменное решение, почему он отклоняется. Отдельно просмотрите обработку ошибок: система должна отличать невалидный ответ AI от сбоя тестовой инфраструктуры, а пользователь не должен видеть сырой стек или приватное содержимое.