chore: import upstream snapshot with attribution

docs/source/API/abc.rst

@@ -0,0 +1,7 @@
+Abstract Class
+==============
+
+.. toctree::
+    abc/inference
+    abc/evaluation
+    abc/finetune

docs/source/API/abc/evaluation.rst

@@ -0,0 +1,9 @@
+Evaluation
+==========
+
+.. toctree::
+    evaluation/arguments
+    evaluation/data_loader
+    evaluation/searcher
+    evaluation/evaluator
+    evaluation/runner

docs/source/API/abc/evaluation/arguments.rst

@@ -0,0 +1,7 @@
+Arguments
+=========
+
+.. autoclass:: FlagEmbedding.abc.evaluation.AbsEvalArgs
+
+
+.. autoclass:: FlagEmbedding.abc.evaluation.AbsEvalModelArgs

docs/source/API/abc/evaluation/data_loader.rst

@@ -0,0 +1,25 @@
+dataset loader
+==============
+
+.. autoclass:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader.available_dataset_names
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader.available_splits
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader.check_dataset_names
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader.check_splits
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader.load_corpus
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader.load_qrels
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader.load_queries
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader._load_remote_corpus
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader._load_remote_qrels
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader._load_remote_queries
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader._load_local_corpus
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader._load_local_qrels
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader._load_local_queries
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader._download_file
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader._get_fpath_size
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader._download_gz_file
+.. automethod:: FlagEmbedding.abc.evaluation.AbsEvalDataLoader._download_zip_file

docs/source/API/abc/evaluation/evaluator.rst

@@ -0,0 +1,4 @@
+Evaluator
+=========
+
+.. autoclass:: FlagEmbedding.abc.evaluation.AbsEvaluator

docs/source/API/abc/evaluation/runner.rst

@@ -0,0 +1,4 @@
+runner
+======
+
+.. autoclass:: FlagEmbedding.abc.evaluation.AbsEvalRunner

docs/source/API/abc/evaluation/searcher.rst

@@ -0,0 +1,18 @@
+========
+searcher
+========
+
+EvalRetriever
+=============
+
+.. autoclass:: FlagEmbedding.abc.evaluation.EvalRetriever
+
+EvalDenseRetriever
+==================
+
+.. autoclass:: FlagEmbedding.abc.evaluation.EvalDenseRetriever
+
+EvalReranker
+============
+
+.. autoclass:: FlagEmbedding.abc.evaluation.EvalReranker

docs/source/API/abc/finetune.rst

@@ -0,0 +1,6 @@
+Finetune
+========
+
+.. toctree::
+    finetune/embedder
+    finetune/reranker

docs/source/API/abc/finetune/embedder.rst

@@ -0,0 +1,9 @@
+Embedder
+========
+
+.. toctree::
+    embedder/AbsArguments
+    embedder/AbsDataset
+    embedder/AbsModeling
+    embedder/AbsTrainer
+    embedder/AbsRunner

docs/source/API/abc/finetune/embedder/AbsArguments.rst

@@ -0,0 +1,6 @@
+AbsArguments
+============
+
+.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerModelArguments
+
+.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerDataArguments

docs/source/API/abc/finetune/embedder/AbsDataset.rst

@@ -0,0 +1,53 @@
+==========
+AbsDataset
+==========
+
+AbsEmbedderTrainDataset
+=======================
+
+.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderTrainDataset
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderTrainDataset._load_dataset
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderTrainDataset._shuffle_text
+
+AbsEmbedderCollator
+===================
+
+.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderCollator
+
+AbsEmbedderSameDatasetTrainDataset
+==================================
+
+.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset.refresh_epoch
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset._load_dataset
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset._get_file_batch_size
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset._get_train_group_size
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset._create_batch_data
+
+AbsEmbedderSameDatasetCollator
+==============================
+
+.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetCollator
+
+EmbedderTrainerCallbackForDataRefresh
+=====================================
+
+.. autoclass:: FlagEmbedding.abc.finetune.embedder.EmbedderTrainerCallbackForDataRefresh
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.EmbedderTrainerCallbackForDataRefresh.on_epoch_end

docs/source/API/abc/finetune/embedder/AbsModeling.rst

@@ -0,0 +1,41 @@
+===========
+AbsModeling
+===========
+
+AbsEmbedderModel
+================
+
+.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel.encode
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel.compute_loss
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel.compute_score
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel.save
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel.get_local_score
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel.compute_local_score
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel.forward
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel.distill_loss
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel._compute_no_in_batch_neg_loss
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel._compute_in_batch_neg_loss
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel._compute_cross_device_neg_loss
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModel._dist_gather_tensor
+
+
+EmbedderOutput
+==============
+
+.. autoclass:: FlagEmbedding.abc.finetune.embedder.EmbedderOutput

docs/source/API/abc/finetune/embedder/AbsRunner.rst

@@ -0,0 +1,21 @@
+=========
+AbsRunner
+=========
+
+AbsEmbedderTrainer
+==================
+
+.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderRunner
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderRunner.load_tokenizer_and_model
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderRunner.load_trainer
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderRunner.load_train_dataset
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderRunner.load_data_collator
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderRunner.run

docs/source/API/abc/finetune/embedder/AbsTrainer.rst

@@ -0,0 +1,13 @@
+==========
+AbsTrainer
+==========
+
+AbsEmbedderTrainer
+==================
+
+.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderTrainer
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderTrainer.compute_loss

docs/source/API/abc/finetune/reranker.rst

@@ -0,0 +1,9 @@
+Reranker
+========
+
+.. toctree::
+    reranker/AbsArguments
+    reranker/AbsDataset
+    reranker/AbsModeling
+    reranker/AbsTrainer
+    reranker/AbsRunner

docs/source/API/abc/finetune/reranker/AbsArguments.rst

@@ -0,0 +1,6 @@
+AbsArguments
+============
+
+.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModelArguments
+
+.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderDataArguments

docs/source/API/abc/finetune/reranker/AbsDataset.rst

@@ -0,0 +1,32 @@
+==========
+AbsDataset
+==========
+
+AbsRerankerTrainDataset
+=======================
+
+.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerTrainDataset
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerTrainDataset.create_one_example
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerTrainDataset._load_dataset
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerTrainDataset._shuffle_text
+
+AbsRerankerCollator
+===================
+
+.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerCollator
+
+AbsLLMRerankerTrainDataset
+==========================
+
+.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsLLMRerankerTrainDataset
+
+AbsLLMRerankerCollator
+======================
+
+.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsLLMRerankerCollator

