MCPcopy Create free account

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

Functions4,575 in github.com/huggingface/sentence-transformers

Methodload
( cls, model_name_or_path: str = "", subfolder: str = "", token: bool | str |
sentence_transformers/base/modules/normalize.py:49
Methodload
Load a Transformer module from a pretrained model directory or Hugging Face model name.
sentence_transformers/base/modules/transformer.py:2652
Methodload
( cls, model_name_or_path: str, subfolder: str = "", token: bool | str | None
sentence_transformers/base/modules/router.py:643
Methodload
( cls, model_name_or_path: str, subfolder: str = "", token: bool | str | None
tests/base/test_model.py:2011
Methodload_config
(cls, *args, **kwargs)
sentence_transformers/multi_vector_encoder/modules/token_pooling.py:419
Methodload_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
Functionloader
(monkeypatch)
tests/test_kernels.py:82
Functionloss_training_model
()
tests/base/test_trainer.py:399
Functionlow_precision_embeddings
()
tests/util/test_similarity.py:519
Functionmap_embeddings
(batch)
examples/sentence_transformer/training/distillation/model_distillation_layer_reduction.py:141
Functionmap_embeddings
(batch)
examples/sentence_transformer/training/distillation/model_distillation.py:129
Methodmapper
( sample, corpus_mapping: dict[str, str], query_mapping: dict[str, str],
sentence_transformers/cross_encoder/evaluation/nano_beir.py:356
Methodmask_false_negatives
(guided_sim_mat, sim_mat, positive_mask: Tensor | None = None)
sentence_transformers/sentence_transformer/losses/cached_gist_embed.py:301
Methodmask_false_negatives
(guided_sim_mat, sim_mat, positive_mask: Tensor | None = None)
sentence_transformers/sentence_transformer/losses/gist_embed.py:198
Methodmax_length
(self)
sentence_transformers/cross_encoder/model.py:419
Methodmax_seq_length
(self)
sentence_transformers/sentence_transformer/modules/static_embedding.py:127
Methodmax_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
Methodmax_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
Methodmax_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
Methodmax_seq_length
(self)
sentence_transformers/base/modules/router.py:728
Methodmaybe_to_float
(value: Any)
sentence_transformers/base/evaluation/evaluator.py:49
Functionmean_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
Functionmean_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
Functionmean_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
Functionmissing
(*args, **kwargs)
tests/test_kernels.py:909
Methodmixed_modality_features
(self)
tests/sentence_transformer/losses/test_cmnrl.py:220
Functionmnrl_mapper
(batch)
examples/cross_encoder/training/ms_marco/training_ms_marco_cmnrl.py:39
Functionmock_apply_chat_template
(messages, **kwargs)
tests/base/modules/test_transformer.py:1234
Methodmock_apply_chat_template
(messages, **kwargs)
tests/base/modules/test_transformer.py:1320
Functionmock_create_branch
(self, repo_id, branch, revision=None, **kwargs)
tests/sentence_transformer/test_model.py:146
Functionmock_create_branch
(self, repo_id, branch, revision=None, **kwargs)
tests/cross_encoder/test_model.py:564
Functionmock_create_branch
(self, repo_id, branch, revision=None, **kwargs)
tests/base/test_model.py:778
Functionmock_create_repo
(self, repo_id, **kwargs)
tests/sentence_transformer/test_model.py:124
Functionmock_create_repo
(self, repo_id, **kwargs)
tests/cross_encoder/test_model.py:542
Functionmock_create_repo
(self, repo_id, **kwargs)
tests/base/test_model.py:760
Methodmock_forward
(**kwargs)
tests/base/modules/test_transformer.py:804
Functionmock_from_pretrained
(*args, **kwargs)
tests/util/test_environment.py:88
Functionmock_get_class
(class_ref, model_name_or_path, **kwargs)
tests/base/test_model.py:657
Functionmock_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
Functionmock_init
(self, *args, **kwargs)
tests/cross_encoder/test_model.py:685
Functionmock_load_modules
(self, model_name_or_path, **kwargs)
tests/base/test_model.py:448
Functionmock_loss
Create a mock base loss for testing.
tests/sentence_transformer/losses/test_matryoshka.py:22
Functionmock_model
()
tests/sentence_transformer/evaluation/test_information_retrieval_evaluator.py:14
Functionmock_predict
(self, *args, **kwargs)
tests/cross_encoder/test_model.py:727
Functionmock_preprocess
(texts, **kwargs)
tests/util/test_hard_negatives.py:1734
Functionmock_upload_folder
(self, **kwargs)
tests/sentence_transformer/test_model.py:129
Functionmock_upload_folder
(self, **kwargs)
tests/cross_encoder/test_model.py:547
Functionmock_upload_folder
(self, **kwargs)
tests/base/test_model.py:763
Methodmodalities
Return the list of modalities supported by this model, e.g. ``["text"]`` or ``["text", "image", "message"]``.
sentence_transformers/base/model.py:453
Methodmodalities
The list of supported input modalities. Defaults to ``["text"]``.
sentence_transformers/base/modules/input_module.py:71
Methodmodalities
The list of supported input modalities (e.g. ``"text"``, ``"image"``, ``("image", "text")``).
sentence_transformers/base/modules/transformer.py:1216
Methodmodalities
The union of modalities supported by all sub-module input modules.
sentence_transformers/base/modules/router.py:328
Methodmodalities
(self)
tests/base/modules/test_router.py:66
Methodmodel_card_get_pooling_function
(pooling_mode)
sentence_transformers/sentence_transformer/deprecated_model_card_templates.py:125
Functionmodel_dir
(tmp_path_factory)
tests/multi_vector_encoder/test_backends.py:31
Functionmodel_init
()
tests/sentence_transformer/test_trainer.py:1165
Functionmulticlass_bert_tiny_model
(_multiclass_bert_tiny_model: CrossEncoder)
tests/cross_encoder/conftest.py:41
Functionmultiple_positive_dataset
Return a sample dataset with multiple matching passages for each query.
tests/util/test_hard_negatives.py:105
Functionmultiple_positive_passages_dataset
Return a sample dataset with multiple matching passages for each query.
tests/util/test_hard_negatives.py:94
Functionmultiple_positive_queries_dataset
Return a sample dataset with multiple matching passages for each query.
tests/util/test_hard_negatives.py:83
Functionmve_bert_tiny_model
(_mve_bert_tiny_model: MultiVectorEncoder)
tests/conftest.py:242
Methodnaive_feature
(value: Any)
sentence_transformers/base/trainer.py:252
Functionnli_resource
()
tests/sentence_transformer/test_train_stsb.py:28
Functionnotice
(self, message, *args, **kws)
sentence_transformers/util/logging.py:34
Functionnull_batch_sampler
(*args, **kwargs)
tests/sentence_transformer/test_trainer.py:996
Functionnull_multi_dataset_batch_sampler
(*args, **kwargs)
tests/sentence_transformer/test_trainer.py:1122
Methodnum_labels
(self)
sentence_transformers/cross_encoder/model.py:399
Methodnum_labels
(self)
tests/cross_encoder/losses/test_misc.py:105
Methodold_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
FunctiononLoad
()
docs/_static/js/custom.js:32
Methodon_epoch_end
( self, args: SentenceTransformerTrainingArguments, state: TrainerState, contr
sentence_transformers/sentence_transformer/fit_mixin.py:109
Methodon_epoch_end
( self, args: CrossEncoderTrainingArguments, state: TrainerState, control: Tra
sentence_transformers/cross_encoder/fit_mixin.py:95
Methodon_evaluate
( self, args: SentenceTransformerTrainingArguments, state: TrainerState, contr
sentence_transformers/sentence_transformer/fit_mixin.py:62
Methodon_evaluate
( self, args: CrossEncoderTrainingArguments, state: TrainerState, control: Tra
sentence_transformers/cross_encoder/fit_mixin.py:59
Methodon_evaluate
( self, args: BaseTrainingArguments, state: TrainerState, control: TrainerCont
sentence_transformers/base/model_card.py:194
Methodon_log
Log the current weight values.
sentence_transformers/sparse_encoder/callbacks/splade_callbacks.py:144
Methodon_log
( self, args: BaseTrainingArguments, state: TrainerState, control: TrainerCont
sentence_transformers/base/model_card.py:227
Methodon_model_ready
(self, model: BaseModel)
sentence_transformers/multi_vector_encoder/modules/multi_vector_mask.py:89
Methodon_model_ready
(self, model: BaseModel)
sentence_transformers/base/modules/router.py:521
Methodon_model_ready
(self, model)
tests/base/modules/test_router.py:53
Methodon_step_begin
Update weight values at the beginning of each step.
sentence_transformers/sparse_encoder/callbacks/splade_callbacks.py:114
Methodon_step_end
(self, args, state, control, optimizer, **kwargs)
sentence_transformers/base/trainer.py:85
Methodon_step_end
(self, args, state, control, **kwargs)
tests/base/test_trainer.py:506
Methodon_step_end
( self, args: SentenceTransformerTrainingArguments, state: TrainerState, control: TrainerControl,
examples/sentence_transformer/training/data_augmentation/train_sts_seed_optimization.py:112
Methodon_train_begin
Initialize the scheduler at the beginning of training.
sentence_transformers/sparse_encoder/callbacks/splade_callbacks.py:74
Methodon_train_begin
(self, args, state, control, optimizer, **kwargs)
sentence_transformers/base/trainer.py:82
Methodon_train_end
( self, args: SentenceTransformerTrainingArguments, state: TrainerState, contr
sentence_transformers/sentence_transformer/fit_mixin.py:79
Methodone_to_many
(query_embeddings: Tensor | list[Tensor], document_embeddings: list[Tensor])
sentence_transformers/multi_vector_encoder/evaluation/reranking.py:102
Functionpack
(tensor)
tests/sentence_transformer/losses/test_cosent.py:131
Functionpack
(tensor)
tests/sentence_transformer/losses/test_triplet.py:101
Functionpack
(tensor)
tests/sentence_transformer/losses/test_batch_all_triplet.py:65
Methodpartition_mode
(self)
sentence_transformers/sentence_transformer/losses/cached_multiple_negatives_ranking.py:233
Functionpassages
Return a list of sample passages.
tests/util/test_hard_negatives.py:66
Functionpatch_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
Methodpatched_from_pretrained
(*args, **kwargs)
tests/base/modules/test_transformer.py:147
Functionpatched_init
(self, *args, **kwargs)
tests/sentence_transformer/test_model.py:1426
Functionpatched_save
(self, path, safe_serialization=None)
tests/base/test_model.py:522
Functionpeft_wrapper
Wrapper to call the method on the auto_model with a check for PEFT compatibility.
sentence_transformers/base/peft_mixin.py:8
Methodplain_func
(x)
tests/base/modules/test_transformer.py:1843
Methodpool_one
(self, embedding: Tensor, **kwargs)
sentence_transformers/multi_vector_encoder/modules/token_pooling.py:624
← previousnext →2,001–2,100 of 4,575, ranked by callers