Skip to content

Commit

Permalink
deploy: ccbc178
Browse files Browse the repository at this point in the history
  • Loading branch information
ZiyiXia committed Nov 8, 2024
0 parents commit 311d305
Show file tree
Hide file tree
Showing 402 changed files with 111,580 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 31899dca82da6cb45546146b22ddc4c6
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/API/abc.doctree
Binary file not shown.
Binary file added .doctrees/API/abc/finetune.doctree
Binary file not shown.
Binary file added .doctrees/API/abc/finetune/embedder.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/API/abc/finetune/reranker.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/API/abc/inference.doctree
Binary file not shown.
Binary file added .doctrees/API/abc/inference/AbsEmbedder.doctree
Binary file not shown.
Binary file added .doctrees/API/abc/inference/AbsReranker.doctree
Binary file not shown.
Binary file added .doctrees/API/evaluation.doctree
Binary file not shown.
Binary file added .doctrees/API/finetune.doctree
Binary file not shown.
Binary file added .doctrees/API/finetune/embedder.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/API/finetune/reranker.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/API/inference.doctree
Binary file not shown.
Binary file added .doctrees/API/inference/FlagAutoModel.doctree
Binary file not shown.
Binary file added .doctrees/API/inference/FlagAutoReranker.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/API/inference/embedder/embedder.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/API/inference/reranker/reranker.doctree
Binary file not shown.
Binary file added .doctrees/C-MTEB.doctree
Binary file not shown.
Binary file added .doctrees/Introduction/installation.doctree
Binary file not shown.
Binary file added .doctrees/Introduction/quick_start.doctree
Binary file not shown.
Binary file added .doctrees/bge/bge_icl.doctree
Binary file not shown.
Binary file added .doctrees/bge/bge_m3.doctree
Binary file not shown.
Binary file added .doctrees/bge/bge_reranker.doctree
Binary file not shown.
Binary file added .doctrees/bge/bge_v1.doctree
Binary file not shown.
Binary file added .doctrees/bge/introduction.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/1_Embedding.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/1_Embedding/1.1.1.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/1_Embedding/1.2.1.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/1_Embedding/1.2.2.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/1_Embedding/1.2.3.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/2_Metrics.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/2_Metrics/2.1.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/2_Metrics/2.2.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/3_Indexing.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/3_Indexing/3.1.1.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/3_Indexing/3.1.2.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/3_Indexing/3.1.3.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/3_Indexing/3.1.4.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/3_Indexing/3.1.5.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/4_Evaluation.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/4_Evaluation/4.1.1.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/4_Evaluation/4.2.1.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/4_Evaluation/4.2.2.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/4_Evaluation/4.3.1.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/5_Reranking.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/5_Reranking/5.1.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/6_RAG.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/6_RAG/6.1.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/6_RAG/6.2.doctree
Binary file not shown.
Binary file added .doctrees/tutorial/6_RAG/6.3.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
696 changes: 696 additions & 0 deletions API/abc.html

Large diffs are not rendered by default.

656 changes: 656 additions & 0 deletions API/abc/finetune.html

Large diffs are not rendered by default.

573 changes: 573 additions & 0 deletions API/abc/finetune/embedder.html

Large diffs are not rendered by default.

504 changes: 504 additions & 0 deletions API/abc/finetune/embedder/AbsArguments.html

Large diffs are not rendered by default.

727 changes: 727 additions & 0 deletions API/abc/finetune/embedder/AbsDataset.html

Large diffs are not rendered by default.

726 changes: 726 additions & 0 deletions API/abc/finetune/embedder/AbsModeling.html

Large diffs are not rendered by default.

585 changes: 585 additions & 0 deletions API/abc/finetune/embedder/AbsRunner.html

Large diffs are not rendered by default.

537 changes: 537 additions & 0 deletions API/abc/finetune/embedder/AbsTrainer.html

Large diffs are not rendered by default.

553 changes: 553 additions & 0 deletions API/abc/finetune/reranker.html

Large diffs are not rendered by default.

504 changes: 504 additions & 0 deletions API/abc/finetune/reranker/AbsArguments.html

Large diffs are not rendered by default.

626 changes: 626 additions & 0 deletions API/abc/finetune/reranker/AbsDataset.html

