Functions — github.com/huggingface/sentence-transformers

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

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

⨍ Functions 3,759◇ Types & classes 446↳ Endpoints 48

Functioncounting_forward

(features, **kwargs)

tests/sparse_encoder/losses/test_merged_forward.py:81

Methodcreate_dense_text_model

(self, request: pytest.FixtureRequest)

tests/base/test_model.py:76

Methodcreate_dense_text_model

(self, request: pytest.FixtureRequest)

tests/base/test_model.py:84

Methodcreate_dense_text_model

(self, request: pytest.FixtureRequest)

tests/base/test_model.py:92

Methodcreate_model_card

( self, language: str | None = None, license: str | None = None, tags: str | l

sentence_transformers/base/trainer.py:1217

Methodcreate_module

(self, spec)

sentence_transformers/util/deprecated_import.py:194

Methodcreate_text_inputs

(self)

tests/base/test_model.py:79

Methodcreate_text_inputs

(self)

tests/base/test_model.py:87

Methodcreate_text_inputs

(self)

tests/base/test_model.py:95

Functioncross_encoder_init_args_decorator

Decorator for :class:`CrossEncoder.__init__` that handles deprecated keyword arguments. Handles the following legacy kwargs: * ``model_name`

sentence_transformers/util/decorators.py:97

Functioncsr_bert_tiny_model

(_csr_bert_tiny_model: SparseEncoder)

tests/conftest.py:189

Functioncustom_batch_sampler

(dataset, batch_size, drop_last, valid_label_columns, generator, seed)

tests/sentence_transformer/test_trainer.py:834

Functioncustom_multi_dataset_batch_sampler

(dataset, batch_samplers, generator, seed)

tests/sentence_transformer/test_trainer.py:964

Functiond

()

docs/_static/js/custom.js:28

Functiondataset

Return a sample dataset with matching queries and passages.

tests/util/test_hard_negatives.py:70

Functiondecorator

(func: F)

sentence_transformers/util/decorators.py:33

Functiondecorator

(*args, **kwargs)

tests/sentence_transformer/test_backends.py:184

Functiondecorator

(*args, **kwargs)

tests/cross_encoder/test_backends.py:192

Functiondecorator

(*args, **kwargs)

tests/sparse_encoder/test_backends.py:187

Methoddefault_activation_function

(self)

sentence_transformers/cross_encoder/model.py:467

Methoddelete_adapter

If you are not familiar with adapters and PEFT methods, we invite you to read more about them on the PEFT official documentation: htt

sentence_transformers/base/peft_mixin.py:150

Functiondeprecated_kwargs

Decorator factory that transparently renames deprecated keyword arguments. Emits a deprecation warning when a caller uses the old name. If both o

sentence_transformers/util/decorators.py:16

Methoddescription

(self)

sentence_transformers/sentence_transformer/evaluation/mse.py:151

Methoddescription

(self)

sentence_transformers/sentence_transformer/evaluation/embedding_similarity.py:263

Methoddescription

(self)

sentence_transformers/sentence_transformer/evaluation/mse_from_dataframe.py:138

Methoddescription

Returns a human-readable description of the evaluator: BinaryClassificationEvaluator -> Binary Classification 1. Replace "CE" prefix

sentence_transformers/base/evaluation/evaluator.py:72

Methoddirections

(self)

sentence_transformers/sentence_transformer/losses/cached_multiple_negatives_ranking.py:229

Functiondistilbert_base_uncased_model

(_distilbert_base_uncased_model: SentenceTransformer)

tests/conftest.py:133

Functiondistilroberta_base_ce_model

()

tests/cross_encoder/conftest.py:11

Functiondocuments

()

tests/util/test_dataset.py:19

Methoddtype

`torch.dtype`: The dtype of the module (assuming that all the module parameters have the same dtype).

sentence_transformers/base/model.py:1733

Functiondummy_concat_dataset

Dummy dataset for testing purposes. The dataset looks as follows: { "data": [0, 1, 2, ... , 23, 24, 100, 101, ..., 123, 124],

tests/base/samplers/test_round_robin_batch_sampler.py:21

Functiondummy_dataset

Dummy dataset for testing purposes. The dataset looks as follows: { "anchor": ["anchor 1", "anchor 2", ..., "anchor 10"], "po

tests/sentence_transformer/test_model_card.py:33

Functiondummy_dataset

()

tests/multi_vector_encoder/test_model_card.py:45

Functiondummy_dataset

Dummy dataset for testing purposes. The dataset looks as follows: { "anchor": ["anchor 1", "anchor 2", ..., "anchor 10"], "po

tests/cross_encoder/test_model_card.py:21

Functiondummy_dataset

Dummy dataset for testing purposes. The dataset looks as follows: { "anchor": ["anchor 1", "anchor 2", ..., "anchor 10"], "po

tests/sparse_encoder/test_model_card.py:25

Functiondummy_dataset

Dummy dataset for testing purposes. The dataset looks as follows: { "data": [0, 47, 3, 30, 3, ... 2], "label": [0, 1, 0, 1, .

tests/base/samplers/test_no_duplicates_batch_sampler.py:43

Functiondummy_duplicates_dataset

Dummy dataset for testing purposes. The dataset looks as follows: { "anchor": ["anchor_1", "anchor_1", "anchor_1", ... "anchor_2", "a

tests/base/samplers/test_no_duplicates_batch_sampler.py:60

Functiondummy_model

()

tests/sentence_transformer/losses/test_cosent.py:12

Functiondummy_model

()

tests/sentence_transformer/losses/test_triplet.py:10

Functiondummy_train_eval_datasets_for_trainer

()

tests/sparse_encoder/test_trainer.py:25

Functiondummy_transform

(batch)

tests/sentence_transformer/test_model_card.py:364

Functiondummy_transform

(batch)

tests/cross_encoder/test_model_card.py:168

Functiondummy_transform

(batch)

tests/sparse_encoder/test_model_card.py:238

Methodembed_inputs

( self, model: MultiVectorEncoder, sentences: SingleInput | Sequence[SingleInput],

sentence_transformers/multi_vector_encoder/evaluation/reranking.py:100

Methodembed_inputs

( self, model: MultiVectorEncoder, sentences: SingleInput | Sequence[SingleInput] | np

sentence_transformers/multi_vector_encoder/evaluation/information_retrieval.py:192

Methodembed_inputs

( self, model: MultiVectorEncoder, sentences: SingleInput | Sequence[SingleInput] | np

sentence_transformers/multi_vector_encoder/evaluation/triplet.py:75

Methodembed_inputs

( self, model: SparseEncoder, sentences: str | list[str] | np.ndarray, encode_

sentence_transformers/sparse_encoder/evaluation/sparse_information_retrieval.py:236

Methodembed_inputs

( self, model: SparseEncoder, sentences: str | list[str] | np.ndarray, **kwarg

sentence_transformers/sparse_encoder/evaluation/sparse_binary_classification.py:161

Methodembed_inputs

( self, model: SparseEncoder, sentences: str | list[str] | np.ndarray, encode_

sentence_transformers/sparse_encoder/evaluation/sparse_reranking.py:164

Methodembed_inputs

( self, model: SparseEncoder, sentences: str | list[str] | np.ndarray, **kwarg

sentence_transformers/sparse_encoder/evaluation/sparse_translation.py:128

Methodembed_inputs

( self, model: SparseEncoder, sentences: str | list[str] | np.ndarray, encode_

sentence_transformers/sparse_encoder/evaluation/sparse_triplet.py:161

Methodembed_inputs

( self, model: SparseEncoder, sentences: str | list[str] | np.ndarray, **kwarg

sentence_transformers/sparse_encoder/evaluation/sparse_embedding_similarity.py:139

Methodembed_inputs

( self, model: SparseEncoder, sentences: str | list[str] | np.ndarray, **kwarg

sentence_transformers/sparse_encoder/evaluation/sparse_mse.py:137

Methodembed_minibatch_iter

Adapter for the shared backward hook, which iterates per-column features. This loss has one "column": the flat pair list, bundled with the pro

sentence_transformers/cross_encoder/losses/cached_multiple_negatives_ranking.py:200

Functionembedding_weights

()

tests/conftest.py:200

Methodemit

(self, record)

sentence_transformers/util/logging.py:12

Methodenable_adapters

Enable adapters that are attached to the model. The model will use `self.active_adapter()`

sentence_transformers/base/peft_mixin.py:107

Methodencode

(self, sentences, **kwargs)

tests/sentence_transformer/evaluation/test_binary_classification_evaluator.py:71

Methodencode_multi_process

.. warning:: This method is deprecated. You can now call :meth:`SentenceTransformer.encode` with the same parameters

sentence_transformers/sentence_transformer/model.py:1099

Methodeuclidean_distance

Compute the 2D matrix of euclidean distances between all the embeddings. Args: embeddings: tensor of shape (batch_size, e

sentence_transformers/sentence_transformer/losses/batch_hard_triplet.py:22

Methodevaluate

( self, eval_dataset: str | Dataset | dict[str, Dataset] | None = None, ignore_keys: l

sentence_transformers/base/trainer.py:627

Methodevaluation_loop

( self, dataloader: DataLoader, description: str, prediction_loss_only: bool |

sentence_transformers/base/trainer.py:638

Functionevaluation_loop_stub

(dataloader, *loop_args, metric_key_prefix="eval", **loop_kwargs)

tests/sentence_transformer/test_trainer.py:1167

Methodexec_module

(self, module)

sentence_transformers/util/deprecated_import.py:197

Functionexpand_with_negatives

(batch, col_a, col_b)

examples/cross_encoder/training/multimodal/training_doodles_feature_extraction.py:118

Functionexpand_with_negatives

(batch, col_a, col_b)

examples/cross_encoder/training/multimodal/training_doodles_any_to_any.py:101

Methodextra_repr

(self)

sentence_transformers/base/modules/router.py:512

Functionfail_get_class

(*args, **kwargs)

tests/util/test_misc.py:67

Functionfail_hub_request

(*args, **kwargs)

tests/base/test_model.py:675

Functionfail_if_called

(inputs, **kwargs)

tests/base/test_model.py:244

Functionfake_count

(messages)

tests/multi_vector_encoder/test_model.py:1223

Functionfake_gather

(tensor: torch.Tensor)

tests/sentence_transformer/losses/test_gist_embed.py:43

Functionfake_gather

(tensor: torch.Tensor)

tests/sentence_transformer/losses/test_cached_gist_embed.py:41

Functionfake_get_start_method

(allow_none=False)

tests/sentence_transformer/test_training_args.py:214

Functionfake_iinfo

(dtype)

tests/base/samplers/test_no_duplicates_batch_sampler.py:429

Functionfake_import_module_class

(class_ref, **kwargs)

tests/sentence_transformer/modules/test_word_embeddings.py:30

Functionfake_import_module_class

(class_ref, **kwargs)

tests/base/modules/test_router.py:705

Functionfake_randperm

(*args, **kwargs)

tests/base/samplers/test_no_duplicates_batch_sampler.py:437

Methodfind_model_output_class

(type_annotation)

sentence_transformers/base/modules/transformer.py:2563

Methodfind_tensor_attributes

(module: nn.Module)

sentence_transformers/base/model.py:1526

Methodfit

Deprecated training method from before Sentence Transformers v3.0, it is recommended to use :class:`~sentence_transformers.sentence_t

sentence_transformers/sentence_transformer/fit_mixin.py:160

Methodflatten_ready_transformer

A BERT transformer with can_flatten_inputs=True and a mock data_collator.

tests/base/modules/test_transformer.py:2042

Methodformat_config_value

(value: Any)

sentence_transformers/base/model_card.py:1217

Methodforward

(self, features: dict[str, torch.Tensor])

sentence_transformers/sentence_transformer/modules/cnn.py:53

Methodforward

(self, features: dict[str, Tensor])

sentence_transformers/sentence_transformer/modules/bow.py:60

Methodforward

(self, features: dict[str, Tensor])

sentence_transformers/sentence_transformer/modules/dropout.py:22

Methodforward

(self, features: dict[str, Tensor])

sentence_transformers/sentence_transformer/modules/weighted_layer_pooling.py:33

Methodforward

(self, features, **kwargs)

sentence_transformers/sentence_transformer/modules/word_embeddings.py:59

Methodforward

(self, features: dict[str, torch.Tensor], **kwargs)

sentence_transformers/sentence_transformer/modules/static_embedding.py:121

Methodforward

(self, features: dict[str, Tensor | Any], **kwargs)

sentence_transformers/sentence_transformer/modules/pooling.py:121

Methodforward

(self, features: dict[str, Tensor])

sentence_transformers/sentence_transformer/modules/layer_norm.py:21

Methodforward

(self, features: dict[str, Tensor])

sentence_transformers/sentence_transformer/modules/word_weights.py:53

Methodforward

(self, features: dict[str, torch.Tensor])

sentence_transformers/sentence_transformer/modules/lstm.py:51

Methodforward

(self, sentence_features: Iterable[dict[str, Tensor]], labels: Tensor)

sentence_transformers/sentence_transformer/losses/cached_gist_embed.py:366

Methodforward

(self, sentence_features: Iterable[dict[str, Tensor]], labels: Tensor)

sentence_transformers/sentence_transformer/losses/adaptive_layer.py:213

Methodforward

(self, sentence_features: Iterable[dict[str, Tensor]], labels: Tensor)

sentence_transformers/sentence_transformer/losses/denoising_auto_encoder.py:186

Methodforward

(self, sentence_features: Iterable[dict[str, Tensor]], labels: Tensor)

sentence_transformers/sentence_transformer/losses/matryoshka.py:226

Methodforward

(self, sentence_features: Iterable[dict[str, Tensor]], labels: Tensor | None)

sentence_transformers/sentence_transformer/losses/embed_distill.py:166

Methodforward

(self, sentence_features: Iterable[dict[str, Tensor]], labels: Tensor)

sentence_transformers/sentence_transformer/losses/batch_semi_hard_triplet.py:103

← previous next →1,401–1,500 of 3,759, ranked by callers