Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/huggingface/sentence-transformers
/ functions
Functions
4,575 in github.com/huggingface/sentence-transformers
⨍
Functions
4,575
◇
Types & classes
516
↳
Endpoints
81
Method
load
( cls, model_name_or_path: str = "", subfolder: str = "", token: bool | str |
sentence_transformers/base/modules/normalize.py:49
Method
load
Load a Transformer module from a pretrained model directory or Hugging Face model name.
sentence_transformers/base/modules/transformer.py:2652
Method
load
( cls, model_name_or_path: str, subfolder: str = "", token: bool | str | None
sentence_transformers/base/modules/router.py:643
Method
load
( cls, model_name_or_path: str, subfolder: str = "", token: bool | str | None
tests/base/test_model.py:2011
Method
load_config
(cls, *args, **kwargs)
sentence_transformers/multi_vector_encoder/modules/token_pooling.py:419
Method
load_data
Reads in a tab-separated .txt/.csv/.tsv or .gz file. The different columns contain the different translations of the sentence in the first co
sentence_transformers/sentence_transformer/datasets/parallel_sentences.py:74
Function
loader
(monkeypatch)
tests/test_kernels.py:82
Function
loss_training_model
()
tests/base/test_trainer.py:399
Function
low_precision_embeddings
()
tests/util/test_similarity.py:519
Function
map_embeddings
(batch)
examples/sentence_transformer/training/distillation/model_distillation_layer_reduction.py:141
Function
map_embeddings
(batch)
examples/sentence_transformer/training/distillation/model_distillation.py:129
Method
mapper
( sample, corpus_mapping: dict[str, str], query_mapping: dict[str, str],
sentence_transformers/cross_encoder/evaluation/nano_beir.py:356
Method
mask_false_negatives
(guided_sim_mat, sim_mat, positive_mask: Tensor | None = None)
sentence_transformers/sentence_transformer/losses/cached_gist_embed.py:301
Method
mask_false_negatives
(guided_sim_mat, sim_mat, positive_mask: Tensor | None = None)
sentence_transformers/sentence_transformer/losses/gist_embed.py:198
Method
max_length
(self)
sentence_transformers/cross_encoder/model.py:419
Method
max_seq_length
(self)
sentence_transformers/sentence_transformer/modules/static_embedding.py:127
Method
max_seq_length
Returns the maximal input sequence length for the model. Longer inputs will be truncated. Returns: int: The maximal inpu
sentence_transformers/sparse_encoder/model.py:1235
Method
max_seq_length
Returns the maximal input sequence length for the model. Longer inputs will be truncated. Returns: Optional[int]: The ma
sentence_transformers/base/model.py:2139
Method
max_seq_length
The maximum input sequence length. Reads from the tokenizer if available, otherwise falls back to ``max_position_embeddings`` from the model c
sentence_transformers/base/modules/transformer.py:1183
Method
max_seq_length
(self)
sentence_transformers/base/modules/router.py:728
Method
maybe_to_float
(value: Any)
sentence_transformers/base/evaluation/evaluator.py:49
Function
mean_colbert_kd_scores
MeanMaxSim listwise KD scoring, the :func:`colbert_kd_scores` counterpart of :func:`mean_colbert_scores`. Use it as :class:`MultiVectorDistillKLDi
sentence_transformers/multi_vector_encoder/scoring/colbert.py:275
Function
mean_colbert_scores
MeanMaxSim contrastive scoring: :func:`colbert_scores` divided by each query's real token count. Pair it with ``model.similarity_fn_name = "meanm
sentence_transformers/multi_vector_encoder/scoring/colbert.py:228
Function
mean_colbert_scores_pairwise
MeanMaxSim pairwise scoring, the :func:`colbert_scores_pairwise` counterpart of :func:`mean_colbert_scores`. Use it as :class:`MultiVectorMarginMS
sentence_transformers/multi_vector_encoder/scoring/colbert.py:253
Function
missing
(*args, **kwargs)
tests/test_kernels.py:909
Method
mixed_modality_features
(self)
tests/sentence_transformer/losses/test_cmnrl.py:220
Function
mnrl_mapper
(batch)
examples/cross_encoder/training/ms_marco/training_ms_marco_cmnrl.py:39
Function
mock_apply_chat_template
(messages, **kwargs)
tests/base/modules/test_transformer.py:1234
Method
mock_apply_chat_template
(messages, **kwargs)
tests/base/modules/test_transformer.py:1320
Function
mock_create_branch
(self, repo_id, branch, revision=None, **kwargs)
tests/sentence_transformer/test_model.py:146
Function
mock_create_branch
(self, repo_id, branch, revision=None, **kwargs)
tests/cross_encoder/test_model.py:564
Function
mock_create_branch
(self, repo_id, branch, revision=None, **kwargs)
tests/base/test_model.py:778
Function
mock_create_repo
(self, repo_id, **kwargs)
tests/sentence_transformer/test_model.py:124
Function
mock_create_repo
(self, repo_id, **kwargs)
tests/cross_encoder/test_model.py:542
Function
mock_create_repo
(self, repo_id, **kwargs)
tests/base/test_model.py:760
Method
mock_forward
(**kwargs)
tests/base/modules/test_transformer.py:804
Function
mock_from_pretrained
(*args, **kwargs)
tests/util/test_environment.py:88
Function
mock_get_class
(class_ref, model_name_or_path, **kwargs)
tests/base/test_model.py:657
Function
mock_hub_info
Mock the Hub requests checking whether base models and datasets exist, e.g. to dodge rate limits in CI.
tests/conftest.py:62
Function
mock_init
(self, *args, **kwargs)
tests/cross_encoder/test_model.py:685
Function
mock_load_modules
(self, model_name_or_path, **kwargs)
tests/base/test_model.py:448
Function
mock_loss
Create a mock base loss for testing.
tests/sentence_transformer/losses/test_matryoshka.py:22
Function
mock_model
()
tests/sentence_transformer/evaluation/test_information_retrieval_evaluator.py:14
Function
mock_predict
(self, *args, **kwargs)
tests/cross_encoder/test_model.py:727
Function
mock_preprocess
(texts, **kwargs)
tests/util/test_hard_negatives.py:1734
Function
mock_upload_folder
(self, **kwargs)
tests/sentence_transformer/test_model.py:129
Function
mock_upload_folder
(self, **kwargs)
tests/cross_encoder/test_model.py:547
Function
mock_upload_folder
(self, **kwargs)
tests/base/test_model.py:763
Method
modalities
Return the list of modalities supported by this model, e.g. ``["text"]`` or ``["text", "image", "message"]``.
sentence_transformers/base/model.py:453
Method
modalities
The list of supported input modalities. Defaults to ``["text"]``.
sentence_transformers/base/modules/input_module.py:71
Method
modalities
The list of supported input modalities (e.g. ``"text"``, ``"image"``, ``("image", "text")``).
sentence_transformers/base/modules/transformer.py:1216
Method
modalities
The union of modalities supported by all sub-module input modules.
sentence_transformers/base/modules/router.py:328
Method
modalities
(self)
tests/base/modules/test_router.py:66
Method
model_card_get_pooling_function
(pooling_mode)
sentence_transformers/sentence_transformer/deprecated_model_card_templates.py:125
Function
model_dir
(tmp_path_factory)
tests/multi_vector_encoder/test_backends.py:31
Function
model_init
()
tests/sentence_transformer/test_trainer.py:1165
Function
multiclass_bert_tiny_model
(_multiclass_bert_tiny_model: CrossEncoder)
tests/cross_encoder/conftest.py:41
Function
multiple_positive_dataset
Return a sample dataset with multiple matching passages for each query.
tests/util/test_hard_negatives.py:105
Function
multiple_positive_passages_dataset
Return a sample dataset with multiple matching passages for each query.
tests/util/test_hard_negatives.py:94
Function
multiple_positive_queries_dataset
Return a sample dataset with multiple matching passages for each query.
tests/util/test_hard_negatives.py:83
Function
mve_bert_tiny_model
(_mve_bert_tiny_model: MultiVectorEncoder)
tests/conftest.py:242
Method
naive_feature
(value: Any)
sentence_transformers/base/trainer.py:252
Function
nli_resource
()
tests/sentence_transformer/test_train_stsb.py:28
Function
notice
(self, message, *args, **kws)
sentence_transformers/util/logging.py:34
Function
null_batch_sampler
(*args, **kwargs)
tests/sentence_transformer/test_trainer.py:996
Function
null_multi_dataset_batch_sampler
(*args, **kwargs)
tests/sentence_transformer/test_trainer.py:1122
Method
num_labels
(self)
sentence_transformers/cross_encoder/model.py:399
Method
num_labels
(self)
tests/cross_encoder/losses/test_misc.py:105
Method
old_fit
Deprecated training method from before Sentence Transformers v3.0, it is recommended to use :class:`sentence_transformers.sentence_tr
sentence_transformers/sentence_transformer/fit_mixin.py:469
Function
onLoad
()
docs/_static/js/custom.js:32
Method
on_epoch_end
( self, args: SentenceTransformerTrainingArguments, state: TrainerState, contr
sentence_transformers/sentence_transformer/fit_mixin.py:109
Method
on_epoch_end
( self, args: CrossEncoderTrainingArguments, state: TrainerState, control: Tra
sentence_transformers/cross_encoder/fit_mixin.py:95
Method
on_evaluate
( self, args: SentenceTransformerTrainingArguments, state: TrainerState, contr
sentence_transformers/sentence_transformer/fit_mixin.py:62
Method
on_evaluate
( self, args: CrossEncoderTrainingArguments, state: TrainerState, control: Tra
sentence_transformers/cross_encoder/fit_mixin.py:59
Method
on_evaluate
( self, args: BaseTrainingArguments, state: TrainerState, control: TrainerCont
sentence_transformers/base/model_card.py:194
Method
on_log
Log the current weight values.
sentence_transformers/sparse_encoder/callbacks/splade_callbacks.py:144
Method
on_log
( self, args: BaseTrainingArguments, state: TrainerState, control: TrainerCont
sentence_transformers/base/model_card.py:227
Method
on_model_ready
(self, model: BaseModel)
sentence_transformers/multi_vector_encoder/modules/multi_vector_mask.py:89
Method
on_model_ready
(self, model: BaseModel)
sentence_transformers/base/modules/router.py:521
Method
on_model_ready
(self, model)
tests/base/modules/test_router.py:53
Method
on_step_begin
Update weight values at the beginning of each step.
sentence_transformers/sparse_encoder/callbacks/splade_callbacks.py:114
Method
on_step_end
(self, args, state, control, optimizer, **kwargs)
sentence_transformers/base/trainer.py:85
Method
on_step_end
(self, args, state, control, **kwargs)
tests/base/test_trainer.py:506
Method
on_step_end
( self, args: SentenceTransformerTrainingArguments, state: TrainerState, control: TrainerControl,
examples/sentence_transformer/training/data_augmentation/train_sts_seed_optimization.py:112
Method
on_train_begin
Initialize the scheduler at the beginning of training.
sentence_transformers/sparse_encoder/callbacks/splade_callbacks.py:74
Method
on_train_begin
(self, args, state, control, optimizer, **kwargs)
sentence_transformers/base/trainer.py:82
Method
on_train_end
( self, args: SentenceTransformerTrainingArguments, state: TrainerState, contr
sentence_transformers/sentence_transformer/fit_mixin.py:79
Method
one_to_many
(query_embeddings: Tensor | list[Tensor], document_embeddings: list[Tensor])
sentence_transformers/multi_vector_encoder/evaluation/reranking.py:102
Function
pack
(tensor)
tests/sentence_transformer/losses/test_cosent.py:131
Function
pack
(tensor)
tests/sentence_transformer/losses/test_triplet.py:101
Function
pack
(tensor)
tests/sentence_transformer/losses/test_batch_all_triplet.py:65
Method
partition_mode
(self)
sentence_transformers/sentence_transformer/losses/cached_multiple_negatives_ranking.py:233
Function
passages
Return a list of sample passages.
tests/util/test_hard_negatives.py:66
Function
patch_torchcodec_int64_indices
Coerce numpy frame indices to int64 for torchcodec on Windows. transformers' video samplers return numpy int arrays, which are int32 on Windows
tests/base/modules/transformer/conftest.py:207
Method
patched_from_pretrained
(*args, **kwargs)
tests/base/modules/test_transformer.py:147
Function
patched_init
(self, *args, **kwargs)
tests/sentence_transformer/test_model.py:1426
Function
patched_save
(self, path, safe_serialization=None)
tests/base/test_model.py:522
Function
peft_wrapper
Wrapper to call the method on the auto_model with a check for PEFT compatibility.
sentence_transformers/base/peft_mixin.py:8
Method
plain_func
(x)
tests/base/modules/test_transformer.py:1843
Method
pool_one
(self, embedding: Tensor, **kwargs)
sentence_transformers/multi_vector_encoder/modules/token_pooling.py:624
← previous
next →
2,001–2,100 of 4,575, ranked by callers