Sparse Encoder

• SparseEncoder
  • SparseEncoder
    • SparseEncoder
      • SparseEncoder.active_adapters()
      • SparseEncoder.add_adapter()
      • SparseEncoder.bfloat16()
      • SparseEncoder.compile()
      • SparseEncoder.config
      • SparseEncoder.cpu()
      • SparseEncoder.cuda()
      • SparseEncoder.decode()
      • SparseEncoder.delete_adapter()
      • SparseEncoder.device
      • SparseEncoder.disable_adapters()
      • SparseEncoder.double()
      • SparseEncoder.dtype
      • SparseEncoder.enable_adapters()
      • SparseEncoder.encode()
      • SparseEncoder.encode_document()
      • SparseEncoder.encode_query()
      • SparseEncoder.eval()
      • SparseEncoder.evaluate()
      • SparseEncoder.extend()
      • SparseEncoder.float()
      • SparseEncoder.get_adapter_state_dict()
      • SparseEncoder.get_backend()
      • SparseEncoder.get_embedding_dimension()
      • SparseEncoder.get_max_seq_length()
      • SparseEncoder.get_model_kwargs()
      • SparseEncoder.gradient_checkpointing_enable()
      • SparseEncoder.half()
      • SparseEncoder.insert()
      • SparseEncoder.intersection()
      • SparseEncoder.is_singular_input()
      • SparseEncoder.load_adapter()
      • SparseEncoder.max_seq_length
      • SparseEncoder.modalities
      • SparseEncoder.model_card_data_class
      • SparseEncoder.mtia()
      • SparseEncoder.pop()
      • SparseEncoder.preprocess()
      • SparseEncoder.processor
      • SparseEncoder.push_to_hub()
      • SparseEncoder.register_load_state_dict_pre_hook()
      • SparseEncoder.register_state_dict_post_hook()
      • SparseEncoder.save_pretrained()
      • SparseEncoder.set_adapter()
      • SparseEncoder.set_pooling_include_prompt()
      • SparseEncoder.set_submodule()
      • SparseEncoder.similarity()
      • SparseEncoder.similarity_fn_name
      • SparseEncoder.similarity_pairwise()
      • SparseEncoder.sparsity()
      • SparseEncoder.splade_pooling_chunk_size
      • SparseEncoder.start_multi_process_pool()
      • SparseEncoder.stop_multi_process_pool()
      • SparseEncoder.supports()
      • SparseEncoder.to()
      • SparseEncoder.tokenize()
      • SparseEncoder.tokenizer
      • SparseEncoder.train()
      • SparseEncoder.transformers_model
  • SparseEncoderModelCardData
    • SparseEncoderModelCardData
      • SparseEncoderModelCardData.pipeline_tag
      • SparseEncoderModelCardData.task_name
• Trainer
  • SparseEncoderTrainer
    • SparseEncoderTrainer
      • SparseEncoderTrainer.add_callback()
      • SparseEncoderTrainer.add_dataset_name_transform()
      • SparseEncoderTrainer.add_model_card_callback()
      • SparseEncoderTrainer.call_model_init()
      • SparseEncoderTrainer.compute_loss()
      • SparseEncoderTrainer.create_accelerator_and_postprocess()
      • SparseEncoderTrainer.create_model_card()
      • SparseEncoderTrainer.create_optimizer()
      • SparseEncoderTrainer.create_optimizer_and_scheduler()
      • SparseEncoderTrainer.create_scheduler()
      • SparseEncoderTrainer.data_collator_class
      • SparseEncoderTrainer.evaluate()
      • SparseEncoderTrainer.get_batch_sampler()
      • SparseEncoderTrainer.get_batch_samples()
      • SparseEncoderTrainer.get_cp_size()
      • SparseEncoderTrainer.get_data_collator()
      • SparseEncoderTrainer.get_eval_dataloader()
      • SparseEncoderTrainer.get_learning_rates()
      • SparseEncoderTrainer.get_multi_dataset_batch_sampler()
      • SparseEncoderTrainer.get_num_trainable_parameters()
      • SparseEncoderTrainer.get_optimizer_group()
      • SparseEncoderTrainer.get_sp_size()
      • SparseEncoderTrainer.get_test_dataloader()
      • SparseEncoderTrainer.get_total_train_batch_size()
      • SparseEncoderTrainer.get_tp_size()
      • SparseEncoderTrainer.get_train_dataloader()
      • SparseEncoderTrainer.hyperparameter_search()
      • SparseEncoderTrainer.is_local_process_zero()
      • SparseEncoderTrainer.is_world_process_zero()
      • SparseEncoderTrainer.log()
      • SparseEncoderTrainer.model_card_callback_class
      • SparseEncoderTrainer.model_card_data_class
      • SparseEncoderTrainer.model_class
      • SparseEncoderTrainer.pop_callback()
      • SparseEncoderTrainer.preprocess_dataset()
      • SparseEncoderTrainer.push_to_hub()
      • SparseEncoderTrainer.remove_callback()
      • SparseEncoderTrainer.save_model()
      • SparseEncoderTrainer.set_initial_training_values()
      • SparseEncoderTrainer.should_dataset_name_column_be_added()
      • SparseEncoderTrainer.store_flos()
      • SparseEncoderTrainer.train()
      • SparseEncoderTrainer.training_args_class