docs/source/API/abc/finetune/reranker/AbsModeling.rst

@@ -0,0 +1,31 @@
+===========
+AbsModeling
+===========
+
+AbsRerankerModel
+================
+
+.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerModel
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerModel.encode
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerModel.gradient_checkpointing_enable
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerModel.enable_input_require_grads
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerModel.forward
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerModel.compute_loss
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerModel.save
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerModel.save_pretrained
+
+
+RerankerOutput
+==============
+
+.. autoclass:: FlagEmbedding.abc.finetune.reranker.RerankerOutput

docs/source/API/abc/finetune/reranker/AbsRunner.rst

@@ -0,0 +1,21 @@
+=========
+AbsRunner
+=========
+
+AbsRerankerTrainer
+==================
+
+.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerRunner
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerRunner.load_tokenizer_and_model
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerRunner.load_trainer
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerRunner.load_train_dataset
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerRunner.load_data_collator
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerRunner.run

docs/source/API/abc/finetune/reranker/AbsTrainer.rst

@@ -0,0 +1,13 @@
+==========
+AbsTrainer
+==========
+
+AbsRerankerTrainer
+==================
+
+.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerTrainer
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerTrainer.compute_loss

docs/source/API/abc/inference.rst

@@ -0,0 +1,6 @@
+Inference
+=========
+
+.. toctree::
+    inference/AbsEmbedder
+    inference/AbsReranker

docs/source/API/abc/inference/AbsEmbedder.rst

@@ -0,0 +1,29 @@
+AbsEmbedder
+===========
+
+.. autoclass:: FlagEmbedding.abc.inference.AbsEmbedder
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.inference.AbsEmbedder.get_target_devices
+
+.. automethod:: FlagEmbedding.abc.inference.AbsEmbedder.get_detailed_instruct
+
+.. automethod:: FlagEmbedding.abc.inference.AbsEmbedder.encode_queries
+
+.. automethod:: FlagEmbedding.abc.inference.AbsEmbedder.encode_corpus
+
+.. automethod:: FlagEmbedding.abc.inference.AbsEmbedder.encode
+
+.. automethod:: FlagEmbedding.abc.inference.AbsEmbedder.encode_single_device
+
+.. automethod:: FlagEmbedding.abc.inference.AbsEmbedder.start_multi_process_pool
+
+.. automethod:: FlagEmbedding.abc.inference.AbsEmbedder._encode_multi_process_worker
+
+.. automethod:: FlagEmbedding.abc.inference.AbsEmbedder.stop_multi_process_pool
+
+.. automethod:: FlagEmbedding.abc.inference.AbsEmbedder.encode_multi_process
+
+.. automethod:: FlagEmbedding.abc.inference.AbsEmbedder._concatenate_results_from_multi_process

docs/source/API/abc/inference/AbsReranker.rst

@@ -0,0 +1,25 @@
+AbsReranker
+===========
+
+.. autoclass:: FlagEmbedding.abc.inference.AbsReranker
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.abc.inference.AbsReranker.get_target_devices
+
+.. automethod:: FlagEmbedding.abc.inference.AbsReranker.get_detailed_instruct
+
+.. automethod:: FlagEmbedding.abc.inference.AbsReranker.get_detailed_inputs
+
+.. automethod:: FlagEmbedding.abc.inference.AbsReranker.compute_score
+
+.. automethod:: FlagEmbedding.abc.inference.AbsReranker.compute_score_single_gpu
+
+.. automethod:: FlagEmbedding.abc.inference.AbsReranker.start_multi_process_pool
+
+.. automethod:: FlagEmbedding.abc.inference.AbsReranker.encode_multi_process
+
+.. automethod:: FlagEmbedding.abc.inference.AbsReranker._encode_multi_process_worker
+
+.. automethod:: FlagEmbedding.abc.inference.AbsReranker.stop_multi_process_pool

docs/source/API/evaluation.rst

@@ -0,0 +1,11 @@
+Evaluation
+==========
+
+.. toctree::
+    evaluation/mteb
+    evaluation/airbench
+    evaluation/msmarco
+    evaluation/beir
+    evaluation/miracl
+    evaluation/mkqa
+    evaluation/mldr

docs/source/API/evaluation/airbench.rst

@@ -0,0 +1,42 @@
+AIR-Bench
+=========
+
+`AIR-Bench <https://github.com/AIR-Bench/AIR-Bench>`_ (Automated heterogeneous Information Retrieval Benchmark) is a dynamic (actively being updated) benchmark for information retrieval.
+Now the benchmark contains two versions. Notice that the testing data is generated by LLMs with out human intervention. 
+This helps the evaluation of new domains easier and faster to be updated. It also makes it impossible for any models to have the test data covered in their training sets.
+
+You can evaluate model's performance on AIR-Bench by running our provided shell script:
+
+.. code:: bash
+
+    chmod +x /examples/evaluation/air_bench/eval_air_bench.sh
+    ./examples/evaluation/air_bench/eval_air_bench.sh
+
+Or by running:
+
+.. code:: bash
+
+    python -m FlagEmbedding.evaluation.air_bench \
+    --benchmark_version AIR-Bench_24.05 \
+    --task_types qa long-doc \
+    --domains arxiv \
+    --languages en \
+    --splits dev test \
+    --output_dir ./air_bench/search_results \
+    --search_top_k 1000 \
+    --rerank_top_k 100 \
+    --cache_dir /root/.cache/huggingface/hub \
+    --overwrite False \
+    --embedder_name_or_path BAAI/bge-m3 \
+    --reranker_name_or_path BAAI/bge-reranker-v2-m3 \
+    --devices cuda:0 cuda:1 \
+    --model_cache_dir /root/.cache/huggingface/hub \
+    --reranker_max_length 1024
+
+change the embedder, reranker, devices and cache directory to your preference.
+
+.. toctree::
+   :hidden:
+
+   airbench/arguments
+   airbench/runner

docs/source/API/evaluation/airbench/arguments.rst

@@ -0,0 +1,4 @@
+arguments
+=========
+
+.. autoclass:: FlagEmbedding.evaluation.air_bench.AIRBenchEvalModelArgs

docs/source/API/evaluation/airbench/runner.rst

@@ -0,0 +1,4 @@
+runner
+======
+
+.. autoclass:: FlagEmbedding.evaluation.air_bench.AIRBenchEvalRunner

docs/source/API/evaluation/beir.rst

