MCPcopy Create free account

hub / github.com/huggingface/sentence-transformers / functions

Functions3,759 in github.com/huggingface/sentence-transformers

Method__getitem__
(self, key)
tests/base/modules/test_router.py:105
Method__getitem__
(self, item)
examples/sentence_transformer/unsupervised_learning/MLM/train_mlm.py:87
Method__init__
(self, output_dir: str, evaluator: BaseEvaluator | None, save_best_model: bool)
sentence_transformers/sentence_transformer/fit_mixin.py:50
Method__init__
(self, evaluator: BaseEvaluator, output_path: str | None = None)
sentence_transformers/sentence_transformer/fit_mixin.py:98
Method__init__
(self, *args, **kwargs)
sentence_transformers/sentence_transformer/model_card.py:206
Method__init__
( self, model: SentenceTransformer | None = None, args: SentenceTransformerTrainingArg
sentence_transformers/sentence_transformer/trainer.py:118
Method__init__
( self, model_name_or_path: str | None = None, *, modules: list[nn.Module] | N
sentence_transformers/sentence_transformer/model.py:155
Method__init__
( self, in_embedding_dimension: int, out_channels: int = 256, kernel_sizes: li
sentence_transformers/sentence_transformer/modules/cnn.py:23
Method__init__
( self, vocab: list[str], word_weights: dict[str, float] = {}, unknown_word_we
sentence_transformers/sentence_transformer/modules/bow.py:26
Method__init__
(self, dropout: float = 0.2)
sentence_transformers/sentence_transformer/modules/dropout.py:17
Method__init__
(self, embedding_dimension, num_hidden_layers: int = 12, layer_start: int = 4, layer_weights=None)
sentence_transformers/sentence_transformer/modules/weighted_layer_pooling.py:22
Method__init__
( self, tokenizer: WordTokenizer | PreTrainedTokenizerBase, embedding_weights,
sentence_transformers/sentence_transformer/modules/word_embeddings.py:32
Method__init__
Initializes the StaticEmbedding model given a tokenizer. The model is a simple embedding bag model that takes the mean of trained per
sentence_transformers/sentence_transformer/modules/static_embedding.py:31
Method__init__
( self, model_name_or_path: str = "openai/clip-vit-base-patch32", _from_auto_load: bool = False, **kwa
sentence_transformers/sentence_transformer/modules/clip_model.py:21
Method__init__
( self, embedding_dimension: int, pooling_mode: PoolingMode | tuple[PoolingMode, ...]
sentence_transformers/sentence_transformer/modules/pooling.py:94
Method__init__
(self, dimension: int)
sentence_transformers/sentence_transformer/modules/layer_norm.py:16
Method__init__
Initializes the WordWeights class. Args: vocab (List[str]): Vocabulary of the tokenizer. word_weights (Dict[
sentence_transformers/sentence_transformer/modules/word_weights.py:18
Method__init__
( self, embedding_dimension: int, hidden_dim: int, num_layers: int = 1,
sentence_transformers/sentence_transformer/modules/lstm.py:23
Method__init__
(self, tokenizer: PreTrainedTokenizerBase)
sentence_transformers/sentence_transformer/modules/tokenizer/word.py:422
Method__init__
( self, vocab: Iterable[str] = [], stop_words: Iterable[str] = ENGLISH_STOP_WORDS,
sentence_transformers/sentence_transformer/modules/tokenizer/phrase.py:24
Method__init__
( self, vocab: Iterable[str] = [], stop_words: Iterable[str] = ENGLISH_STOP_WORDS, do_lower_case: bool
sentence_transformers/sentence_transformer/modules/tokenizer/whitespace.py:18
Method__init__
(self, sentences: list[str], noise_fn=lambda s: DenoisingAutoEncoderDataset.delete(s))
sentence_transformers/sentence_transformer/datasets/denoising_auto_encoder.py:33
Method__init__
A special data loader to be used with MultipleNegativesRankingLoss. The data loader ensures that there are no duplicate sentences wit
sentence_transformers/sentence_transformer/datasets/no_duplicates_dataloader.py:18
Method__init__
Parallel sentences dataset reader to train student model given a teacher model Args: student_model (SentenceTransformer)
sentence_transformers/sentence_transformer/datasets/parallel_sentences.py:45
Method__init__
Creates a LabelSampler for a SentenceLabelDataset. Args: examples (List[InputExample]): A list of InputExamples.
sentence_transformers/sentence_transformer/datasets/sentence_label.py:37
Method__init__
(self, examples: list[InputExample], model: SentenceTransformer)
sentence_transformers/sentence_transformer/datasets/sentences.py:27
Method__init__
This loss is a combination of :class:`GISTEmbedLoss` and :class:`CachedMultipleNegativesRankingLoss`. Typically, :class:`MultipleNega
sentence_transformers/sentence_transformer/losses/cached_gist_embed.py:32
Method__init__
(self, transformer: Transformer, original_forward)
sentence_transformers/sentence_transformer/losses/adaptive_layer.py:28
Method__init__
The AdaptiveLayerLoss can be seen as a loss *modifier* that allows you to use other loss functions at non-final layers of the Sentenc
sentence_transformers/sentence_transformer/losses/adaptive_layer.py:85
Method__init__
The Matryoshka2dLoss can be seen as a loss *modifier* that combines the :class:`AdaptiveLayerLoss` and the :class:`MatryoshkaLoss`. T
sentence_transformers/sentence_transformer/losses/matryoshka_2d.py:15
Method__init__
r""" This loss expects as input pairs of damaged inputs and the corresponding original ones. During training, the decoder reconstructs
sentence_transformers/sentence_transformer/losses/denoising_auto_encoder.py:38
Method__init__
(self, fn)
sentence_transformers/sentence_transformer/losses/matryoshka.py:38
Method__init__
( self, fn, matryoshka_dims: Sequence[int], matryoshka_weights: Sequence[float
sentence_transformers/sentence_transformer/losses/matryoshka.py:76
Method__init__
The MatryoshkaLoss can be seen as a loss *modifier* that allows you to use other loss functions at various different embedding dimens
sentence_transformers/sentence_transformer/losses/matryoshka.py:117
Method__init__
.. warning:: This class has been merged into :class:`~sentence_transformers.sentence_transformer.losses.CachedMultipleNegativesR
sentence_transformers/sentence_transformer/losses/cached_multiple_negatives_symmetric_ranking.py:21
Method__init__
Computes an embedding-distillation loss between the student model's embeddings and pre-computed teacher embeddings (passed as labels)
sentence_transformers/sentence_transformer/losses/embed_distill.py:17
Method__init__
Computes the MSE loss between the student's embedding and a pre-computed target embedding (passed as a label). Used to extend embeddi
sentence_transformers/sentence_transformer/losses/mse.py:11
Method__init__
BatchSemiHardTripletLoss takes a batch with (label, input) pairs and computes the loss for all possible, valid triplets, i.e., anchor
sentence_transformers/sentence_transformer/losses/batch_semi_hard_triplet.py:15
Method__init__
.. warning:: This class has been merged into :class:`~sentence_transformers.sentence_transformer.losses.MultipleNegativesRanking
sentence_transformers/sentence_transformer/losses/multiple_negatives_symmetric_ranking.py:19
Method__init__
Given a dataset of (anchor, positive) pairs, (anchor, positive, negative) triplets, or (anchor, positive, negative_1, ..., negative_n)
sentence_transformers/sentence_transformer/losses/multiple_negatives_ranking.py:18
Method__init__
This class implements triplet loss. Given a triplet of (anchor, positive, negative), the loss minimizes the distance between anchor a
sentence_transformers/sentence_transformer/losses/triplet.py:24
Method__init__
This Online Contrastive loss is similar to :class:`ConstrativeLoss`, but it selects hard positive (positives that are far apart) and
sentence_transformers/sentence_transformer/losses/online_contrastive.py:17
Method__init__
This loss is used to train a SentenceTransformer model using the GISTEmbed algorithm. It takes a model and a guide model as input, an
sentence_transformers/sentence_transformer/losses/gist_embed.py:17
Method__init__
Boosted version of :class:`MultipleNegativesRankingLoss` (https://huggingface.co/papers/1705.00652) by GradCache (https://huggingface.co/pape
sentence_transformers/sentence_transformer/losses/cached_multiple_negatives_ranking.py:27
Method__init__
BatchHardSoftMarginTripletLoss takes a batch with (input, label) pairs and computes the loss for all possible, valid triplets, i.e.,
sentence_transformers/sentence_transformer/losses/batch_hard_soft_margin_triplet.py:15
Method__init__
This class implements CoSENT (Consistent SENTence embedding) loss. It expects that each of the inputs consists of a pair of inputs (e
sentence_transformers/sentence_transformer/losses/cosent.py:15
Method__init__
This loss expects only single inputs, without any labels. Positive and negative pairs are automatically created via random sampling,
sentence_transformers/sentence_transformer/losses/contrastive_tension.py:187
Method__init__
(self, sentences, batch_size, pos_neg_ratio=8)
sentence_transformers/sentence_transformer/losses/contrastive_tension.py:296
Method__init__
Contrastive loss. Expects as input two texts and a label of either 0 or 1. If the label == 1, then the distance between the two embed
sentence_transformers/sentence_transformer/losses/contrastive.py:24
Method__init__
Given a large batch (like 500 or more examples) of (anchor_i, positive_i) pairs, find for each pair in the batch the hardest negative
sentence_transformers/sentence_transformer/losses/mega_batch_margin.py:21
Method__init__
Compute the MSE loss between the predicted margin ``sim(Query, Pos) - sim(Query, Neg)`` and the gold margin ``gold_sim(Query, Pos) -
sentence_transformers/sentence_transformer/losses/margin_mse.py:15
Method__init__
Global Orthogonal Regularization (GOR) Loss that encourages embeddings to be well-distributed in the embedding space by penalizing hi
sentence_transformers/sentence_transformer/losses/global_orthogonal_regularization.py:15
Method__init__
This loss was used in our SBERT publication (https://huggingface.co/papers/1908.10084) to train the SentenceTransformer model on NLI
sentence_transformers/sentence_transformer/losses/softmax.py:21
Method__init__
CosineSimilarityLoss expects that the inputs consist of two inputs (e.g. texts) and a float label. It computes the vectors ``u = mode
sentence_transformers/sentence_transformer/losses/cosine_similarity.py:15
Method__init__
Compute the KL divergence loss between probability distributions derived from student and teacher models' similarity scores. By defau
sentence_transformers/sentence_transformer/losses/distill_kl_div.py:20
Method__init__
BatchAllTripletLoss takes a batch with (input, label) pairs and computes the loss for all possible, valid triplets, i.e., anchor and
sentence_transformers/sentence_transformer/losses/batch_all_triplet.py:14
Method__init__
This class implements AnglE (Angle Optimized) loss. This is a modification of :class:`CoSENTLoss`, designed to address the following
sentence_transformers/sentence_transformer/losses/angle.py:11
Method__init__
BatchHardTripletLoss takes a batch with (input, label) pairs and computes the loss for all possible, valid triplets, i.e., anchor and
sentence_transformers/sentence_transformer/losses/batch_hard_triplet.py:63
Method__init__
( self, sentences1: list[str], sentences2: list[str], labels: list[int],
sentence_transformers/sentence_transformer/evaluation/binary_classification.py:85
Method__init__
( self, samples: list[dict[str, str | list[str]]], at_k: int = 10, name: str =
sentence_transformers/sentence_transformer/evaluation/reranking.py:91
Method__init__
( self, source_sentences: list[str], target_sentences: list[str], teacher_mode
sentence_transformers/sentence_transformer/evaluation/mse.py:72
Method__init__
( self, queries: dict[str, SingleInput], # qid => query corpus: dict[str, SingleInput
sentence_transformers/sentence_transformer/evaluation/information_retrieval.py:131
Method__init__
( self, anchors: Sequence[SingleInput], positives: Sequence[SingleInput], nega
sentence_transformers/sentence_transformer/evaluation/triplet.py:93
Method__init__
Constructs an evaluator for the given dataset Args: dataloader (DataLoader): the data for the evaluation
sentence_transformers/sentence_transformer/evaluation/label_accuracy.py:29
Method__init__
( self, sentences_map: dict[str, str], duplicates_list: list[tuple[str, str]] | None =
sentence_transformers/sentence_transformer/evaluation/paraphrase_mining.py:92
Method__init__
( self, source_sentences: list[str], target_sentences: list[str], show_progres
sentence_transformers/sentence_transformer/evaluation/translation.py:72
Method__init__
( self, sentences1: list[str], sentences2: list[str], scores: list[float],
sentence_transformers/sentence_transformer/evaluation/embedding_similarity.py:82
Method__init__
( self, dataframe: list[dict[str, str]], teacher_model: SentenceTransformer, c
sentence_transformers/sentence_transformer/evaluation/mse_from_dataframe.py:42
Method__init__
( self, dataset_names: list[DatasetNameType | str] | None = None, dataset_id: str = "s
sentence_transformers/sentence_transformer/evaluation/nano_beir.py:214
Method__init__
(self, dataset_folder)
sentence_transformers/sentence_transformer/readers/nli_data.py:22
Method__init__
Creates one InputExample with the given texts, guid and label Args: guid: id for the example texts: the text
sentence_transformers/sentence_transformer/readers/input_example.py:17
Method__init__
( self, dataset_folder, s1_col_idx=0, s2_col_idx=1, s3_col_idx=2,
sentence_transformers/sentence_transformer/readers/triplet.py:24
Method__init__
( self, dataset_folder, s1_col_idx=5, s2_col_idx=6, score_col_idx=4,
sentence_transformers/sentence_transformer/readers/sts_data.py:78
Method__init__
(self, filepaths)
sentence_transformers/sentence_transformer/readers/paired_files.py:21
Method__init__
(self, folder, label_col_idx=0, sentence_col_idx=1, separator="\t")
sentence_transformers/sentence_transformer/readers/label_sentence.py:24
Method__init__
( self, model: MultiVectorEncoder | None = None, args: MultiVectorEncoderTrainingArgum
sentence_transformers/multi_vector_encoder/trainer.py:67
Method__init__
( self, model_name_or_path: str | None = None, *, modules: list[nn.Module] | N
sentence_transformers/multi_vector_encoder/model.py:157
Method__init__
( self, pool_factor: int = 1, *, num_protected_tokens: int = 1, tasks: str | list[str] | None = None
sentence_transformers/multi_vector_encoder/modules/token_pooling.py:249
Method__init__
(self, pool_fn: Callable[[Tensor], Tensor], *, tasks: str | list[str] | None = None)
sentence_transformers/multi_vector_encoder/modules/token_pooling.py:293
Method__init__
( self, skiplist_words: list[str] | None = None, *, skiplist_tasks: str | list
sentence_transformers/multi_vector_encoder/modules/multi_vector_mask.py:70
Method__init__
( self, model: MultiVectorEncoder, *, scale: float = 1.0, similarity_f
sentence_transformers/multi_vector_encoder/losses/multiple_negatives_ranking.py:111
Method__init__
( self, model: MultiVectorEncoder, *, scale: float = 1.0, similarity_f
sentence_transformers/multi_vector_encoder/losses/cached_multiple_negatives_ranking.py:134
Method__init__
( self, model: MultiVectorEncoder, *, similarity_fct: Callable | None = None,
sentence_transformers/multi_vector_encoder/losses/margin_mse.py:93
Method__init__
( self, model: MultiVectorEncoder, *, similarity_fct: Callable | None = None,
sentence_transformers/multi_vector_encoder/losses/distill_kl_div.py:106
Method__init__
( self, queries: Sequence[SingleInput], documents: Sequence[SingleInput] | Sequence[Se
sentence_transformers/multi_vector_encoder/evaluation/distillation.py:109
Method__init__
( self, samples: list[dict], *, at_k: int = 10, name: str = "",
sentence_transformers/multi_vector_encoder/evaluation/reranking.py:64
Method__init__
( self, queries: dict[str, SingleInput], corpus: dict[str, SingleInput], relev
sentence_transformers/multi_vector_encoder/evaluation/information_retrieval.py:107
Method__init__
(self, *args, **kwargs)
sentence_transformers/multi_vector_encoder/evaluation/triplet.py:56
Method__init__
( self, *args, corpus_chunk_size: int = 5000, chunk_elements: int | None = Non
sentence_transformers/multi_vector_encoder/evaluation/nano_beir.py:82
Method__init__
(self, top_k: int = 256, *, chunk_elements: int | None = None)
sentence_transformers/multi_vector_encoder/scoring/xtr.py:201
Method__init__
(self, output_dir: str, evaluator: BaseEvaluator | None, save_best_model: bool)
sentence_transformers/cross_encoder/fit_mixin.py:47
Method__init__
(self, evaluator: BaseEvaluator, output_path: str | None = None)
sentence_transformers/cross_encoder/fit_mixin.py:84
Method__init__
(self, callback: Callable[[float, int, int], None], evaluator: BaseEvaluator)
sentence_transformers/cross_encoder/fit_mixin.py:124
Method__init__
( self, model: CrossEncoder | None = None, args: CrossEncoderTrainingArguments | None
sentence_transformers/cross_encoder/trainer.py:114
Method__init__
( self, model_name_or_path: str | None = None, *, modules: list[nn.Module] | O
sentence_transformers/cross_encoder/model.py:150
Method__init__
( self, true_token_id: int, false_token_id: int | None = None, module_input_na
sentence_transformers/cross_encoder/modules/logit_score.py:31
Method__init__
(self, *args, **kwargs)
sentence_transformers/cross_encoder/losses/lambda_loss.py:15
Method__init__
(self, mu: float = 10.0)
sentence_transformers/cross_encoder/losses/lambda_loss.py:91
Method__init__
This loss function implements the ListMLE learning to rank algorithm, which uses a list-wise approach based on maximum likelihood est
sentence_transformers/cross_encoder/losses/list_mle.py:10
Method__init__
Computes the MSE loss between the computed query-document score and a target query-document score. This loss is used to distill a cro
sentence_transformers/cross_encoder/losses/mse.py:10
← previousnext →1,001–1,100 of 3,759, ranked by callers