Large diffs are not rendered by default.

617 changes: 617 additions & 0 deletions API/abc/finetune/reranker/AbsModeling.html

Large diffs are not rendered by default.

585 changes: 585 additions & 0 deletions API/abc/finetune/reranker/AbsRunner.html

Large diffs are not rendered by default.

537 changes: 537 additions & 0 deletions API/abc/finetune/reranker/AbsTrainer.html

Large diffs are not rendered by default.

510 changes: 510 additions & 0 deletions API/abc/inference.html

Large diffs are not rendered by default.

716 changes: 716 additions & 0 deletions API/abc/inference/AbsEmbedder.html

Large diffs are not rendered by default.

658 changes: 658 additions & 0 deletions API/abc/inference/AbsReranker.html

Large diffs are not rendered by default.

472 changes: 472 additions & 0 deletions API/evaluation.html

Large diffs are not rendered by default.

746 changes: 746 additions & 0 deletions API/finetune.html

Large diffs are not rendered by default.

647 changes: 647 additions & 0 deletions API/finetune/embedder.html

Large diffs are not rendered by default.

556 changes: 556 additions & 0 deletions API/finetune/embedder/decoder_only.html

Large diffs are not rendered by default.

501 changes: 501 additions & 0 deletions API/finetune/embedder/decoder_only/base.html

Large diffs are not rendered by default.

497 changes: 497 additions & 0 deletions API/finetune/embedder/decoder_only/base/arguments.html

Large diffs are not rendered by default.

530 changes: 530 additions & 0 deletions API/finetune/embedder/decoder_only/base/modeling.html

Large diffs are not rendered by default.

545 changes: 545 additions & 0 deletions API/finetune/embedder/decoder_only/base/runner.html

Large diffs are not rendered by default.

497 changes: 497 additions & 0 deletions API/finetune/embedder/decoder_only/base/trainer.html

Large diffs are not rendered by default.

525 changes: 525 additions & 0 deletions API/finetune/embedder/decoder_only/icl.html

Large diffs are not rendered by default.

504 changes: 504 additions & 0 deletions API/finetune/embedder/decoder_only/icl/arguments.html

Large diffs are not rendered by default.

557 changes: 557 additions & 0 deletions API/finetune/embedder/decoder_only/icl/dataset.html

Large diffs are not rendered by default.

649 changes: 649 additions & 0 deletions API/finetune/embedder/decoder_only/icl/modeling.html

Large diffs are not rendered by default.

563 changes: 563 additions & 0 deletions API/finetune/embedder/decoder_only/icl/runner.html

Large diffs are not rendered by default.

497 changes: 497 additions & 0 deletions API/finetune/embedder/decoder_only/icl/trainer.html

Large diffs are not rendered by default.

561 changes: 561 additions & 0 deletions API/finetune/embedder/encoder_only.html

Large diffs are not rendered by default.

503 changes: 503 additions & 0 deletions API/finetune/embedder/encoder_only/base.html

Large diffs are not rendered by default.

649 changes: 649 additions & 0 deletions API/finetune/embedder/encoder_only/base/modeling.html

Large diffs are not rendered by default.

529 changes: 529 additions & 0 deletions API/finetune/embedder/encoder_only/base/runner.html

Large diffs are not rendered by default.

497 changes: 497 additions & 0 deletions API/finetune/embedder/encoder_only/base/trainer.html

Large diffs are not rendered by default.

528 changes: 528 additions & 0 deletions API/finetune/embedder/encoder_only/m3.html

Large diffs are not rendered by default.

504 changes: 504 additions & 0 deletions API/finetune/embedder/encoder_only/m3/arguments.html

Large diffs are not rendered by default.

899 changes: 899 additions & 0 deletions API/finetune/embedder/encoder_only/m3/modeling.html

Large diffs are not rendered by default.

562 changes: 562 additions & 0 deletions API/finetune/embedder/encoder_only/m3/runner.html

Large diffs are not rendered by default.

497 changes: 497 additions & 0 deletions API/finetune/embedder/encoder_only/m3/trainer.html

Large diffs are not rendered by default.

569 changes: 569 additions & 0 deletions API/finetune/reranker.html

Large diffs are not rendered by default.

