此页面由 AI 自动翻译。查看英文原版
最后更新

本页目录

  • 类
  • EmbeddingLossWrapper
  • 属性
  • EMBEDDING_LOSSES
Claude CodeCodexCursor
Luxonis 智能体工具包为你常用的编程智能体加载 Luxonis 上下文与技能,更快地基于 OAK 开发应用。
安装工具包

embedding_losses

最后更新
Python API: luxonis_train.attached_modules.losses.embedding_lossespytorch-metric-learning 损失,已注册。该模块为 EMBEDDING_LOSSES 中的每个名称创建一个 EmbeddingLossWrapper 类。每个类都在 LOSSES 注册表中以其损失的名称注册,因此配置直接命名损失,例如 TripletMarginLoss。每个类都接受一个 miner、一个距离、一个 reducer 和一个 regularizer。

类

EmbeddingLossWrapper

pytorch-metric-learning 嵌入损失的包装器。
  • 输入::
    • predictions (Tensor): [B, D] 嵌入
    • target (Tensor): [B] 来自 metadata/id 的身份标签
  • 输出::
    • Tensor: 带有默认 reducer 的标量
  • 公式:: 包装器返回注册名称的 pytorch-metric-learning 损失值。使用 miner 时,包装器还会将 miner 在批次中选择的对或三元组提供给损失。每个损失都以自己的方式使用它们。当节点设置 cross_batch_memory_size 时,CrossBatchMemory 包装器还会将批次与最后 cross_batch_memory_size 个嵌入的内存进行比较。
  • 兼容::
    • 节点: GhostFaceNetHead
    • 注册为:
      • AngularLoss
      • CircleLoss
      • ContrastiveLoss
      • DynamicSoftMarginLoss
      • FastAPLoss
      • GeneralizedLiftedStructureLoss
      • HistogramLoss
      • InstanceLoss
      • IntraPairVarianceLoss
      • LiftedStructureLoss
      • MarginLoss
      • MultiSimilarityLoss
      • NCALoss
      • NPairsLoss
      • NTXentLoss
      • PNPLoss
      • RankedListLoss
      • SignalToNoiseRatioContrastiveLoss
      • SupConLoss
      • ThresholdConsistentMarginLoss
      • TripletMarginLoss
      • TupletMarginLoss

方法

init
Python
1def __init__(*, miner: str | None = None, miner_params: Params | None = None, distance: str | None = None, distance_params: Params | None = None, reducer: str | None = None, reducer_params: Params | None = None, regularizer: str | None = None, regularizer_params: Params | None = None, node: BaseNode | None = None, final_loss_weight: float = 1.0, _loss_name: str = _loss_name, **kwargs):
创建包装的损失及其可选组件。该方法在匹配的 pytorch-metric-learning 模块中查找每个命名组件。它使用其 *_params 参数的关键字参数创建组件。包装的损失接收 reducer 作为 reducer,regularizer 作为 embedding_regularizer,距离作为 distance,以及 **kwargs。当节点设置 cross_batch_memory_size 并且 CrossBatchMemory 支持该损失时,该方法将损失包装在 CrossBatchMemory 中。包装器获取节点的 embedding_size 和 cross_batch_memory_size,以及 miner。对于 CrossBatchMemory 不支持的损失,该方法会记录警告。损失需要一个节点:如果没有 node,BaseAttachedModule.node 会引发 RuntimeError。参数
  • miner (str | None): pytorch_metric_learning.miners 中类的名称,例如 "MultiSimilarityMiner"。None 表示不使用 miner。
  • miner_params (Params | None): miner 的关键字参数。None 表示不传递参数。
  • distance (str | None): pytorch_metric_learning.distances 中类的名称,例如 "CosineSimilarity"。None 表示保留损失的默认距离。
  • distance_params (Params | None): 距离的关键字参数。None 表示不传递参数。
  • reducer (str | None): pytorch_metric_learning.reducers 中类的名称。None 表示保留损失的默认 reducer。
  • reducer_params (Params | None): reducer 的关键字参数。None 表示不传递参数。
  • regularizer (str | None): pytorch_metric_learning.regularizers 中类的名称,损失将其应用于嵌入。None 表示不使用 regularizer。
  • regularizer_params (Params | None): regularizer 的关键字参数。None 表示不传递参数。
  • node (BaseNode | None): 损失附加到的 GhostFaceNetHead。
  • final_loss_weight (float): BaseLoss.run 乘以损失的因子。
  • _loss_name (str): pytorch-metric-learning 损失类的名称。其默认值是此类的注册名称。
  • **kwargs: 损失类的关键字参数,例如 TripletMarginLoss 的 margin。
引发
  • ValueError: 当 pytorch-metric-learning 没有具有给定名称的损失、miner、距离、reducer 或 regularizer 时。
forward
Python
1def forward(predictions: Tensor, target: Tensor) -> Tensor:
计算一批嵌入的包装损失。使用 miner 时,该方法首先挖掘批次。它将挖掘的索引作为第三个参数传递给包装的损失。没有 miner 时,包装的损失只接收嵌入和标签。CrossBatchMemory 包装器还会将批次添加到其内存中。参数
  • predictions (Tensor): 形状为 [B, D] 的嵌入,是节点的主要输出。
  • target (Tensor): 形状为 [B] 的身份标签,来自 metadata/id 标签。
返回
  • Tensor: 包装损失的值,带有默认 reducer 的标量。

属性

loss
miner
name
包装的 pytorch-metric-learning 损失的名称。该值是 _loss_name 参数,例如 "TripletMarginLoss"。默认情况下,它是类的注册名称。BaseAttachedModule.name 返回类名,对于每个嵌入损失都是 EmbeddingLossWrapper。此覆盖返回包装损失的名称。BaseAttachedModule.get_parameters 的错误消息使用它。
node
supported_tasks

属性

EMBEDDING_LOSSES