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
get_config_dict
(self)
sentence_transformers/sparse_encoder/losses/cached_splade.py:207
Method
get_config_dict
Get the configuration dictionary. Returns: Dictionary containing the configuration parameters
sentence_transformers/sparse_encoder/losses/splade.py:168
Method
get_config_dict
Get the configuration dictionary. Returns: Dictionary containing the configuration parameters
sentence_transformers/sparse_encoder/losses/csr.py:129
Method
get_config_dict
(self)
sentence_transformers/sparse_encoder/evaluation/sparse_information_retrieval.py:298
Method
get_config_dict
(self)
sentence_transformers/sparse_encoder/evaluation/sparse_binary_classification.py:187
Method
get_config_dict
(self)
sentence_transformers/sparse_encoder/evaluation/sparse_reranking.py:199
Method
get_config_dict
(self)
sentence_transformers/sparse_encoder/evaluation/sparse_translation.py:153
Method
get_config_dict
(self)
sentence_transformers/sparse_encoder/evaluation/sparse_triplet.py:195
Method
get_config_dict
(self)
sentence_transformers/sparse_encoder/evaluation/reciprocal_rank_fusion.py:337
Method
get_config_dict
(self)
sentence_transformers/sparse_encoder/evaluation/sparse_embedding_similarity.py:165
Method
get_config_dict
(self)
sentence_transformers/sparse_encoder/evaluation/sparse_mse.py:166
Method
get_config_dict
(self)
sentence_transformers/sparse_encoder/evaluation/sparse_nano_beir.py:328
Method
get_config_dict
Return a dictionary with all meaningful configuration values of the evaluator to store in the model card.
sentence_transformers/base/evaluation/evaluator.py:93
Method
get_default_loss
(self, model: SentenceTransformer)
sentence_transformers/sentence_transformer/trainer.py:163
Method
get_default_loss
(self, model: MultiVectorEncoder)
sentence_transformers/multi_vector_encoder/trainer.py:112
Method
get_default_loss
(self, model: CrossEncoder)
sentence_transformers/cross_encoder/trainer.py:172
Method
get_default_loss
(self, model: SparseEncoder)
sentence_transformers/sparse_encoder/trainer.py:159
Method
get_default_model_name
(self)
sentence_transformers/sparse_encoder/model_card.py:153
Method
get_device_name
Select the default device, using CPU when Neuron or HPU is detected.
sentence_transformers/sparse_encoder/model.py:216
Method
get_embedding_dimension
(self)
sentence_transformers/sentence_transformer/modules/weighted_layer_pooling.py:47
Method
get_embedding_dimension
(self)
sentence_transformers/sentence_transformer/modules/word_embeddings.py:93
Method
get_embedding_dimension
(self)
sentence_transformers/sentence_transformer/modules/static_embedding.py:130
Method
get_embedding_dimension
(self)
sentence_transformers/sentence_transformer/modules/layer_norm.py:25
Method
get_embedding_dimension
(self)
sentence_transformers/sentence_transformer/modules/lstm.py:67
Method
get_embedding_dimension
(self)
sentence_transformers/sparse_encoder/modules/sparse_static_embedding.py:231
Method
get_embedding_dimension
Get the dimension of the embedding. Warning: the number of non-zero elements in the embedding is only k out of the hidden_dim. Retur
sentence_transformers/sparse_encoder/modules/sparse_auto_encoder.py:252
Method
get_embedding_dimension
Get the dimension of the embedding. Returns: int: Dimension of the embedding
sentence_transformers/sparse_encoder/modules/splade_pooling.py:170
Method
get_embedding_dimension
(self)
tests/util/test_hard_negatives.py:1912
Method
get_examples
data_splits specified which data split to use (train, dev, test). Expects that self.dataset_folder contains the files s1.$data_split.
sentence_transformers/sentence_transformer/readers/nli_data.py:25
Method
get_examples
(self, filename, max_examples=0)
sentence_transformers/sentence_transformer/readers/triplet.py:42
Method
get_examples
filename specified which data split to use (train.csv, dev.csv, test.csv).
sentence_transformers/sentence_transformer/readers/sts_data.py:48
Method
get_examples
(self, max_examples=0)
sentence_transformers/sentence_transformer/readers/paired_files.py:24
Method
get_examples
(self, filename, max_examples=0)
sentence_transformers/sentence_transformer/readers/label_sentence.py:31
Function
get_frames_at
(self, indices)
tests/base/modules/transformer/conftest.py:221
Method
get_frames_at
(self, indices)
tests/base/test_model_card.py:1178
Method
get_hidden_size_from_config
(config)
sentence_transformers/base/modules/transformer.py:1744
Method
get_model_specific_metadata
(self)
sentence_transformers/sentence_transformer/model_card.py:129
Method
get_model_specific_metadata
(self)
sentence_transformers/multi_vector_encoder/model_card.py:88
Method
get_model_specific_metadata
(self)
sentence_transformers/cross_encoder/model_card.py:269
Method
get_model_specific_metadata
(self)
sentence_transformers/sparse_encoder/model_card.py:118
Method
get_num_labels
(self)
sentence_transformers/sentence_transformer/readers/nli_data.py:53
Method
get_optimizer_cls_and_kwargs
We have to override the optimizer_grouped_parameters because the Trainer superclass bases it on the `model` itself, but the BaseModel
sentence_transformers/base/trainer.py:1255
Function
get_sample_audio
Generate sample audio data in multiple formats. Returns: Dict with format names as keys: - 'url': List of audio URLs (16kHz)
tests/base/modules/transformer/conftest.py:296
Function
get_sample_images
Generate sample image data in multiple formats. Returns: Dict with format names as keys: - 'url': List of image URLs - 't
tests/base/modules/transformer/conftest.py:249
Method
get_sample_values
(index: int)
sentence_transformers/base/sampler.py:557
Function
get_sample_video
Generate sample video data in multiple formats. Returns: Dict with format names as keys: - 'url': List of video URLs - 'p
tests/base/modules/transformer/conftest.py:350
Method
get_sentence_embedding_dimension
(self)
sentence_transformers/sparse_encoder/model.py:1005
Method
get_sentence_features
(self, *features)
sentence_transformers/sentence_transformer/model.py:1159
Method
get_test_dataloader
Returns the test [`~torch.utils.data.DataLoader`]. Subclass and override this method if you want to inject some custom behavior.
sentence_transformers/base/trainer.py:997
Method
get_triplet_mask
Return a 3D mask where mask[a, p, n] is True iff the triplet (a, p, n) is valid. A triplet (i, j, k) is valid if: - i, j, k are di
sentence_transformers/sentence_transformer/losses/batch_hard_triplet.py:215
Function
get_versions
()
sentence_transformers/base/model_card.py:278
Method
get_vocab
(self, vocab: Iterable[str])
sentence_transformers/sentence_transformer/modules/tokenizer/word.py:433
Method
get_vocab
(self)
sentence_transformers/sentence_transformer/modules/tokenizer/phrase.py:41
Method
get_vocab
(self)
sentence_transformers/sentence_transformer/modules/tokenizer/whitespace.py:25
Method
halve
(emb: Tensor)
tests/multi_vector_encoder/modules/test_token_pooling.py:283
Function
halving
(layer_idx: int)
tests/sentence_transformer/losses/test_adaptive_layer.py:261
Method
hardness_mode
(self)
sentence_transformers/sentence_transformer/losses/cached_multiple_negatives_ranking.py:237
Method
hardness_strength
(self)
sentence_transformers/sentence_transformer/losses/cached_multiple_negatives_ranking.py:241
Function
hpo_compute_objective
Valid keys are: 'eval_loss', 'eval_sts-dev_pearson_cosine', 'eval_sts-dev_spearman_cosine', 'eval_sts-dev_pearson_manhattan', 'eval_sts-dev_s
examples/sentence_transformer/training/hpo/hpo_nli.py:44
Function
hpo_loss_init
(model)
examples/sentence_transformer/training/hpo/hpo_nli.py:39
Function
hpo_model_init
(trial)
examples/sentence_transformer/training/hpo/hpo_nli.py:34
Function
hpo_search_space
(trial)
examples/sentence_transformer/training/hpo/hpo_nli.py:24
Function
id_to_text
(batch)
skills/train-sentence-transformers/scripts/train_sparse_encoder_distillation_example.py:125
Function
id_to_text
(batch)
skills/train-sentence-transformers/scripts/train_cross_encoder_distillation_example.py:128
Function
id_to_text_map
(batch)
examples/sentence_transformer/training/ms_marco/train_bi_encoder_margin_mse.py:81
Function
id_to_text_map
(batch)
examples/cross_encoder/training/distillation/train_cross_encoder_kd_margin_mse.py:44
Function
id_to_text_map
(batch)
examples/cross_encoder/training/distillation/train_cross_encoder_kd_mse.py:44
Function
id_to_text_map
(batch)
examples/cross_encoder/training/ms_marco/training_ms_marco_bce_preprocessed.py:47
Function
id_to_text_map
(batch)
examples/sparse_encoder/training/distillation/train_splade_msmarco_margin_mse.py:62
Function
id_to_text_map
(batch)
examples/sparse_encoder/training/ms_marco/train_splade_msmarco_mnrl.py:63
Method
identity
(batch)
sentence_transformers/sentence_transformer/fit_mixin.py:249
Method
identity
(batch)
sentence_transformers/cross_encoder/fit_mixin.py:255
Function
ids_to_text_transform
(batch)
examples/sentence_transformer/training/ms_marco/train_bi_encoder_margin_mse_mnrl.py:152
Function
ids_to_text_transform
(batch)
examples/sentence_transformer/training/ms_marco/train_bi_encoder_mnrl.py:147
Function
ids_to_text_transform
(batch)
examples/cross_encoder/training/ms_marco/training_ms_marco_adrmse.py:49
Function
imbalanced_dataset
140 samples: label 0 has 90, label 1 has 30, label 2 has 20.
tests/base/samplers/test_group_by_label_batch_sampler.py:30
Function
inference_device
Run each dependent test once per listed device, skipping unavailable accelerators.
tests/conftest.py:130
Function
inference_free_splade_bert_tiny_model
(_inference_free_splade_bert_tiny_model: SparseEncoder)
tests/conftest.py:255
Function
information_retrieval
This function is deprecated. Use semantic_search instead
sentence_transformers/util/retrieval.py:169
Function
inherit_class_docstrings
Inherit parent class docstrings for classes that don't define their own. ``autodoc_inherit_docstrings`` only applies to methods, not classes.
docs/conf.py:324
Function
install_logger
Configures the given logger: format, logging level, style, etc
sentence_transformers/util/logging.py:23
Function
is_sentence_transformer_model
Checks if the given model name or path corresponds to a SentenceTransformer model. Args: model_name_or_path (str): The name or path
sentence_transformers/util/file_io.py:113
Function
it_to_text_transform
(batch)
examples/cross_encoder/training/ms_marco/training_ms_marco_lambda_preprocessed.py:48
Method
join_list
(losses: list[str])
sentence_transformers/base/model_card.py:509
Function
kd_dataset
()
tests/multi_vector_encoder/test_trainer.py:45
Function
linkcode_resolve
(domain, info)
docs/conf.py:147
Method
load
Deprecated: Use SentenceTransformer(input_path) instead.
sentence_transformers/sentence_transformer/model.py:1240
Method
load
( cls, model_name_or_path: str, subfolder: str = "", token: bool | str | None
sentence_transformers/sentence_transformer/modules/cnn.py:72
Method
load
( cls, model_name_or_path: str, subfolder: str = "", token: bool | str | None
sentence_transformers/sentence_transformer/modules/weighted_layer_pooling.py:55
Method
load
( cls, model_name_or_path: str, subfolder: str = "", token: bool | str | None
sentence_transformers/sentence_transformer/modules/word_embeddings.py:109
Method
load
( cls, model_name_or_path: str, subfolder: str = "", token: bool | str | None
sentence_transformers/sentence_transformer/modules/static_embedding.py:141
Method
load
(cls, model_name_or_path: str, **kwargs)
sentence_transformers/sentence_transformer/modules/clip_model.py:31
Method
load
( cls, model_name_or_path: str, subfolder: str = "", token: bool | str | None
sentence_transformers/sentence_transformer/modules/layer_norm.py:33
Method
load
( cls, model_name_or_path: str, subfolder: str = "", token: bool | str | None
sentence_transformers/sentence_transformer/modules/lstm.py:81
Method
load
(input_path: str)
sentence_transformers/sentence_transformer/modules/tokenizer/word.py:417
Method
load
(input_path: str)
sentence_transformers/sentence_transformer/modules/tokenizer/word.py:440
Method
load
(input_path: str)
sentence_transformers/sentence_transformer/modules/tokenizer/phrase.py:118
Method
load
(input_path: str)
sentence_transformers/sentence_transformer/modules/tokenizer/whitespace.py:74
Method
load
(cls, model_name_or_path: str, **kwargs)
sentence_transformers/sparse_encoder/modules/mlm_transformer.py:35
Method
load
( cls, model_name_or_path: str, subfolder: str = "", token: bool | str | None
sentence_transformers/sparse_encoder/modules/sparse_auto_encoder.py:227
← previous
next →
1,901–2,000 of 4,575, ranked by callers