Index

A

active_adapters() (sentence_transformers.SentenceTransformer method) AdaptiveLayerLoss (class in sentence_transformers.losses) add_adapter() (sentence_transformers.SentenceTransformer method) add_callback() (sentence_transformers.trainer.SentenceTransformerTrainer method)

add_model_card_callback() (sentence_transformers.trainer.SentenceTransformerTrainer method) add_prompts_or_dataset_name_transform() (sentence_transformers.trainer.SentenceTransformerTrainer static method) AnglELoss (class in sentence_transformers.losses) Asym (class in sentence_transformers.models)

B

BatchAllTripletLoss (class in sentence_transformers.losses) BatchHardSoftMarginTripletLoss (class in sentence_transformers.losses) BatchHardTripletLoss (class in sentence_transformers.losses) BatchSamplers (class in sentence_transformers.training_args)

BatchSemiHardTripletLoss (class in sentence_transformers.losses) bfloat16() (sentence_transformers.SentenceTransformer method) BinaryClassificationEvaluator (class in sentence_transformers.evaluation) BoW (class in sentence_transformers.models)

C

CachedGISTEmbedLoss (class in sentence_transformers.losses) CachedMultipleNegativesRankingLoss (class in sentence_transformers.losses) CachedMultipleNegativesSymmetricRankingLoss (class in sentence_transformers.losses) CEBinaryAccuracyEvaluator (class in sentence_transformers.cross_encoder.evaluation) CEBinaryClassificationEvaluator (class in sentence_transformers.cross_encoder.evaluation) CECorrelationEvaluator (class in sentence_transformers.cross_encoder.evaluation) CEF1Evaluator (class in sentence_transformers.cross_encoder.evaluation) CERerankingEvaluator (class in sentence_transformers.cross_encoder.evaluation) CESoftmaxAccuracyEvaluator (class in sentence_transformers.cross_encoder.evaluation) CNN (class in sentence_transformers.models) community_detection() (in module sentence_transformers.util) compile() (sentence_transformers.SentenceTransformer method) compute_loss() (sentence_transformers.trainer.SentenceTransformerTrainer method)

ContrastiveLoss (class in sentence_transformers.losses) ContrastiveTensionLoss (class in sentence_transformers.losses) ContrastiveTensionLossInBatchNegatives (class in sentence_transformers.losses) cos_sim() (in module sentence_transformers.util) CoSENTLoss (class in sentence_transformers.losses) CosineSimilarityLoss (class in sentence_transformers.losses) cpu() (sentence_transformers.SentenceTransformer method) create_model_card() (sentence_transformers.trainer.SentenceTransformerTrainer method) create_optimizer() (sentence_transformers.trainer.SentenceTransformerTrainer method) create_optimizer_and_scheduler() (sentence_transformers.trainer.SentenceTransformerTrainer method) create_scheduler() (sentence_transformers.trainer.SentenceTransformerTrainer method) CrossEncoder (class in sentence_transformers.cross_encoder) cuda() (sentence_transformers.SentenceTransformer method)

D

ddp_timeout_delta (sentence_transformers.training_args.SentenceTransformerTrainingArguments property) DefaultBatchSampler (class in sentence_transformers.sampler) DenoisingAutoEncoderDataset (class in sentence_transformers.datasets) DenoisingAutoEncoderLoss (class in sentence_transformers.losses) Dense (class in sentence_transformers.models)

device (sentence_transformers.SentenceTransformer property) (sentence_transformers.training_args.SentenceTransformerTrainingArguments property) disable_adapters() (sentence_transformers.SentenceTransformer method) dot_score() (in module sentence_transformers.util) double() (sentence_transformers.SentenceTransformer method)

E

EmbeddingSimilarityEvaluator (class in sentence_transformers.evaluation) enable_adapters() (sentence_transformers.SentenceTransformer method) encode() (sentence_transformers.SentenceTransformer method) encode_multi_process() (sentence_transformers.SentenceTransformer method) euclidean_sim() (in module sentence_transformers.util) eval() (sentence_transformers.SentenceTransformer method)

eval_batch_size (sentence_transformers.training_args.SentenceTransformerTrainingArguments property) evaluate() (sentence_transformers.SentenceTransformer method) (sentence_transformers.trainer.SentenceTransformerTrainer method) export_dynamic_quantized_onnx_model() (in module sentence_transformers.backend) export_optimized_onnx_model() (in module sentence_transformers.backend) export_static_quantized_openvino_model() (in module sentence_transformers.backend)

F