540 changes: 540 additions & 0 deletions API/finetune/reranker/decoder_only.html

Large diffs are not rendered by default.

508 changes: 508 additions & 0 deletions API/finetune/reranker/decoder_only/base.html

Large diffs are not rendered by default.

497 changes: 497 additions & 0 deletions API/finetune/reranker/decoder_only/base/arguments.html

Large diffs are not rendered by default.

649 changes: 649 additions & 0 deletions API/finetune/reranker/decoder_only/base/modeling.html

Large diffs are not rendered by default.

545 changes: 545 additions & 0 deletions API/finetune/reranker/decoder_only/base/runner.html

Large diffs are not rendered by default.

497 changes: 497 additions & 0 deletions API/finetune/reranker/decoder_only/base/trainer.html

Large diffs are not rendered by default.

502 changes: 502 additions & 0 deletions API/finetune/reranker/decoder_only/layerwise.html

Large diffs are not rendered by default.

497 changes: 497 additions & 0 deletions API/finetune/reranker/decoder_only/layerwise/arguments.html

Large diffs are not rendered by default.

546 changes: 546 additions & 0 deletions API/finetune/reranker/decoder_only/layerwise/modeling.html

Large diffs are not rendered by default.

545 changes: 545 additions & 0 deletions API/finetune/reranker/decoder_only/layerwise/runner.html

Large diffs are not rendered by default.

497 changes: 497 additions & 0 deletions API/finetune/reranker/decoder_only/layerwise/trainer.html

Large diffs are not rendered by default.

499 changes: 499 additions & 0 deletions API/finetune/reranker/encoder_only.html

Large diffs are not rendered by default.

496 changes: 496 additions & 0 deletions API/finetune/reranker/encoder_only/base.html

Large diffs are not rendered by default.

530 changes: 530 additions & 0 deletions API/finetune/reranker/encoder_only/base/modeling.html

Large diffs are not rendered by default.

529 changes: 529 additions & 0 deletions API/finetune/reranker/encoder_only/base/runner.html

Large diffs are not rendered by default.

497 changes: 497 additions & 0 deletions API/finetune/reranker/encoder_only/base/trainer.html

Large diffs are not rendered by default.

595 changes: 595 additions & 0 deletions API/inference.html

Large diffs are not rendered by default.

538 changes: 538 additions & 0 deletions API/inference/FlagAutoModel.html

Large diffs are not rendered by default.

531 changes: 531 additions & 0 deletions API/inference/FlagAutoReranker.html

Large diffs are not rendered by default.

631 changes: 631 additions & 0 deletions API/inference/embedder/decoder_only/BaseLLMEmbedder.html

Large diffs are not rendered by default.

694 changes: 694 additions & 0 deletions API/inference/embedder/decoder_only/ICLLLMEmbedder.html

Large diffs are not rendered by default.

541 changes: 541 additions & 0 deletions API/inference/embedder/embedder.html

Large diffs are not rendered by default.

655 changes: 655 additions & 0 deletions API/inference/embedder/encoder_only/BaseEmbedder.html

Large diffs are not rendered by default.

735 changes: 735 additions & 0 deletions API/inference/embedder/encoder_only/M3Embedder.html

Large diffs are not rendered by default.

560 changes: 560 additions & 0 deletions API/inference/reranker/decoder_only/BaseLLMReranker.html

Large diffs are not rendered by default.

562 changes: 562 additions & 0 deletions API/inference/reranker/decoder_only/LayerWiseLLMReranker.html

Large diffs are not rendered by default.

567 changes: 567 additions & 0 deletions API/inference/reranker/decoder_only/LightweightLLMReranker.html

Large diffs are not rendered by default.

549 changes: 549 additions & 0 deletions API/inference/reranker/encoder_only/BaseReranker.html

Large diffs are not rendered by default.

508 changes: 508 additions & 0 deletions API/inference/reranker/reranker.html

Large diffs are not rendered by default.

451 changes: 451 additions & 0 deletions C-MTEB.html

Large diffs are not rendered by default.

524 changes: 524 additions & 0 deletions Introduction/installation.html

Large diffs are not rendered by default.

751 changes: 751 additions & 0 deletions Introduction/quick_start.html

Large diffs are not rendered by default.

