Abstract Class

• Inference
  • AbsEmbedder
    • AbsEmbedder
    • Methods
      • AbsEmbedder.get_target_devices()
      • AbsEmbedder.get_detailed_instruct()
      • AbsEmbedder.encode_queries()
      • AbsEmbedder.encode_corpus()
      • AbsEmbedder.encode()
      • AbsEmbedder.encode_single_device()
      • AbsEmbedder.start_multi_process_pool()
      • AbsEmbedder._encode_multi_process_worker()
      • AbsEmbedder.stop_multi_process_pool()
      • AbsEmbedder.encode_multi_process()
      • AbsEmbedder._concatenate_results_from_multi_process()
  • AbsReranker
    • AbsReranker
    • Methods
      • AbsReranker.get_target_devices()
      • AbsReranker.get_detailed_instruct()
      • AbsReranker.get_detailed_inputs()
      • AbsReranker.compute_score()
      • AbsReranker.compute_score_single_gpu()
      • AbsReranker.start_multi_process_pool()
      • AbsReranker.encode_multi_process()
      • AbsReranker._encode_multi_process_worker()
      • AbsReranker.stop_multi_process_pool()
• Evaluation
  • Arguments
    • AbsEvalArgs
    • AbsEvalModelArgs
  • dataset loader
    • AbsEvalDataLoader
    • Methods
      • AbsEvalDataLoader.available_dataset_names()
      • AbsEvalDataLoader.available_splits()
      • AbsEvalDataLoader.check_dataset_names()
      • AbsEvalDataLoader.check_splits()
      • AbsEvalDataLoader.load_corpus()
      • AbsEvalDataLoader.load_qrels()
      • AbsEvalDataLoader.load_queries()
      • AbsEvalDataLoader._load_remote_corpus()
      • AbsEvalDataLoader._load_remote_qrels()
      • AbsEvalDataLoader._load_remote_queries()
      • AbsEvalDataLoader._load_local_corpus()
      • AbsEvalDataLoader._load_local_qrels()
      • AbsEvalDataLoader._load_local_queries()
      • AbsEvalDataLoader._download_file()
      • AbsEvalDataLoader._get_fpath_size()
      • AbsEvalDataLoader._download_gz_file()
      • AbsEvalDataLoader._download_zip_file()
  • searcher
    • EvalRetriever
      • EvalRetriever
    • EvalDenseRetriever
      • EvalDenseRetriever
    • EvalReranker
      • EvalReranker
  • Evaluator
    • AbsEvaluator
  • runner
    • AbsEvalRunner
• Finetune
  • Embedder
    • AbsArguments
      • AbsRerankerModelArguments
      • AbsRerankerDataArguments
    • AbsDataset
      • AbsEmbedderTrainDataset
        • AbsEmbedderTrainDataset
        • Methods
          • AbsEmbedderTrainDataset._load_dataset()
          • AbsEmbedderTrainDataset._shuffle_text()
      • AbsEmbedderCollator
        • AbsEmbedderCollator
      • AbsEmbedderSameDatasetTrainDataset
        • AbsEmbedderSameDatasetTrainDataset
        • Methods
          • AbsEmbedderSameDatasetTrainDataset.refresh_epoch()
          • AbsEmbedderSameDatasetTrainDataset._load_dataset()
          • AbsEmbedderSameDatasetTrainDataset._get_file_batch_size()
          • AbsEmbedderSameDatasetTrainDataset._get_train_group_size()
          • AbsEmbedderSameDatasetTrainDataset._create_batch_data()
      • AbsEmbedderSameDatasetCollator
        • AbsEmbedderSameDatasetCollator
      • EmbedderTrainerCallbackForDataRefresh
        • EmbedderTrainerCallbackForDataRefresh
        • Methods
          • EmbedderTrainerCallbackForDataRefresh.on_epoch_end()
    • AbsModeling
      • AbsEmbedderModel
        • AbsEmbedderModel
        • Methods
          • AbsEmbedderModel.encode()
          • AbsEmbedderModel.compute_loss()
          • AbsEmbedderModel.compute_score()
          • AbsEmbedderModel.save()
          • AbsEmbedderModel.get_local_score()
          • AbsEmbedderModel.compute_local_score()
          • AbsEmbedderModel.forward()
          • AbsEmbedderModel.distill_loss()
          • AbsEmbedderModel._compute_no_in_batch_neg_loss()
          • AbsEmbedderModel._compute_in_batch_neg_loss()
          • AbsEmbedderModel._compute_cross_device_neg_loss()
          • AbsEmbedderModel._dist_gather_tensor()
      • EmbedderOutput
        • EmbedderOutput
    • AbsTrainer
      • AbsEmbedderTrainer
        • AbsEmbedderTrainer
        • Methods
          • AbsEmbedderTrainer.compute_loss()
    • AbsRunner
      • AbsEmbedderTrainer
        • AbsEmbedderRunner
        • Methods
          • AbsEmbedderRunner.load_tokenizer_and_model()
          • AbsEmbedderRunner.load_trainer()
          • AbsEmbedderRunner.load_train_dataset()
          • AbsEmbedderRunner.load_data_collator()
          • AbsEmbedderRunner.run()
  • Reranker
    • AbsArguments
      • AbsEmbedderModelArguments
      • AbsEmbedderDataArguments
    • AbsDataset
      • AbsRerankerTrainDataset
        • AbsRerankerTrainDataset
        • Methods
          • AbsRerankerTrainDataset.create_one_example()
          • AbsRerankerTrainDataset._load_dataset()
          • AbsRerankerTrainDataset._shuffle_text()
      • AbsRerankerCollator
        • AbsRerankerCollator
      • AbsLLMRerankerTrainDataset
        • AbsLLMRerankerTrainDataset
      • AbsLLMRerankerCollator
        • AbsLLMRerankerCollator
    • AbsModeling
      • AbsRerankerModel
        • AbsRerankerModel
        • Methods
          • AbsRerankerModel.encode()
          • AbsRerankerModel.gradient_checkpointing_enable()
          • AbsRerankerModel.enable_input_require_grads()
          • AbsRerankerModel.forward()
          • AbsRerankerModel.compute_loss()
          • AbsRerankerModel.save()
          • AbsRerankerModel.save_pretrained()
      • RerankerOutput
        • RerankerOutput
    • AbsTrainer
      • AbsRerankerTrainer
        • AbsRerankerTrainer
        • Methods
          • AbsRerankerTrainer.compute_loss()
    • AbsRunner
      • AbsRerankerTrainer
        • AbsRerankerRunner
        • Methods
          • AbsRerankerRunner.load_tokenizer_and_model()
          • AbsRerankerRunner.load_trainer()
          • AbsRerankerRunner.load_train_dataset()
          • AbsRerankerRunner.load_data_collator()
          • AbsRerankerRunner.run()