• Training Arguments
  • SparseEncoderTrainingArguments
    • SparseEncoderTrainingArguments
      • SparseEncoderTrainingArguments.ddp_timeout_delta
      • SparseEncoderTrainingArguments.device
      • SparseEncoderTrainingArguments.eval_batch_size
      • SparseEncoderTrainingArguments.get_process_log_level()
      • SparseEncoderTrainingArguments.get_warmup_steps()
      • SparseEncoderTrainingArguments.local_process_index
      • SparseEncoderTrainingArguments.main_process_first()
      • SparseEncoderTrainingArguments.n_gpu
      • SparseEncoderTrainingArguments.parallel_mode
      • SparseEncoderTrainingArguments.place_model_on_device
      • SparseEncoderTrainingArguments.process_index
      • SparseEncoderTrainingArguments.set_dataloader()
      • SparseEncoderTrainingArguments.set_evaluate()
      • SparseEncoderTrainingArguments.set_logging()
      • SparseEncoderTrainingArguments.set_lr_scheduler()
      • SparseEncoderTrainingArguments.set_optimizer()
      • SparseEncoderTrainingArguments.set_push_to_hub()
      • SparseEncoderTrainingArguments.set_save()
      • SparseEncoderTrainingArguments.set_testing()
      • SparseEncoderTrainingArguments.set_training()
      • SparseEncoderTrainingArguments.should_log
      • SparseEncoderTrainingArguments.should_save
      • SparseEncoderTrainingArguments.to_dict()
      • SparseEncoderTrainingArguments.to_json_string()
      • SparseEncoderTrainingArguments.to_sanitized_dict()
      • SparseEncoderTrainingArguments.train_batch_size
      • SparseEncoderTrainingArguments.world_size
• Losses
  • SpladeLoss
    • SpladeLoss
  • CachedSpladeLoss
    • CachedSpladeLoss
  • FlopsLoss
    • FlopsLoss
  • CSRLoss
    • CSRLoss
  • CSRReconstructionLoss
    • CSRReconstructionLoss
  • SparseMultipleNegativesRankingLoss
    • SparseMultipleNegativesRankingLoss
  • SparseMarginMSELoss
    • SparseMarginMSELoss
  • SparseDistillKLDivLoss
    • SparseDistillKLDivLoss
  • SparseTripletLoss
    • SparseTripletLoss
  • SparseCosineSimilarityLoss
    • SparseCosineSimilarityLoss
  • SparseCoSENTLoss
    • SparseCoSENTLoss
  • SparseAnglELoss
    • SparseAnglELoss
  • SparseMSELoss
    • SparseMSELoss
• Samplers
  • BatchSamplers
    • BatchSamplers
    • DefaultBatchSampler
    • NoDuplicatesBatchSampler
    • GroupByLabelBatchSampler
  • MultiDatasetBatchSamplers
    • MultiDatasetBatchSamplers
    • MultiDatasetDefaultBatchSampler
    • RoundRobinBatchSampler
    • ProportionalBatchSampler
• Evaluation
  • SparseInformationRetrievalEvaluator
    • SparseInformationRetrievalEvaluator
  • SparseNanoBEIREvaluator
    • SparseNanoBEIREvaluator
  • SparseEmbeddingSimilarityEvaluator
    • SparseEmbeddingSimilarityEvaluator
  • SparseBinaryClassificationEvaluator
    • SparseBinaryClassificationEvaluator
  • SparseTripletEvaluator
    • SparseTripletEvaluator
  • SparseRerankingEvaluator
    • SparseRerankingEvaluator
  • SparseTranslationEvaluator
    • SparseTranslationEvaluator
  • SparseMSEEvaluator
    • SparseMSEEvaluator
  • ReciprocalRankFusionEvaluator
    • ReciprocalRankFusionEvaluator
• Modules
  • SPLADE Pooling
    • SpladePooling
  • SparseAutoEncoder
    • SparseAutoEncoder
  • SparseStaticEmbedding
    • SparseStaticEmbedding
• Callbacks
  • SpladeRegularizerWeightSchedulerCallback
    • SpladeRegularizerWeightSchedulerCallback
• Search Engines
  • semantic_search_elasticsearch()
  • semantic_search_opensearch()
  • semantic_search_qdrant()
  • semantic_search_seismic()