Binary file added _images/BAAI_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/bge_logo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
581 changes: 581 additions & 0 deletions _modules/FlagEmbedding/abc/finetune/embedder/AbsArguments.html

Large diffs are not rendered by default.

1,098 changes: 1,098 additions & 0 deletions _modules/FlagEmbedding/abc/finetune/embedder/AbsDataset.html

Large diffs are not rendered by default.

827 changes: 827 additions & 0 deletions _modules/FlagEmbedding/abc/finetune/embedder/AbsModeling.html

Large diffs are not rendered by default.

613 changes: 613 additions & 0 deletions _modules/FlagEmbedding/abc/finetune/embedder/AbsRunner.html

Large diffs are not rendered by default.

488 changes: 488 additions & 0 deletions _modules/FlagEmbedding/abc/finetune/embedder/AbsTrainer.html

Large diffs are not rendered by default.

581 changes: 581 additions & 0 deletions _modules/FlagEmbedding/abc/finetune/reranker/AbsArguments.html

Large diffs are not rendered by default.

866 changes: 866 additions & 0 deletions _modules/FlagEmbedding/abc/finetune/reranker/AbsDataset.html

Large diffs are not rendered by default.

604 changes: 604 additions & 0 deletions _modules/FlagEmbedding/abc/finetune/reranker/AbsModeling.html

Large diffs are not rendered by default.

606 changes: 606 additions & 0 deletions _modules/FlagEmbedding/abc/finetune/reranker/AbsRunner.html

Large diffs are not rendered by default.

488 changes: 488 additions & 0 deletions _modules/FlagEmbedding/abc/finetune/reranker/AbsTrainer.html

Large diffs are not rendered by default.

891 changes: 891 additions & 0 deletions _modules/FlagEmbedding/abc/inference/AbsEmbedder.html

Large diffs are not rendered by default.

808 changes: 808 additions & 0 deletions _modules/FlagEmbedding/abc/inference/AbsReranker.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

583 changes: 583 additions & 0 deletions _modules/FlagEmbedding/finetune/embedder/decoder_only/base/runner.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

744 changes: 744 additions & 0 deletions _modules/FlagEmbedding/finetune/embedder/decoder_only/icl/dataset.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

614 changes: 614 additions & 0 deletions _modules/FlagEmbedding/finetune/embedder/decoder_only/icl/runner.html

Large diffs are not rendered by default.

493 changes: 493 additions & 0 deletions _modules/FlagEmbedding/finetune/embedder/decoder_only/icl/trainer.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

537 changes: 537 additions & 0 deletions _modules/FlagEmbedding/finetune/embedder/encoder_only/base/runner.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,051 changes: 1,051 additions & 0 deletions _modules/FlagEmbedding/finetune/embedder/encoder_only/m3/modeling.html

Large diffs are not rendered by default.

618 changes: 618 additions & 0 deletions _modules/FlagEmbedding/finetune/embedder/encoder_only/m3/runner.html

Large diffs are not rendered by default.

492 changes: 492 additions & 0 deletions _modules/FlagEmbedding/finetune/embedder/encoder_only/m3/trainer.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

565 changes: 565 additions & 0 deletions _modules/FlagEmbedding/finetune/reranker/decoder_only/base/runner.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

528 changes: 528 additions & 0 deletions _modules/FlagEmbedding/finetune/reranker/encoder_only/base/runner.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

562 changes: 562 additions & 0 deletions _modules/FlagEmbedding/inference/auto_embedder.html

Large diffs are not rendered by default.

532 changes: 532 additions & 0 deletions _modules/FlagEmbedding/inference/auto_reranker.html

Large diffs are not rendered by default.

757 changes: 757 additions & 0 deletions _modules/FlagEmbedding/inference/embedder/decoder_only/base.html

Large diffs are not rendered by default.

1,011 changes: 1,011 additions & 0 deletions _modules/FlagEmbedding/inference/embedder/decoder_only/icl.html

Large diffs are not rendered by default.

767 changes: 767 additions & 0 deletions _modules/FlagEmbedding/inference/embedder/encoder_only/base.html

Large diffs are not rendered by default.

1,257 changes: 1,257 additions & 0 deletions _modules/FlagEmbedding/inference/embedder/encoder_only/m3.html