fit() (sentence_transformers.cross_encoder.CrossEncoder method) (sentence_transformers.SentenceTransformer method)

float() (sentence_transformers.SentenceTransformer method) from_distillation() (sentence_transformers.models.StaticEmbedding class method) from_model2vec() (sentence_transformers.models.StaticEmbedding class method)

G

get_adapter_state_dict() (sentence_transformers.SentenceTransformer method) get_backend() (sentence_transformers.SentenceTransformer method) get_batch_sampler() (sentence_transformers.trainer.SentenceTransformerTrainer method) get_eval_dataloader() (sentence_transformers.trainer.SentenceTransformerTrainer method) get_learning_rates() (sentence_transformers.trainer.SentenceTransformerTrainer method) get_max_seq_length() (sentence_transformers.SentenceTransformer method) get_multi_dataset_batch_sampler() (sentence_transformers.trainer.SentenceTransformerTrainer method) get_num_trainable_parameters() (sentence_transformers.trainer.SentenceTransformerTrainer method)

get_optimizer_group() (sentence_transformers.trainer.SentenceTransformerTrainer method) get_process_log_level() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) get_sentence_embedding_dimension() (sentence_transformers.SentenceTransformer method) get_test_dataloader() (sentence_transformers.trainer.SentenceTransformerTrainer method) get_train_dataloader() (sentence_transformers.trainer.SentenceTransformerTrainer method) get_warmup_steps() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) GISTEmbedLoss (class in sentence_transformers.losses) GroupByLabelBatchSampler (class in sentence_transformers.sampler)

H

half() (sentence_transformers.SentenceTransformer method)

http_get() (in module sentence_transformers.util) hyperparameter_search() (sentence_transformers.trainer.SentenceTransformerTrainer method)

I

InformationRetrievalEvaluator (class in sentence_transformers.evaluation) InputExample (class in sentence_transformers.readers)

is_local_process_zero() (sentence_transformers.trainer.SentenceTransformerTrainer method) is_training_available() (in module sentence_transformers.util) is_world_process_zero() (sentence_transformers.trainer.SentenceTransformerTrainer method)

L

load_adapter() (sentence_transformers.SentenceTransformer method) local_process_index (sentence_transformers.training_args.SentenceTransformerTrainingArguments property)

log() (sentence_transformers.trainer.SentenceTransformerTrainer method) LSTM (class in sentence_transformers.models)

M

main_process_first() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) manhattan_sim() (in module sentence_transformers.util) MarginMSELoss (class in sentence_transformers.losses) Matryoshka2dLoss (class in sentence_transformers.losses) MatryoshkaLoss (class in sentence_transformers.losses) max_seq_length (sentence_transformers.SentenceTransformer property) maybe_add_prompts_or_dataset_name_column() (sentence_transformers.trainer.SentenceTransformerTrainer method) MegaBatchMarginLoss (class in sentence_transformers.losses) mine_hard_negatives() (in module sentence_transformers.util)

module sentence_transformers.backend sentence_transformers.quantization sentence_transformers.util, [1] MSEEvaluator (class in sentence_transformers.evaluation) MSELoss (class in sentence_transformers.losses) MultiDatasetBatchSamplers (class in sentence_transformers.training_args) MultipleNegativesRankingLoss (class in sentence_transformers.losses) MultipleNegativesSymmetricRankingLoss (class in sentence_transformers.losses)

N

n_gpu (sentence_transformers.training_args.SentenceTransformerTrainingArguments property) NanoBEIREvaluator (class in sentence_transformers.evaluation) NoDuplicatesBatchSampler (class in sentence_transformers.sampler)

NoDuplicatesDataLoader (class in sentence_transformers.datasets) Normalize (class in sentence_transformers.models) normalize_embeddings() (in module sentence_transformers.util)

O

old_fit() (sentence_transformers.SentenceTransformer method)

OnlineContrastiveLoss (class in sentence_transformers.losses)

P

pairwise_cos_sim() (in module sentence_transformers.util) pairwise_dot_score() (in module sentence_transformers.util) pairwise_euclidean_sim() (in module sentence_transformers.util) pairwise_manhattan_sim() (in module sentence_transformers.util) parallel_mode (sentence_transformers.training_args.SentenceTransformerTrainingArguments property) ParallelSentencesDataset (class in sentence_transformers.datasets) paraphrase_mining() (in module sentence_transformers.util), [1] ParaphraseMiningEvaluator (class in sentence_transformers.evaluation) place_model_on_device (sentence_transformers.training_args.SentenceTransformerTrainingArguments property)

