update docs

FlagOpen · Jan 2, 2025 · a995448 · a995448
1 parent c81bf51
commit a995448
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 12 deletions.
diff --git a/docs/source/_static/img/bge-logo.jpeg b/docs/source/_static/img/bge-logo.jpeg
diff --git a/docs/source/bge/bge_reranker_v2.rst b/docs/source/bge/bge_reranker_v2.rst
@@ -14,7 +14,7 @@ BGE-Reranker-v2
 +------------------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 
-.. tip:: Suggessions on model selection
+.. tip::
 
     You can select the model according your senario and resource:
 
@@ -28,7 +28,9 @@ BGE-Reranker-v2
 Usage
 -----
 
-Use bge-reranker-v2-m3 in the same way as bge-reranker-base and bge-reranker-large.
+**bge-reranker-v2-m3**
+
+Use :code:`bge-reranker-v2-m3` in the same way as bge-reranker-base and bge-reranker-large.
 
 .. code:: python
 
@@ -43,6 +45,8 @@ Use bge-reranker-v2-m3 in the same way as bge-reranker-base and bge-reranker-lar
 
     print(score)
 
+**bge-reranker-v2-gemma**
+
 Use the :code:`FlagLLMReranker` class for bge-reranker-v2-gemma.
 
 .. code:: python
@@ -55,6 +59,8 @@ Use the :code:`FlagLLMReranker` class for bge-reranker-v2-gemma.
     score = reranker.compute_score(['query', 'passage'])
     print(score)
 
+**bge-reranker-v2-minicpm-layerwise**
+
 Use the :code:`LayerWiseFlagLLMReranker` class for bge-reranker-v2-minicpm-layerwise.
 
 .. code:: python
@@ -68,6 +74,8 @@ Use the :code:`LayerWiseFlagLLMReranker` class for bge-reranker-v2-minicpm-layer
     score = reranker.compute_score(['query', 'passage'], cutoff_layers=[28]) 
     print(score)
 
+**bge-reranker-v2.5-gemma2-lightweight**
+
 Use the :code:`LightWeightFlagLLMReranker` class for bge-reranker-v2.5-gemma2-lightweight.
 
 .. code:: python

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -36,20 +36,17 @@
 
 # html_theme = 'furo'
 html_theme = "pydata_sphinx_theme"
-# html_logo = "_static/img/BAAI_logo.png"
+html_logo = "_static/img/bge-logo.jpeg"
 html_title = "BGE"
 html_static_path = ['_static']
 html_css_files = ["css/custom.css"]
 html_theme_options = {
-#     # "light_logo": "/_static/img/BAAI_logo.png",
-#     "light_css_variables": {
-#         "color-brand-primary": "#238be8",
-#         "color-brand-content": "#238be8",
-#     },
-#     "dark_css_variables": {
-#         "color-brand-primary": "#FBCB67",
-#         "color-brand-content": "#FBCB67",
-#     },
+    "light_logo": "_static/img/bge-logo.jpeg",
+    "dark_logo": "_static/img/bge-logo.jpeg",
+    # "logo": {
+    #     "text": "BGE",
+    #     "image_dark": "_static/img/bge-logo.jpeg",
+    # },
     "navigation_depth": 5,
 }