Large diffs are not rendered by default.

954 changes: 954 additions & 0 deletions _modules/FlagEmbedding/inference/reranker/decoder_only/base.html

Large diffs are not rendered by default.

827 changes: 827 additions & 0 deletions _modules/FlagEmbedding/inference/reranker/decoder_only/layerwise.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

642 changes: 642 additions & 0 deletions _modules/FlagEmbedding/inference/reranker/encoder_only/base.html

Large diffs are not rendered by default.

494 changes: 494 additions & 0 deletions _modules/index.html

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions _sources/API/abc.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Abstract Class
==============

.. toctree::
abc/inference
abc/finetune
6 changes: 6 additions & 0 deletions _sources/API/abc/finetune.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Finetune
========

.. toctree::
finetune/embedder
finetune/reranker
9 changes: 9 additions & 0 deletions _sources/API/abc/finetune/embedder.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Embedder
========

.. toctree::
embedder/AbsArguments
embedder/AbsDataset
embedder/AbsModeling
embedder/AbsTrainer
embedder/AbsRunner
6 changes: 6 additions & 0 deletions _sources/API/abc/finetune/embedder/AbsArguments.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
AbsArguments
============

.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerModelArguments

.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerDataArguments
53 changes: 53 additions & 0 deletions _sources/API/abc/finetune/embedder/AbsDataset.rst.txt
Original file line number Diff line number Diff line change
@@ -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
41 changes: 41 additions & 0 deletions _sources/API/abc/finetune/embedder/AbsModeling.rst.txt
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions _sources/API/abc/finetune/embedder/AbsRunner.rst.txt
Original file line number Diff line number Diff line change
@@ -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
13 changes: 13 additions & 0 deletions _sources/API/abc/finetune/embedder/AbsTrainer.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
==========
AbsTrainer
==========

AbsEmbedderTrainer
==================

.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderTrainer

Methods
-------

.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderTrainer.compute_loss
9 changes: 9 additions & 0 deletions _sources/API/abc/finetune/reranker.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Reranker
========

.. toctree::
reranker/AbsArguments
reranker/AbsDataset
reranker/AbsModeling
reranker/AbsTrainer
reranker/AbsRunner
6 changes: 6 additions & 0 deletions _sources/API/abc/finetune/reranker/AbsArguments.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
AbsArguments
============

.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderModelArguments

.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderDataArguments
32 changes: 32 additions & 0 deletions _sources/API/abc/finetune/reranker/AbsDataset.rst.txt
Original file line number Diff line number Diff line change
@@ -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
31 changes: 31 additions & 0 deletions _sources/API/abc/finetune/reranker/AbsModeling.rst.txt
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions _sources/API/abc/finetune/reranker/AbsRunner.rst.txt
Original file line number Diff line number Diff line change
@@ -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
13 changes: 13 additions & 0 deletions _sources/API/abc/finetune/reranker/AbsTrainer.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
==========
AbsTrainer
==========

AbsRerankerTrainer
==================

.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerTrainer

Methods
-------

.. automethod:: FlagEmbedding.abc.finetune.reranker.AbsRerankerTrainer.compute_loss
6 changes: 6 additions & 0 deletions _sources/API/abc/inference.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Inference
=========

.. toctree::
inference/AbsEmbedder
inference/AbsReranker
29 changes: 29 additions & 0 deletions _sources/API/abc/inference/AbsEmbedder.rst.txt
Original file line number Diff line number Diff line change
@@ -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
25 changes: 25 additions & 0 deletions _sources/API/abc/inference/AbsReranker.rst.txt
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions _sources/API/evaluation.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Evaluation
==========
6 changes: 6 additions & 0 deletions _sources/API/finetune.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Finetune
========

.. toctree::
finetune/embedder
finetune/reranker
6 changes: 6 additions & 0 deletions _sources/API/finetune/embedder.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Embedder
========

.. toctree::
embedder/encoder_only
embedder/decoder_only
6 changes: 6 additions & 0 deletions _sources/API/finetune/embedder/decoder_only.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Decoder Only
============

.. toctree::
decoder_only/base
decoder_only/icl
Loading

0 comments on commit 311d305

Please sign in to comment.