DOC: Embedding models (#421)

README.md

@@ -26,6 +26,7 @@ potential of cutting-edge AI models.
 
 ## 🔥 Hot Topics
 ### Framework Enhancements
+- Embedding model support: [#418](https://github.com/xorbitsai/inference/pull/418)
 - Custom model support: [#325](https://github.com/xorbitsai/inference/pull/325)
 - LoRA support: [#271](https://github.com/xorbitsai/inference/issues/271)
 - Multi-GPU support for PyTorch models: [#226](https://github.com/xorbitsai/inference/issues/226)

doc/source/models/builtin/bge-base-en.rst

@@ -0,0 +1,22 @@
+.. _models_builtin_bge_base_en:
+
+===========
+bge-base-en
+===========
+
+- **Model Name:** bge-base-en
+- **Languages:** en
+- **Abilities:** embed
+
+Specifications
+^^^^^^^^^^^^^^
+
+- **Dimensions:** 768
+- **Max Tokens:** 512
+- **Model ID:** BAAI/bge-base-en
+
+Execute the following command to launch the model::
+
+   xinference launch --model-name bge-base-en --model-type embedding
+
+

doc/source/models/builtin/bge-base-zh.rst

@@ -0,0 +1,21 @@
+.. _models_builtin_bge_base_zh:
+
+===========
+bge-base-zh
+===========
+
+- **Model Name:** bge-base-zh
+- **Languages:** zh
+- **Abilities:** embed
+
+Specifications
+^^^^^^^^^^^^^^
+
+- **Dimensions:** 1024
+- **Max Tokens:** 512
+- **Model ID:** BAAI/bge-base-zh
+
+Execute the following command to launch the model::
+
+   xinference launch --model-name bge-base-zh --model-type embedding
+

doc/source/models/builtin/bge-large-en.rst

@@ -0,0 +1,21 @@
+.. _models_builtin_bge_large_en:
+
+============
+bge-large-en
+============
+
+- **Model Name:** bge-large-en
+- **Languages:** en
+- **Abilities:** embed
+
+Specifications
+^^^^^^^^^^^^^^
+
+- **Dimensions:** 1024
+- **Max Tokens:** 512
+- **Model ID:** BAAI/bge-large-en
+
+Execute the following command to launch the model::
+
+   xinference launch --model-name bge-large-en --model-type embedding
+

doc/source/models/builtin/bge-large-zh-noinstruct.rst

@@ -0,0 +1,21 @@
+.. _models_builtin_bge_large_zh_noinstruct:
+
+=======================
+bge-large-zh-noinstruct
+=======================
+
+- **Model Name:** bge-large-zh-noinstruct
+- **Languages:** zh
+- **Abilities:** embed
+
+Specifications
+^^^^^^^^^^^^^^
+
+- **Dimensions:** 1024
+- **Max Tokens:** 512
+- **Model ID:** BAAI/bge-large-zh-noinstruct
+
+Execute the following command to launch the model::
+
+   xinference launch --model-name bge-large-zh-noinstruct --model-type embedding
+

doc/source/models/builtin/bge-large-zh.rst

@@ -0,0 +1,21 @@
+.. _models_builtin_bge_large_zh:
+
+============
+bge-large-en
+============
+
+- **Model Name:** bge-large-zh
+- **Languages:** zh
+- **Abilities:** embed
+
+Specifications
+^^^^^^^^^^^^^^
+
+- **Dimensions:** 1024
+- **Max Tokens:** 512
+- **Model ID:** BAAI/bge-large-zh
+
+Execute the following command to launch the model::
+
+   xinference launch --model-name bge-large-zh --model-type embedding
+

doc/source/models/builtin/bge-small-zh.rst

@@ -0,0 +1,21 @@
+.. _models_builtin_bge_small_zh:
+
+============
+bge-large-en
+============
+
+- **Model Name:** bge_small_zh
+- **Languages:** zh
+- **Abilities:** embed
+
+Specifications
+^^^^^^^^^^^^^^
+
+- **Dimensions:** 512
+- **Max Tokens:** 512
+- **Model ID:** BAAI/bge_small_zh
+
+Execute the following command to launch the model::
+
+   xinference launch --model-name bge_small_zh --model-type embedding
+

doc/source/models/builtin/e5-large-v2.rst

@@ -0,0 +1,21 @@
+.. _models_builtin_e5_large_v2:
+
+=========
+gte-large
+=========
+
+- **Model Name:** e5-large-v2
+- **Languages:** en
+- **Abilities:** embed
+
+Specifications
+^^^^^^^^^^^^^^
+
+- **Dimensions:** 1024
+- **Max Tokens:** 512
+- **Model ID:** intfloat/e5-large-v2
+
+Execute the following command to launch the model::
+
+   xinference launch --model-name e5-large-v2 --model-type embedding
+

doc/source/models/builtin/gte-base.rst

@@ -0,0 +1,21 @@
+.. _models_builtin_gte_base:
+
+========
+gte-base
+========
+
+- **Model Name:** gte-base
+- **Languages:** en
+- **Abilities:** embed
+
+Specifications
+^^^^^^^^^^^^^^
+
+- **Dimensions:** 768
+- **Max Tokens:** 512
+- **Model ID:** thenlper/gte-large
+
+Execute the following command to launch the model::
+
+   xinference launch --model-name gte-base --model-type embedding
+

doc/source/models/builtin/gte-large.rst

@@ -0,0 +1,21 @@
+.. _models_builtin_gte_large:
+
+=========
+gte-large
+=========
+
+- **Model Name:** gte-large
+- **Languages:** en
+- **Abilities:** embed
+
+Specifications
+^^^^^^^^^^^^^^
+
+- **Dimensions:** 1024
+- **Max Tokens:** 512
+- **Model ID:** thenlper/gte-large
+
+Execute the following command to launch the model::
+
+   xinference launch --model-name gte-large --model-type embedding
+

doc/source/models/builtin/index.rst

@@ -86,3 +86,41 @@ Code Assistant Models
    vicuna-v1.5-16k
    wizardlm-v1.0
    wizardmath-v1.0
+
+
+Embedding Models
+^^^^^^^^^^^^^^^^^^^^^
+
+Language: English
+++++++++++++++++++++++
+- :ref:`bge-large-en <models_builtin_bge_large_en>`
+- :ref:`bge-base-en <models_builtin_bge_base_en>`
+- :ref:`gte-large <models_builtin_gte_large>`
+- :ref:`gte-base <models_builtin_gte_base>`
+- :ref:`e5-large-v2 <models_builtin_e5_large_v2>`
+
+
+Language: Chinese
++++++++++++++++++++++
+- :ref:`bge-large-zh <models_builtin_bge_large_zh>`
+- :ref:`bge-large-zh-noinstruct <models_builtin_bge_large_zh_noinstruct>`
+- :ref:`bge-base-zh <models_builtin_bge_base_zh>`
+- :ref:`multilingual-e5-large <models_builtin_multilingual_e5_large>`
+- :ref:`bge-small-zh <models_builtin_bge_small_zh>`
+
+
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   bge-large-en
+   bge-base-en
+   gte-large
+   gte-base
+   e5-large-v2
+   bge-large-zh
+   bge-large-zh-noinstruct
+   bge-base-zh
+   multilingual-e5-large
+   bge-small-zh

doc/source/models/builtin/multilingual-e5-large.rst

@@ -0,0 +1,21 @@
+.. _models_builtin_multilingual_e5_large:
+
+===========
+bge-base-zh
+===========
+
+- **Model Name:** multilingual-e5-large
+- **Languages:** zh
+- **Abilities:** embed
+
+Specifications
+^^^^^^^^^^^^^^
+
+- **Dimensions:** 1024
+- **Max Tokens:** 512
+- **Model ID:** intfloat/multilingual-e5-large
+
+Execute the following command to launch the model::
+
+   xinference launch --model-name multilingual-e5-large --model-type embedding
+