Skip to content

sentence_transformer.py

SentenceTransformer dataclass

Bases: Input[SentenceTransformer]

Input for a SentenceTransformer model from the sentence-transformers library.

Example:

>>> from ordeq_sentence_transformers import SentenceTransformer
>>> huggingface_token = "your_hf_token_here"
>>> model = SentenceTransformer(
...     'all-mpnet-base-v2'
... ).with_load_options(
...     token=huggingface_token
... )
>>> st_model = model.load()  # doctest: +SKIP

For more details, see the sentence-transformers documentation.