Гайд · TNWS AI
Как проверить cosine similarity embeddings через Optax
Optax 0.2.6: одинаковые единичные vectors дают similarity 1, ортогональные — 0; проверяем batch и axis.
Задача и применимость
Актуальный запрос: «как посчитать cosine similarity Optax embeddings». Измерить угловое сходство пар embeddings. Для [1,0] против [1,0] результат равен 1; против [0,1] — 0. Функция по умолчанию вычисляет по последней axis и возвращает значение на каждую пару. Это similarity, которую максимизируют; если optimizer минимизирует objective, используйте отрицание либо документированную cosine_distance. Для retrieval проверяйте распределение negatives, Recall@k и долю коллизий, а не только similarity положительных пар. Успешный тест двух vectors подтверждает формулу, но не семантическое качество encoder и порога.
Материал проверен на Optax 0.2.6, JAX/jaxlib 0.11.2 и Python 3.12 на CPU. Используется актуальный API from flax import nnx, а не устаревший экспериментальный import и не Linen. Пример не загружает веса или внешние данные и решает одну изолированную задачу. Численный тест подтверждает контракт кода в указанной версии, но не качество нейросети на рабочем датасете.
Перед запуском установите совместимые версии пакетов в отдельное окружение и выведите flax.__version__, jax.__version__ и jaxlib.__version__. Не смешивайте loss-функции с похожими названиями: они различаются ожидаемыми labels, формой результата и численной нормировкой. Сначала закрепите logits/targets/reduction контракт тестом и следуйте документации установленной версии.
Пошаговое решение
- Соберите batch пар vectors одинаковой размерности.
- Укажите axis=-1 и разумный epsilon для возможных нулевых vectors.
- Проверьте идентичную и ортогональную пару.
- Определите знак training objective отдельно.
Готовый проверяемый шаблон
import jax.numpy as jnp
import optax
pred = jnp.array([[1., 0.], [1., 0.]])
target = jnp.array([[1., 0.], [0., 1.]])
similarity = optax.cosine_similarity(pred, target, epsilon=1e-8, axis=-1)
assert similarity.shape == (2,)
assert jnp.allclose(similarity, jnp.array([1., 0.]))
print(similarity)
Вход и ожидаемый результат
Идентичная пара дала 1, ортогональная — 0. Выход имеет форму (2,), потому что feature axis была свёрнута.
Как проверить результат
Добавьте противоположные vectors с ожидаемым -1 и нулевой vector для проверки epsilon. Сравните с ручным dot/(norms). Убедитесь, что axis указывает именно размерность embedding, а не batch.
Перенос в рабочую модель
В рабочем проекте зафиксируйте контракт batch: порядок осей, dtype, диапазон признаков и семантику target. Инициализацию, dropout и генерацию данных разделяйте по именованным RNG streams. Обучаемые nnx.Param, статистическое состояние и optimizer state сохраняйте и проверяйте раздельно. Перед обновлением Flax/JAX прогоняйте небольшой обезличенный regression batch и сравнивайте формы, loss, конечность значений и допустимое численное отклонение.
Критерии приёмки
- Версии Flax, JAX и jaxlib записаны в отчёте.
- Формы входа, параметров и результата совпадают с контрактом.
- Все численные outputs и gradients конечны.
- Train/eval режим задан явно для стохастических и stateful слоёв.
- Результат проверен независимой формулой, состоянием или контрольным вызовом.
- Негативный случай неверной формы или режима включён в тесты проекта.
Регрессионный протокол
Сохраните минимальные входы: один объект, небольшой batch, нулевые значения, несимметричные размеры осей и заведомо несовместимую форму. Сравнивайте массивы через allclose с документированным допуском. Воспроизводимость требует одинаковых seeds и одинакового порядка запросов RNG. Производительность оценивайте после JIT-прогрева и block_until_ready, отдельно от compile time. Один удачный запуск не заменяет validation на независимых данных.
Диагностика расхождений
При расхождении сначала проверьте layout и preprocessing, затем RNG streams, train/eval mode, типы переменных State, forward, loss и optimizer update. Упростите модель до одного слоя, отключите JIT и стохастику, сравните промежуточные shapes. Возвращайте компоненты по одной. Не увеличивайте допуск и не заменяйте NaN нулями до установления причины.
Контроль после внедрения
В эксплуатации ограничьте допустимые shapes и размер batch, чтобы запрос не исчерпал память и не вызвал поток перекомпиляций. Не логируйте исходные пользовательские тензоры, ключи и содержимое обучающих примеров. Храните предыдущий проверенный checkpoint и схему State для отката. После восстановления проверяйте контрольный forward до включения модели в трафик.
Границы применимости
CPU-проверка не доказывает скорость или точную численную идентичность GPU/TPU. Случайная инициализация не является обучением, снижение train loss не гарантирует обобщение, а правильная форма не подтверждает корректность данных. Для важных решений нужны validation/test, мониторинг дрейфа, ограничения входов и человеческий контроль.
Типичные ошибки и чего не делать
- Не минимизировать similarity напрямую без смены знака.
- Не путать cosine similarity с dot product ненормированных vectors.
- Не игнорировать нулевые нормы.
Не публикуйте только удачный вывод без версии среды, форм и негативного теста. Не настраивайте модель по test set и не загружайте непроверенное состояние поверх production-модели.
FAQ
Каков диапазон?
Обычно от -1 до 1 для вещественных vectors.
Что возвращает ортогональная пара?
Ноль.
Как превратить в loss?
Использовать 1-similarity, отрицание или cosine_distance по нужному контракту.
Официальные источники
Частые вопросы
Каков диапазон?
Обычно от -1 до 1 для вещественных vectors.
Что возвращает ортогональная пара?
Ноль.
Как превратить в loss?
Использовать 1-similarity, отрицание или cosine_distance по нужному контракту.
Читайте также
Как использовать Huber loss в Optax для регрессии с выбросами
Optax 0.2.6: Huber loss квадратичен около нуля и линеен после delta; проверяем ошибки 0,5 и 2.
Как использовать sigmoid focal loss в Optax
Optax 0.2.6: focal loss для logits 0 и labels 0/1 при gamma=2; проверка симметричного базового значения.
Как посчитать binary cross-entropy по logits в Optax
Optax 0.2.6: sigmoid_binary_cross_entropy принимает logits и метки 0/1; проверяем базовый уровень ln(2).
Комментарии
Пока тихо. Скажите первое слово