chore: import upstream snapshot with attribution

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

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

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

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

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

docs/source/API/inference/reranker/encoder_only/BaseReranker.rst

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

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

@@ -0,0 +1,8 @@
+Reranker
+========
+
+.. toctree::
+    encoder_only/BaseReranker
+    decoder_only/BaseLLMReranker
+    decoder_only/LayerWiseLLMReranker
+    decoder_only/LightweightLLMReranker