@@ -0,0 +1,47 @@
+BEIR
+====
+
+`BEIR <https://github.com/beir-cellar/beir>`_ (Benchmarking-IR) is a heterogeneous evaluation benchmark for information retrieval. 
+It is designed for evaluating the performance of NLP-based retrieval models and widely used by research of modern embedding models.
+
+You can evaluate model's performance on the BEIR benchmark by running our provided shell script:
+
+.. code:: bash
+
+    chmod +x /examples/evaluation/beir/eval_beir.sh
+    ./examples/evaluation/beir/eval_beir.sh
+
+Or by running:
+
+.. code:: bash
+
+    python -m FlagEmbedding.evaluation.beir \
+    --eval_name beir \
+    --dataset_dir ./beir/data \
+    --dataset_names fiqa arguana cqadupstack \
+    --splits test dev \
+    --corpus_embd_save_dir ./beir/corpus_embd \
+    --output_dir ./beir/search_results \
+    --search_top_k 1000 \
+    --rerank_top_k 100 \
+    --cache_path /root/.cache/huggingface/hub \
+    --overwrite False \
+    --k_values 10 100 \
+    --eval_output_method markdown \
+    --eval_output_path ./beir/beir_eval_results.md \
+    --eval_metrics ndcg_at_10 recall_at_100 \
+    --ignore_identical_ids True \
+    --embedder_name_or_path BAAI/bge-large-en-v1.5 \
+    --reranker_name_or_path BAAI/bge-reranker-v2-m3 \
+    --devices cuda:0 cuda:1 \
+    --reranker_max_length 1024 \
+
+change the embedder, devices and cache directory to your preference.
+
+.. toctree::
+   :hidden:
+
+   beir/arguments
+   beir/data_loader
+   beir/evaluator
+   beir/runner

docs/source/API/evaluation/beir/arguments.rst

@@ -0,0 +1,4 @@
+arguments
+=========
+
+.. autoclass:: FlagEmbedding.evaluation.beir.arguments.BEIREvalArgs

docs/source/API/evaluation/beir/data_loader.rst

@@ -0,0 +1,4 @@
+data loader
+===========
+
+.. autoclass:: FlagEmbedding.evaluation.beir.data_loader.BEIREvalDataLoader

docs/source/API/evaluation/beir/evaluator.rst

@@ -0,0 +1,4 @@
+evaluator
+=========
+
+.. autoclass:: FlagEmbedding.evaluation.beir.evaluator.BEIREvaluator

docs/source/API/evaluation/beir/runner.rst

@@ -0,0 +1,4 @@
+runner
+======
+
+.. autoclass:: FlagEmbedding.evaluation.beir.BEIREvalRunner

docs/source/API/evaluation/miracl.rst

@@ -0,0 +1,48 @@
+MIRACL
+======
+
+`MIRACL <https://project-miracl.github.io/>`_ (Multilingual Information Retrieval Across a Continuum of Languages) 
+is an WSDM 2023 Cup challenge that focuses on search across 18 different languages.
+They release a multilingual retrieval dataset containing the train and dev set for 16 "known languages" and only dev set for 2 "surprise languages".
+The topics are generated by native speakers of each language, who also label the relevance between the topics and a given document list.
+You can found the `dataset <https://huggingface.co/datasets/miracl/miracl-corpus>`_ on HuggingFace.
+
+You can evaluate model's performance on MIRACL simply by running our provided shell script:
+
+.. code:: bash
+
+    chmod +x /examples/evaluation/miracl/eval_miracl.sh
+    ./examples/evaluation/miracl/eval_miracl.sh
+
+Or by running:
+
+.. code:: bash
+
+    python -m FlagEmbedding.evaluation.miracl \
+    --eval_name miracl \
+    --dataset_dir ./miracl/data \
+    --dataset_names bn hi sw te th yo \
+    --splits dev \
+    --corpus_embd_save_dir ./miracl/corpus_embd \
+    --output_dir ./miracl/search_results \
+    --search_top_k 1000 \
+    --rerank_top_k 100 \
+    --cache_path /root/.cache/huggingface/hub \
+    --overwrite False \
+    --k_values 10 100 \
+    --eval_output_method markdown \
+    --eval_output_path ./miracl/miracl_eval_results.md \
+    --eval_metrics ndcg_at_10 recall_at_100 \
+    --embedder_name_or_path BAAI/bge-m3 \
+    --reranker_name_or_path BAAI/bge-reranker-v2-m3 \
+    --devices cuda:0 cuda:1 \
+    --cache_dir /root/.cache/huggingface/hub \
+    --reranker_max_length 1024
+
+change the embedder, reranker, devices and cache directory to your preference.
+
+.. toctree::
+   :hidden:
+
+   miracl/data_loader
+   miracl/runner

docs/source/API/evaluation/miracl/data_loader.rst

@@ -0,0 +1,13 @@
+data_loader
+===========
+
+.. autoclass:: FlagEmbedding.evaluation.miracl.MIRACLEvalDataLoader
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.evaluation.miracl.MIRACLEvalDataLoader.available_dataset_names
+.. automethod:: FlagEmbedding.evaluation.miracl.MIRACLEvalDataLoader.available_splits
+.. automethod:: FlagEmbedding.evaluation.miracl.MIRACLEvalDataLoader._load_remote_corpus
+.. automethod:: FlagEmbedding.evaluation.miracl.MIRACLEvalDataLoader._load_remote_qrels
+.. automethod:: FlagEmbedding.evaluation.miracl.MIRACLEvalDataLoader._load_remote_queries

docs/source/API/evaluation/miracl/runner.rst

@@ -0,0 +1,5 @@
+runner
+======
+
+.. autoclass:: FlagEmbedding.evaluation.miracl.MIRACLEvalRunner
+    :members:

docs/source/API/evaluation/mkqa.rst