Pooling (class in sentence_transformers.models) pop_callback() (sentence_transformers.trainer.SentenceTransformerTrainer method) possible_values() (sentence_transformers.SimilarityFunction static method) predict() (sentence_transformers.cross_encoder.CrossEncoder method) process_index (sentence_transformers.training_args.SentenceTransformerTrainingArguments property) propagate_args_to_deepspeed() (sentence_transformers.trainer.SentenceTransformerTrainer method) ProportionalBatchSampler (class in sentence_transformers.sampler) push_to_hub() (sentence_transformers.cross_encoder.CrossEncoder method) (sentence_transformers.SentenceTransformer method) (sentence_transformers.trainer.SentenceTransformerTrainer method)

Q

quantize_embeddings() (in module sentence_transformers.quantization)

R

rank() (sentence_transformers.cross_encoder.CrossEncoder method) remove_callback() (sentence_transformers.trainer.SentenceTransformerTrainer method)

RerankingEvaluator (class in sentence_transformers.evaluation) RoundRobinBatchSampler (class in sentence_transformers.sampler)

S

save() (sentence_transformers.cross_encoder.CrossEncoder method) (sentence_transformers.SentenceTransformer method) save_model() (sentence_transformers.trainer.SentenceTransformerTrainer method) save_pretrained() (sentence_transformers.cross_encoder.CrossEncoder method) (sentence_transformers.SentenceTransformer method) semantic_search() (in module sentence_transformers.util), [1] semantic_search_faiss() (in module sentence_transformers.quantization) semantic_search_usearch() (in module sentence_transformers.quantization) sentence_transformers.backend module sentence_transformers.quantization module sentence_transformers.util module, [1] SentenceEvaluator (class in sentence_transformers.evaluation) SentenceLabelDataset (class in sentence_transformers.datasets) SentenceTransformer (class in sentence_transformers) SentenceTransformerModelCardData (class in sentence_transformers.model_card) SentenceTransformerTrainer (class in sentence_transformers.trainer) SentenceTransformerTrainingArguments (class in sentence_transformers.training_args) SequentialEvaluator (class in sentence_transformers.evaluation)

set_adapter() (sentence_transformers.SentenceTransformer method) set_dataloader() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) set_evaluate() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) set_logging() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) set_lr_scheduler() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) set_optimizer() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) set_pooling_include_prompt() (sentence_transformers.SentenceTransformer method) set_push_to_hub() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) set_save() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) set_testing() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) set_training() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) should_log (sentence_transformers.training_args.SentenceTransformerTrainingArguments property) should_save (sentence_transformers.training_args.SentenceTransformerTrainingArguments property) similarity (sentence_transformers.SentenceTransformer property) similarity_fn_name (sentence_transformers.SentenceTransformer property) similarity_pairwise (sentence_transformers.SentenceTransformer property) SimilarityFunction (class in sentence_transformers) smart_batching_collate() (sentence_transformers.SentenceTransformer method) SoftmaxLoss (class in sentence_transformers.losses) start_multi_process_pool() (sentence_transformers.SentenceTransformer method) StaticEmbedding (class in sentence_transformers.models) stop_multi_process_pool() (sentence_transformers.SentenceTransformer static method)

T

to() (sentence_transformers.SentenceTransformer method) to_dict() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) to_json_string() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) to_sanitized_dict() (sentence_transformers.training_args.SentenceTransformerTrainingArguments method) to_similarity_fn() (sentence_transformers.SimilarityFunction static method) to_similarity_pairwise_fn() (sentence_transformers.SimilarityFunction static method) tokenize() (sentence_transformers.SentenceTransformer method) tokenizer (sentence_transformers.SentenceTransformer property)

train() (sentence_transformers.SentenceTransformer method) (sentence_transformers.trainer.SentenceTransformerTrainer method) train_batch_size (sentence_transformers.training_args.SentenceTransformerTrainingArguments property) Transformer (class in sentence_transformers.models) TranslationEvaluator (class in sentence_transformers.evaluation) TripletEvaluator (class in sentence_transformers.evaluation) TripletLoss (class in sentence_transformers.losses) truncate_embeddings() (in module sentence_transformers.util) truncate_sentence_embeddings() (sentence_transformers.SentenceTransformer method)

W

WeightedLayerPooling (class in sentence_transformers.models) WordEmbeddings (class in sentence_transformers.models)

WordWeights (class in sentence_transformers.models) world_size (sentence_transformers.training_args.SentenceTransformerTrainingArguments property)