跳到主要内容

SpladeEmbeddingFunction

SpladeEmbeddingFunction 是 pymilvus 中的一个类,负责使用 SPLADE 模型将文本编码为嵌入,以支持在 Milvus 中进行嵌入检索。

python
pymilvus.model.sparse.SpladeEmbeddingFunction

构造函数​

为常见用例构造一个 SpladeEmbeddingFunction。

python
SpladeEmbeddingFunction(
model_name: str = "naver/splade-cocondenser-ensembledistil",
batch_size: int = 32,
query_instruction: str = "",
doc_instruction: str = "",
device: Optional[str] = "cpu",
k_tokens_query: Optional[int] = None,
k_tokens_document: Optional[int] = None,
**kwargs,
)

参数:

  • model_name (string) -

    用于编码的 SPLADE 模型名称。有效选项包括 naver/splade-cocondenser-ensembledistil(默认)、naver/splade_v2_max, naver/splade_v2_distil, 和 naver/splade-cocondenser-selfdistil.。有关更多信息,请参见 体验模型。

  • batch_size (int) -

    用于计算的批处理大小。

  • query_instruction (string) -

    用于编码的查询。

  • doc_instruction (string) -

    用于编码的文档。

  • device (string) -

    要使用的设备,其中 cpu 表示 CPU,cuda:n 表示第 n 个 GPU 设备。

  • k_tokens_query (int) -

    用于查询编码的 top token 数量。如果未指定,则使用所有非零 token。

  • k_tokens_document (int) -

    用于文档编码的 top token 数量。如果未指定,则使用所有非零 token。

  • **kwargs

    允许将其他关键字参数传递给模型初始化。有关更多信息,请参见 AutoModelForMaskedLM。

示例​

python
from pymilvus import model

splade_ef = model.sparse.SpladeEmbeddingFunction(
model_name="naver/splade-cocondenser-selfdistil",
device="cpu"
)
最低 SDK 版本v2.3.x