@@ -0,0 +1,89 @@
+MKQA
+====
+
+`MKQA <https://github.com/apple/ml-mkqa>`_ is an open-domain question answering evaluation set comprising 10k question-answer pairs aligned across 26 typologically diverse languages.
+The queries are sampled from the [Google Natural Questions Dataset](https://github.com/google-research-datasets/natural-questions). 
+
+Each example in the dataset has the following structure:
+
+.. code:: bash
+
+    {
+        'example_id': 563260143484355911,
+        'queries': {
+            'en': "who sings i hear you knocking but you can't come in",
+            'ru': "кто поет i hear you knocking but you can't come in",
+            'ja': '「 I hear you knocking」は誰が歌っていますか',
+            'zh_cn': "《i hear you knocking but you can't come in》是谁演唱的",
+            ...
+        },
+        'query': "who sings i hear you knocking but you can't come in",
+        'answers': {
+            'en': [{
+                'type': 'entity',
+                'entity': 'Q545186',
+                'text': 'Dave Edmunds',
+                'aliases': [],
+            }],
+            'ru': [{
+                'type': 'entity',
+                'entity': 'Q545186',
+                'text': 'Эдмундс, Дэйв',
+                'aliases': ['Эдмундс', 'Дэйв Эдмундс', 'Эдмундс Дэйв', 'Dave Edmunds'],
+            }],
+            'ja': [{
+                'type': 'entity',
+                'entity': 'Q545186',
+                'text': 'デイヴ・エドモンズ',
+                'aliases': ['デーブ・エドモンズ', 'デイブ・エドモンズ'],
+            }],
+            'zh_cn': [{
+                'type': 'entity', 
+                'text': '戴维·埃德蒙兹 ', 
+                'entity': 'Q545186',
+            }],
+            ...
+        },
+    }
+
+
+You can evaluate model's performance on MKQA simply by running our provided shell script:
+
+.. code:: bash
+
+    chmod +x /examples/evaluation/mkqa/eval_mkqa.sh
+    ./examples/evaluation/mkqa/eval_mkqa.sh
+
+Or by running:
+
+.. code:: bash
+
+    python -m FlagEmbedding.evaluation.mkqa \
+    --eval_name mkqa \
+    --dataset_dir ./mkqa/data \
+    --dataset_names en zh_cn \
+    --splits test \
+    --corpus_embd_save_dir ./mkqa/corpus_embd \
+    --output_dir ./mkqa/search_results \
+    --search_top_k 1000 \
+    --rerank_top_k 100 \
+    --cache_path /root/.cache/huggingface/hub \
+    --overwrite False \
+    --k_values 20 \
+    --eval_output_method markdown \
+    --eval_output_path ./mkqa/mkqa_eval_results.md \
+    --eval_metrics qa_recall_at_20 \
+    --embedder_name_or_path BAAI/bge-m3 \
+    --reranker_name_or_path BAAI/bge-reranker-v2-m3 \
+    --devices cuda:0 cuda:1 \
+    --cache_dir /root/.cache/huggingface/hub \
+    --reranker_max_length 1024
+
+change the embedder, reranker, devices and cache directory to your preference.
+
+.. toctree::
+   :hidden:
+
+   mkqa/data_loader
+   mkqa/evaluator
+   mkqa/runner

docs/source/API/evaluation/mkqa/data_loader.rst

@@ -0,0 +1,15 @@
+data_loader
+===========
+
+.. autoclass:: FlagEmbedding.evaluation.mkqa.MKQAEvalDataLoader
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.evaluation.mkqa.MKQAEvalDataLoader.available_dataset_names
+.. automethod:: FlagEmbedding.evaluation.mkqa.MKQAEvalDataLoader.available_splits
+.. automethod:: FlagEmbedding.evaluation.mkqa.MKQAEvalDataLoader.load_corpus
+.. automethod:: FlagEmbedding.evaluation.mkqa.MKQAEvalDataLoader._load_local_qrels
+.. automethod:: FlagEmbedding.evaluation.mkqa.MKQAEvalDataLoader._load_remote_corpus
+.. automethod:: FlagEmbedding.evaluation.mkqa.MKQAEvalDataLoader._load_remote_qrels
+.. automethod:: FlagEmbedding.evaluation.mkqa.MKQAEvalDataLoader._load_remote_queries

docs/source/API/evaluation/mkqa/evaluator.rst

@@ -0,0 +1,5 @@
+evaluator
+=========
+
+.. autoclass:: FlagEmbedding.evaluation.mkqa.MKQAEvaluator
+    :members:

docs/source/API/evaluation/mkqa/runner.rst

@@ -0,0 +1,4 @@
+runner
+======
+.. autoclass:: FlagEmbedding.evaluation.mkqa.MKQAEvalRunner
+    :members:

docs/source/API/evaluation/mldr.rst

@@ -0,0 +1,95 @@
+MLDR
+====
+
+`MLDR <https://huggingface.co/datasets/Shitao/MLDR>`_ is a Multilingual Long-Document Retrieval dataset built on Wikipeida, Wudao and mC4, covering 13 typologically diverse languages. 
+Specifically, we sample lengthy articles from Wikipedia, Wudao and mC4 datasets and randomly choose paragraphs from them. 
+Then we use GPT-3.5 to generate questions based on these paragraphs. 
+The generated question and the sampled article constitute a new text pair to the dataset.
+
+An example of ``train`` set looks like:
+
+.. code:: bash
+
+    {
+        'query_id': 'q-zh-<...>', 
+        'query': '...', 
+        'positive_passages': [
+            {
+                'docid': 'doc-zh-<...>',
+                'text': '...'
+            }
+        ],
+        'negative_passages': [
+            {
+                'docid': 'doc-zh-<...>',
+                'text': '...'
+            },
+            ...
+        ]
+    }
+
+An example of ``dev`` and ``test`` set looks like:
+
+.. code:: bash
+
+    {
+        'query_id': 'q-zh-<...>', 
+        'query': '...', 
+        'positive_passages': [
+            {
+                'docid': 'doc-zh-<...>',
+                'text': '...'
+            }
+        ],
+        'negative_passages': []
+    }
+
+An example of ``corpus`` looks like:
+
+.. code:: bash
+
+    {
+        'docid': 'doc-zh-<...>', 
+        'text': '...'
+    }
+
+You can evaluate model's performance on MLDR simply by running our provided shell script:
+
+.. code:: bash
+
+    chmod +x /examples/evaluation/mldr/eval_mldr.sh
+    ./examples/evaluation/mldr/eval_mldr.sh
+
+Or by running:
+
+.. code:: bash
+
+    python -m FlagEmbedding.evaluation.mldr \
+    --eval_name mldr \
+    --dataset_dir ./mldr/data \
+    --dataset_names hi \
+    --splits test \
+    --corpus_embd_save_dir ./mldr/corpus_embd \
+    --output_dir ./mldr/search_results \
+    --search_top_k 1000 \
+    --rerank_top_k 100 \
+    --cache_path /root/.cache/huggingface/hub \
+    --overwrite False \
+    --k_values 10 100 \
+    --eval_output_method markdown \
+    --eval_output_path ./mldr/mldr_eval_results.md \
+    --eval_metrics ndcg_at_10 \
+    --embedder_name_or_path BAAI/bge-m3 \
+    --reranker_name_or_path BAAI/bge-reranker-v2-m3 \
+    --devices cuda:0 cuda:1 \
+    --cache_dir /root/.cache/huggingface/hub \
+    --embedder_passage_max_length 8192 \
+    --reranker_max_length 8192
+
+change the args of embedder, reranker, devices and cache directory to your preference.
+
+.. toctree::
+   :hidden:
+
+   mldr/data_loader
+   mldr/runner

docs/source/API/evaluation/mldr/data_loader.rst

@@ -0,0 +1,13 @@
+data_loader
+===========
+
+.. autoclass:: FlagEmbedding.evaluation.mldr.MLDREvalDataLoader
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.evaluation.mldr.MLDREvalDataLoader.available_dataset_names
+.. automethod:: FlagEmbedding.evaluation.mldr.MLDREvalDataLoader.available_splits
+.. automethod:: FlagEmbedding.evaluation.mldr.MLDREvalDataLoader._load_remote_corpus
+.. automethod:: FlagEmbedding.evaluation.mldr.MLDREvalDataLoader._load_remote_qrels
+.. automethod:: FlagEmbedding.evaluation.mldr.MLDREvalDataLoader._load_remote_queries

docs/source/API/evaluation/mldr/runner.rst

@@ -0,0 +1,5 @@
+runner
+======
+
+.. autoclass:: FlagEmbedding.evaluation.mldr.MLDREvalRunner
+    :members:

docs/source/API/evaluation/msmarco.rst

@@ -0,0 +1,46 @@
+MSMARCO
+=======
+
+`MS Marco <https://microsoft.github.io/msmarco/>`_ (Microsoft MAchine Reading Comprehension) is a large scale real-world reading comprehension dataset.
+It is widely used in information retrieval, question answering, and natural language processing research.
+
+
+You can evaluate model's performance on MS MARCO simply by running our provided shell script:
+
+.. code:: bash
+
+    chmod +x /examples/evaluation/msmarco/eval_msmarco.sh
+    ./examples/evaluation/msmarco/eval_msmarco.sh
+
+Or by running:
+
+.. code:: bash
+
+    python -m FlagEmbedding.evaluation.msmarco \
+    --eval_name msmarco \
+    --dataset_dir ./msmarco/data \
+    --dataset_names passage \
+    --splits dev \
+    --corpus_embd_save_dir ./msmarco/corpus_embd \
+    --output_dir ./msmarco/search_results \
+    --search_top_k 1000 \
+    --rerank_top_k 100 \
+    --cache_path /root/.cache/huggingface/hub \
+    --overwrite True \
+    --k_values 10 100 \
+    --eval_output_method markdown \
+    --eval_output_path ./msmarco/msmarco_eval_results.md \
+    --eval_metrics ndcg_at_10 recall_at_100 \
+    --embedder_name_or_path BAAI/bge-large-en-v1.5 \
+    --reranker_name_or_path BAAI/bge-reranker-v2-m3 \
+    --devices cuda:0 cuda:1 cuda:2 cuda:3 cuda:4 cuda:5 cuda:6 cuda:7 \
+    --cache_dir /root/.cache/huggingface/hub \
+    --reranker_max_length 1024
+
+change the embedder, reranker, devices and cache directory to your preference.
+
+.. toctree::
+   :hidden:
+
+   msmarco/data_loader
+   msmarco/runner

docs/source/API/evaluation/msmarco/data_loader.rst

@@ -0,0 +1,13 @@
+data_loader
+===========
+
+.. autoclass:: FlagEmbedding.evaluation.msmarco.MSMARCOEvalDataLoader
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.evaluation.msmarco.MSMARCOEvalDataLoader.available_dataset_names
+.. automethod:: FlagEmbedding.evaluation.msmarco.MSMARCOEvalDataLoader.available_splits
+.. automethod:: FlagEmbedding.evaluation.msmarco.MSMARCOEvalDataLoader._load_remote_corpus
+.. automethod:: FlagEmbedding.evaluation.msmarco.MSMARCOEvalDataLoader._load_remote_qrels
+.. automethod:: FlagEmbedding.evaluation.msmarco.MSMARCOEvalDataLoader._load_remote_queries

docs/source/API/evaluation/msmarco/runner.rst

@@ -0,0 +1,5 @@
+runner
+======
+
+.. autoclass:: FlagEmbedding.evaluation.msmarco.MSMARCOEvalRunner
+    :members:

docs/source/API/evaluation/mteb.rst

@@ -0,0 +1,37 @@
+MTEB
+====
+
+`MTEB <https://github.com/embeddings-benchmark/mteb>`_ (The Massive Text Embedding Benchmark) is a large-scale evaluation framework designed to assess the performance of text embedding models across a wide variety of NLP tasks. 
+Introduced to standardize and improve the evaluation of text embeddings, MTEB is crucial for assessing how well these models generalize across various real-world applications. 
+It contains a wide range of datasets in eight main NLP tasks and different languages, and provides an easy pipeline for evaluation.
+It also holds the well known MTEB `leaderboard <https://huggingface.co/spaces/mteb/leaderboard>`_, which contains a ranking of the latest first-class embedding models.
+
+You can evaluate model's performance on the whole MTEB benchmark by running our provided shell script:
+
+.. code:: bash
+
+    chmod +x /examples/evaluation/mteb/eval_mteb.sh
+    ./examples/evaluation/mteb/eval_mteb.sh
+
+Or by running:
+
+.. code:: bash
+
+    python -m FlagEmbedding.evaluation.mteb \
+    --eval_name mteb \
+    --output_dir ./mteb/search_results \
+    --languages eng \
+    --tasks NFCorpus BiorxivClusteringS2S SciDocsRR \
+    --eval_output_path ./mteb/mteb_eval_results.json \
+    --embedder_name_or_path BAAI/bge-large-en-v1.5 \
+    --devices cuda:7 \
+    --cache_dir /root/.cache/huggingface/hub
+
+change the embedder, devices and cache directory to your preference.
+
+.. toctree::
+   :hidden:
+
+   mteb/arguments
+   mteb/searcher
+   mteb/runner

docs/source/API/evaluation/mteb/arguments.rst

@@ -0,0 +1,4 @@
+arguments
+=========
+
+.. autoclass:: FlagEmbedding.evaluation.mteb.arguments.MTEBEvalArgs

docs/source/API/evaluation/mteb/runner.rst

@@ -0,0 +1,4 @@
+runner
+======
+
+.. autoclass:: FlagEmbedding.evaluation.mteb.runner.MTEBEvalRunner

docs/source/API/evaluation/mteb/searcher.rst

@@ -0,0 +1,6 @@
+searcher
+========
+
+.. autoclass:: FlagEmbedding.evaluation.mteb.searcher.MTEBEvalDenseRetriever
+
+.. autoclass:: FlagEmbedding.evaluation.mteb.searcher.MTEBEvalReranker

docs/source/API/finetune.rst

@@ -0,0 +1,6 @@
+Finetune
+========
+
+.. toctree::
+    finetune/embedder
+    finetune/reranker

docs/source/API/finetune/embedder.rst

@@ -0,0 +1,6 @@
+Embedder
+========
+
+.. toctree::
+    embedder/encoder_only
+    embedder/decoder_only

docs/source/API/finetune/embedder/decoder_only.rst

@@ -0,0 +1,6 @@
+Decoder Only
+============
+
+.. toctree::
+    decoder_only/base
+    decoder_only/icl

docs/source/API/finetune/embedder/decoder_only/base.rst

@@ -0,0 +1,8 @@
+Base
+====
+
+.. toctree::
+    base/arguments
+    base/modeling
+    base/runner
+    base/trainer

docs/source/API/finetune/embedder/decoder_only/base/arguments.rst

@@ -0,0 +1,4 @@
+Arguments
+=========
+
+.. autoclass:: FlagEmbedding.finetune.embedder.decoder_only.base.DecoderOnlyEmbedderModelArguments

docs/source/API/finetune/embedder/decoder_only/base/modeling.rst

@@ -0,0 +1,10 @@
+========
+Modeling
+========
+
+.. autoclass:: FlagEmbedding.finetune.reranker.decoder_only.base.CrossDecoderModel
+
+Methods
+=======
+
+.. automethod:: FlagEmbedding.finetune.reranker.decoder_only.base.CrossDecoderModel.encode

docs/source/API/finetune/embedder/decoder_only/base/runner.rst

@@ -0,0 +1,5 @@
+Runner
+======
+
+.. autoclass:: FlagEmbedding.finetune.reranker.decoder_only.base.DecoderOnlyRerankerRunner
+    :members:

docs/source/API/finetune/embedder/decoder_only/base/trainer.rst

@@ -0,0 +1,5 @@
+Trainer
+=======
+
+.. autoclass:: FlagEmbedding.finetune.reranker.decoder_only.base.DecoderOnlyRerankerTrainer
+    :members:

docs/source/API/finetune/embedder/decoder_only/icl.rst

@@ -0,0 +1,9 @@
+ICL
+===
+
+.. toctree::
+    icl/arguments
+    icl/dataset
+    icl/modeling
+    icl/runner
+    icl/trainer

docs/source/API/finetune/embedder/decoder_only/icl/arguments.rst

@@ -0,0 +1,6 @@
+Arguments
+=========
+
+.. autoclass:: FlagEmbedding.finetune.embedder.decoder_only.icl.DecoderOnlyEmbedderICLModelArguments
+
+.. autoclass:: FlagEmbedding.finetune.embedder.decoder_only.icl.DecoderOnlyEmbedderICLDataArguments

docs/source/API/finetune/embedder/decoder_only/icl/dataset.rst

@@ -0,0 +1,18 @@
+=======
+Dataset
+=======
+
+DecoderOnlyEmbedderICLSameDatasetTrainDataset
+=============================================
+
+.. autoclass:: FlagEmbedding.finetune.embedder.decoder_only.icl.DecoderOnlyEmbedderICLSameDatasetTrainDataset
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.icl.DecoderOnlyEmbedderICLSameDatasetTrainDataset._create_batch_data
+
+AbsEmbedderSameDatasetCollator
+==============================
+
+.. autoclass:: FlagEmbedding.finetune.embedder.decoder_only.icl.AbsEmbedderSameDatasetCollator

docs/source/API/finetune/embedder/decoder_only/icl/modeling.rst

@@ -0,0 +1,18 @@
+========
+Modeling
+========
+
+.. autoclass:: FlagEmbedding.finetune.embedder.decoder_only.icl.BiDecoderOnlyEmbedderICLModel
+
+Methods
+=======
+
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.icl.BiDecoderOnlyEmbedderICLModel.encode
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.icl.BiDecoderOnlyEmbedderICLModel.compute_score
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.icl.BiDecoderOnlyEmbedderICLModel.compute_loss
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.icl.BiDecoderOnlyEmbedderICLModel.gradient_checkpointing_enable
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.icl.BiDecoderOnlyEmbedderICLModel.enable_input_require_grads
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.icl.BiDecoderOnlyEmbedderICLModel.save
+
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.icl.BiDecoderOnlyEmbedderICLModel._sentence_embedding
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.icl.BiDecoderOnlyEmbedderICLModel._compute_similarity

docs/source/API/finetune/embedder/decoder_only/icl/runner.rst

@@ -0,0 +1,5 @@
+Runner
+======
+
+.. autoclass:: FlagEmbedding.finetune.embedder.decoder_only.icl.DecoderOnlyEmbedderICLRunner
+    :members:

docs/source/API/finetune/embedder/decoder_only/icl/trainer.rst

@@ -0,0 +1,5 @@
+Trainer
+=======
+
+.. autoclass:: FlagEmbedding.finetune.embedder.decoder_only.icl.DecoderOnlyEmbedderICLTrainer
+    :members:

docs/source/API/finetune/embedder/encoder_only.rst

@@ -0,0 +1,6 @@
+Encoder Only
+============
+
+.. toctree::
+    encoder_only/base
+    encoder_only/m3

docs/source/API/finetune/embedder/encoder_only/base.rst

@@ -0,0 +1,7 @@
+Base
+====
+
+.. toctree::
+    base/modeling
+    base/runner
+    base/trainer

docs/source/API/finetune/embedder/encoder_only/base/modeling.rst

@@ -0,0 +1,17 @@
+Modeling
+========
+
+.. autoclass:: FlagEmbedding.finetune.embedder.encoder_only.base.BiEncoderOnlyEmbedderModel
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.base.BiEncoderOnlyEmbedderModel.encode
+
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.base.BiEncoderOnlyEmbedderModel.compute_score
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.base.BiEncoderOnlyEmbedderModel.compute_loss
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.base.BiEncoderOnlyEmbedderModel.gradient_checkpointing_enable
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.base.BiEncoderOnlyEmbedderModel.enable_input_require_grads
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.base.BiEncoderOnlyEmbedderModel.save
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.base.BiEncoderOnlyEmbedderModel._sentence_embedding
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.base.BiEncoderOnlyEmbedderModel._compute_similarity

docs/source/API/finetune/embedder/encoder_only/base/runner.rst

@@ -0,0 +1,5 @@
+Runner
+======
+
+.. autoclass:: FlagEmbedding.finetune.embedder.encoder_only.base.EncoderOnlyEmbedderRunner
+    :members:

docs/source/API/finetune/embedder/encoder_only/base/trainer.rst

@@ -0,0 +1,5 @@
+Trainer
+=======
+
+.. autoclass:: FlagEmbedding.finetune.embedder.encoder_only.base.EncoderOnlyEmbedderTrainer
+    :members:

docs/source/API/finetune/embedder/encoder_only/m3.rst

@@ -0,0 +1,8 @@
+M3
+==
+
+.. toctree::
+    m3/arguments
+    m3/modeling
+    m3/runner
+    m3/trainer

docs/source/API/finetune/embedder/encoder_only/m3/arguments.rst

@@ -0,0 +1,6 @@
+Arguments
+=========
+
+.. autoclass:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3ModelArguments
+
+.. autoclass:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3TrainingArguments

docs/source/API/finetune/embedder/encoder_only/m3/modeling.rst

@@ -0,0 +1,35 @@
+========
+Modeling
+========
+
+EncoderOnlyEmbedderM3Model
+============================
+
+.. autoclass:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model.encode
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model.compute_score
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model.compute_dense_score
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model.compute_sparse_score
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model.compute_colbert_score
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model.ensemble_score
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model.forward
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model.compute_loss
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model.gradient_checkpointing_enable
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model.enable_input_require_grads
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model.save
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model._dense_embedding
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model._sparse_embedding
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model._colbert_embedding
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model._encode
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model._compute_similarity
+.. automethod:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Model._get_queries_attention_mask
+
+EncoderOnlyEmbedderM3ModelForInference
+======================================
+
+.. autoclass:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3ModelForInference
+    :members:

docs/source/API/finetune/embedder/encoder_only/m3/runner.rst

@@ -0,0 +1,5 @@
+Runner
+======
+
+.. autoclass:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Runner
+    :members:

docs/source/API/finetune/embedder/encoder_only/m3/trainer.rst

@@ -0,0 +1,5 @@
+Trainer
+=======
+
+.. autoclass:: FlagEmbedding.finetune.embedder.encoder_only.m3.EncoderOnlyEmbedderM3Trainer
+    :members:

docs/source/API/finetune/reranker.rst

@@ -0,0 +1,6 @@
+Reranker
+========
+
+.. toctree::
+    reranker/encoder_only
+    reranker/decoder_only

docs/source/API/finetune/reranker/decoder_only.rst

@@ -0,0 +1,6 @@
+Decoder Only
+============
+
+.. toctree::
+    decoder_only/base
+    decoder_only/layerwise

docs/source/API/finetune/reranker/decoder_only/base.rst

@@ -0,0 +1,8 @@
+Base
+====
+
+.. toctree::
+    base/arguments
+    base/modeling
+    base/runner
+    base/trainer

docs/source/API/finetune/reranker/decoder_only/base/arguments.rst

@@ -0,0 +1,4 @@
+Arguments
+=========
+
+.. autoclass:: FlagEmbedding.finetune.reranker.decoder_only.base.RerankerModelArguments

docs/source/API/finetune/reranker/decoder_only/base/modeling.rst

@@ -0,0 +1,18 @@
+========
+Modeling
+========
+
+.. autoclass:: FlagEmbedding.finetune.embedder.decoder_only.base.BiDecoderOnlyEmbedderModel
+
+Methods
+=======
+
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.base.BiDecoderOnlyEmbedderModel.encode
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.base.BiDecoderOnlyEmbedderModel.compute_score
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.base.BiDecoderOnlyEmbedderModel.compute_loss
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.base.BiDecoderOnlyEmbedderModel.gradient_checkpointing_enable
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.base.BiDecoderOnlyEmbedderModel.enable_input_require_grads
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.base.BiDecoderOnlyEmbedderModel.save
+
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.base.BiDecoderOnlyEmbedderModel._sentence_embedding
+.. automethod:: FlagEmbedding.finetune.embedder.decoder_only.base.BiDecoderOnlyEmbedderModel._compute_similarity

docs/source/API/finetune/reranker/decoder_only/base/runner.rst

@@ -0,0 +1,5 @@
+Runner
+======
+
+.. autoclass:: FlagEmbedding.finetune.embedder.decoder_only.base.DecoderOnlyEmbedderRunner
+    :members:

docs/source/API/finetune/reranker/decoder_only/base/trainer.rst

@@ -0,0 +1,5 @@
+Trainer
+=======
+
+.. autoclass:: FlagEmbedding.finetune.embedder.decoder_only.base.DecoderOnlyEmbedderTrainer
+    :members:

docs/source/API/finetune/reranker/decoder_only/layerwise.rst

@@ -0,0 +1,8 @@
+Layerwise
+=========
+
+.. toctree::
+    layerwise/arguments
+    layerwise/modeling
+    layerwise/runner
+    layerwise/trainer

docs/source/API/finetune/reranker/decoder_only/layerwise/arguments.rst

@@ -0,0 +1,4 @@
+Arguments
+=========
+
+.. autoclass:: FlagEmbedding.finetune.reranker.decoder_only.layerwise.RerankerModelArguments

docs/source/API/finetune/reranker/decoder_only/layerwise/modeling.rst

@@ -0,0 +1,11 @@
+========
+Modeling
+========
+
+.. autoclass:: FlagEmbedding.finetune.reranker.decoder_only.layerwise.CrossDecoderModel
+
+Methods
+=======
+
+.. automethod:: FlagEmbedding.finetune.reranker.decoder_only.layerwise.CrossDecoderModel.encode
+.. automethod:: FlagEmbedding.finetune.reranker.decoder_only.layerwise.CrossDecoderModel.forward

docs/source/API/finetune/reranker/decoder_only/layerwise/runner.rst

@@ -0,0 +1,5 @@
+Runner
+======
+
+.. autoclass:: FlagEmbedding.finetune.reranker.decoder_only.layerwise.DecoderOnlyRerankerRunner
+    :members:

docs/source/API/finetune/reranker/decoder_only/layerwise/trainer.rst

@@ -0,0 +1,5 @@
+Trainer
+=======
+
+.. autoclass:: FlagEmbedding.finetune.reranker.decoder_only.layerwise.DecoderOnlyRerankerTrainer
+    :members:

docs/source/API/finetune/reranker/encoder_only.rst

@@ -0,0 +1,5 @@
+Encoder Only
+============
+
+.. toctree::
+    encoder_only/base

docs/source/API/finetune/reranker/encoder_only/base.rst

@@ -0,0 +1,7 @@
+Base
+====
+
+.. toctree::
+    base/modeling
+    base/runner
+    base/trainer

docs/source/API/finetune/reranker/encoder_only/base/modeling.rst

@@ -0,0 +1,9 @@
+Modeling
+========
+
+.. autoclass:: FlagEmbedding.finetune.reranker.encoder_only.base.CrossEncoderModel
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.finetune.reranker.encoder_only.base.CrossEncoderModel.encode

docs/source/API/finetune/reranker/encoder_only/base/runner.rst

@@ -0,0 +1,5 @@
+Runner
+======
+
+.. autoclass:: FlagEmbedding.finetune.reranker.encoder_only.base.EncoderOnlyRerankerRunner
+    :members:

docs/source/API/finetune/reranker/encoder_only/base/trainer.rst

@@ -0,0 +1,5 @@
+Trainer
+=======
+
+.. autoclass:: FlagEmbedding.finetune.reranker.encoder_only.base.EncoderOnlyRerankerTrainer
+    :members:

docs/source/API/index.rst

@@ -0,0 +1,10 @@
+API
+===
+
+.. toctree::
+   :maxdepth: 1
+
+   abc
+   inference
+   evaluation
+   finetune

docs/source/API/inference.rst

@@ -0,0 +1,8 @@
+Inference
+=========
+
+.. toctree::
+    inference/FlagAutoModel
+    inference/FlagAutoReranker
+    inference/embedder/embedder
+    inference/reranker/reranker

docs/source/API/inference/FlagAutoModel.rst

@@ -0,0 +1,9 @@
+FlagAutoModel
+=============
+
+.. autoclass:: FlagEmbedding.inference.FlagAutoModel
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.inference.FlagAutoModel.from_finetuned

docs/source/API/inference/FlagAutoReranker.rst

@@ -0,0 +1,9 @@
+FlagAutoReranker
+================
+
+.. autoclass:: FlagEmbedding.inference.FlagAutoReranker
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.inference.FlagAutoReranker.from_finetuned

docs/source/API/inference/embedder/decoder_only/BaseLLMEmbedder.rst

@@ -0,0 +1,15 @@
+BaseEmbedder
+============
+
+.. autoclass:: FlagEmbedding.inference.embedder.decoder_only.base.BaseLLMEmbedder
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.inference.embedder.decoder_only.base.BaseLLMEmbedder.encode_queries
+
+.. automethod:: FlagEmbedding.inference.embedder.decoder_only.base.BaseLLMEmbedder.encode_corpus
+
+.. automethod:: FlagEmbedding.inference.embedder.decoder_only.base.BaseLLMEmbedder.encode
+
+.. automethod:: FlagEmbedding.inference.embedder.decoder_only.base.BaseLLMEmbedder.encode_single_device

docs/source/API/inference/embedder/decoder_only/ICLLLMEmbedder.rst

@@ -0,0 +1,21 @@
+ICLLLMEmbedder
+==============
+
+.. autoclass:: FlagEmbedding.inference.embedder.decoder_only.icl.ICLLLMEmbedder
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.inference.embedder.decoder_only.icl.ICLLLMEmbedder.encode_queries
+
+.. automethod:: FlagEmbedding.inference.embedder.decoder_only.icl.ICLLLMEmbedder.encode_corpus
+
+.. automethod:: FlagEmbedding.inference.embedder.decoder_only.icl.ICLLLMEmbedder.encode
+
+.. automethod:: FlagEmbedding.inference.embedder.decoder_only.icl.ICLLLMEmbedder.set_examples
+
+.. automethod:: FlagEmbedding.inference.embedder.decoder_only.icl.ICLLLMEmbedder.get_detailed_example
+
+.. automethod:: FlagEmbedding.inference.embedder.decoder_only.icl.ICLLLMEmbedder.encode_queries_single_device
+
+.. automethod:: FlagEmbedding.inference.embedder.decoder_only.icl.ICLLLMEmbedder.encode_single_device

docs/source/API/inference/embedder/embedder.rst

@@ -0,0 +1,8 @@
+Embedder
+========
+
+.. toctree::
+    encoder_only/BaseEmbedder
+    encoder_only/M3Embedder
+    decoder_only/BaseLLMEmbedder
+    decoder_only/ICLLLMEmbedder

docs/source/API/inference/embedder/encoder_only/BaseEmbedder.rst

@@ -0,0 +1,18 @@
+BaseEmbedder
+============
+
+.. autoclass:: FlagEmbedding.inference.embedder.encoder_only.base.BaseEmbedder
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.base.BaseEmbedder.encode_queries
+    :no-index:
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.base.BaseEmbedder.encode_corpus
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.base.BaseEmbedder.encode
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.base.BaseEmbedder.encode_single_device
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.base.BaseEmbedder.pooling

docs/source/API/inference/embedder/encoder_only/M3Embedder.rst

@@ -0,0 +1,27 @@
+M3Embedder
+============
+
+.. autoclass:: FlagEmbedding.inference.embedder.encoder_only.m3.M3Embedder
+
+Methods
+-------
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.m3.M3Embedder.encode_queries
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.m3.M3Embedder.encode_corpus
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.m3.M3Embedder.encode
+    
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.m3.M3Embedder.convert_id_to_token
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.m3.M3Embedder.compute_lexical_matching_score
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.m3.M3Embedder.colbert_score
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.m3.M3Embedder.encode_single_device
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.m3.M3Embedder.compute_score
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.m3.M3Embedder.compute_score_multi_process
+
+.. automethod:: FlagEmbedding.inference.embedder.encoder_only.m3.M3Embedder.compute_score_single_device

docs/source/API/inference/reranker/decoder_only/BaseLLMReranker.rst

@@ -0,0 +1,9 @@
+BaseLLMReranker
+===============
+
+.. autoclass:: FlagEmbedding.inference.reranker.decoder_only.base.BaseLLMReranker
+
+Methods
+-------
+
+.. autoclass:: FlagEmbedding.inference.reranker.decoder_only.base.BaseLLMReranker.compute_score_single_gpu