API 参考

数据

数据加载器

SimilarityDataLoader	特殊版本的 DataLoader，用于处理相似度样本。
PairsSimilarityDataLoader	用于处理表示为 SimilarityPairSample 的数据的 DataLoader。
GroupSimilarityDataLoader	用于处理表示为 SimilarityGroupSample 的数据的 DataLoader。

数据集

SimilarityGroupDataset

一个包装器，将标准分类任务数据集转换为与 GroupSimilarityDataLoader 兼容的数据集。

样本

SimilarityGroupSample	表示一组相似对象，组内所有对象应相互匹配。
SimilarityPairSample	表示一对对象、它们的相似性以及与其他对的关系。

距离

余弦	计算余弦相似度（及其作为距离的解释）。
点积	计算点积相似度（及其作为距离的解释）。
欧氏距离	计算欧氏距离（及其作为相似度的解释）。
曼哈顿距离	计算曼哈顿距离（及其作为相似度的解释）。

评估

计数器

AttachedMetric	将批量级指标附加到 TrainableModel。
Evaluator	计算整个数据集上的指标

组指标

GroupMetric	组指标的基类
RetrievalRPrecision	计算基于组数据的检索 R-precision 分数

对指标

PairMetric	对基于数据的指标计算基类
RetrievalPrecision	计算对基于数据集的检索 precision@k
RetrievalReciprocalRank	计算对基于数据集的检索倒数排名

采样器

GroupSampler	为基于组的任务执行嵌入和目标的选取。
PairSampler	为基于对的任务执行嵌入和目标的选取。

损失函数

基类

GroupLoss	组损失函数的基类。
PairwiseLoss	成对损失函数的基类。

实现

ArcFaceLoss	加性角间隔损失，定义见 https://arxiv.org/abs/1801.07698
ContrastiveLoss	对比损失函数。
MultipleNegativesRankingLoss	实现多负样本排序损失，描述见 https://arxiv.org/pdf/1705.00652.pdf
SoftmaxLoss	常规交叉熵损失函数。
TripletLoss	实现三元组损失函数，定义见 https://arxiv.org/abs/1503.03832
CircleLoss	实现 Circle 损失函数，定义见 https://arxiv.org/abs/2002.10857。
FastAPLoss	FastAP 损失函数
CosFaceLoss	大间隔余弦损失函数，定义见 https://arxiv.org/pdf/1801.09414.pdf
CenterLoss	中心损失函数，定义见论文“A Discriminative Feature Learning Approach for Deep Face Recognition” (http://ydwen.github.io/papers/WenECCV16.pdf)。它旨在最小化类内差异，同时保持不同类别特征的可分离性。

额外内容

PytorchMetricLearningWrapper

提供一个简单的包装器，以便使用 pytorch-metric-learning 中的损失函数和矿工。

主模块

Quaterion

微调入口点

训练

TrainableModel

TrainableModel

待训练模型的基类。

缓存

CacheConfig	确定缓存设置。
CacheType	可用于缓存的可用张量设备。

工具

TrainStage	处理训练阶段。
get_triplet_mask	为 batch-all 策略创建有效三元组的 3D 掩码。
get_anchor_positive_mask	创建有效锚点-正样本对的 2D 掩码。
get_anchor_negative_mask	创建有效锚点-负样本对的 2D 掩码。