File size: 1,721 Bytes
011bd7a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 | from __future__ import annotations
from typing import Any, Protocol, runtime_checkable
import numpy as np
import torch
@runtime_checkable
class Encoder(Protocol):
"""The interface for an encoder in MTEB."""
def encode(
self, sentences: list[str], prompt: str, **kwargs: Any
) -> torch.Tensor | np.ndarray:
"""Encodes the given sentences using the encoder.
Args:
sentences: The sentences to encode.
prompt: The prompt to use. Useful for prompt-based models.
**kwargs: Additional arguments to pass to the encoder.
Returns:
The encoded sentences.
"""
...
@runtime_checkable
class EncoderWithQueryCorpusEncode(Encoder, Protocol):
"""The interface for an encoder that supports encoding queries and a corpus."""
def encode_queries(
self, queries: list[str], prompt: str, **kwargs: Any
) -> torch.Tensor | np.ndarray:
"""Encodes the given queries using the encoder.
Args:
queries: The queries to encode.
prompt: The prompt to use. Useful for prompt-based models.
**kwargs: Additional arguments to pass to the encoder.
Returns:
The encoded queries.
"""
...
def encode_corpus(
self, corpus: list[str], prompt: str, **kwargs: Any
) -> torch.Tensor | np.ndarray:
"""Encodes the given corpus using the encoder.
Args:
corpus: The corpus to encode.
prompt: The prompt to use. Useful for prompt-based models.
**kwargs: Additional arguments to pass to the encoder.
Returns:
The encoded corpus.
"""
...
|