chore: update README and model name

umbertogriffo · Aug 1, 2024 · d1f1c02 · d1f1c02
1 parent 9d32434
commit d1f1c02
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -137,7 +137,7 @@ format.
 
 | 🤖 Model                                   | Supported | Model Size | Notes and link to the model                                                                                                                                          |
 |--------------------------------------------|-----------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `llama-3.1` Meta Llama 3.1 Instruct        | ✅         | 8B         | [link](https://huggingface.co/bartowski/Meta-Llama-3.1-8B-Instruct-GGUF)                                                                                             |
+| `llama-3` Meta Llama 3.1 Instruct          | ✅         | 8B         | [link](https://huggingface.co/bartowski/Meta-Llama-3.1-8B-Instruct-GGUF)                                                                                             |
 | `openchat-3.6` - OpenChat 3.6              | ✅         | 8B         | [link](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF)                                                                                               |
 | `openchat-3.5` - OpenChat 3.5              | ✅         | 7B         | **Recommended model** [link](https://huggingface.co/TheBloke/openchat-3.5-0106-GGUF)                                                                                 |
 | `starling` Starling Beta                   | ✅         | 7B         | Is trained from `Openchat-3.5-0106`. It's recommended if you prefer more verbosity over OpenChat - [link](https://huggingface.co/bartowski/Starling-LM-7B-beta-GGUF) |
@@ -151,9 +151,9 @@ format.
 
 | ✨ Response Synthesis strategy                                           | Supported | Notes |
 |-------------------------------------------------------------------------|-----------|-------|
-| `create_and_refine` Create and Refine                                   | ✅         |       |
-| `tree_summarization` Tree Summarization                                 | ✅         |       |
-| `async_tree_summarization` - **Recommended** - Async Tree Summarization | ✅         |       |
+| `create-and-refine` Create and Refine                                   | ✅         |       |
+| `tree-summarization` Tree Summarization                                 | ✅         |       |
+| `async-tree-summarization` - **Recommended** - Async Tree Summarization | ✅         |       |
 
 ## Example Data
 

diff --git a/chatbot/bot/model/model_settings.py b/chatbot/bot/model/model_settings.py
@@ -1,7 +1,7 @@
 from enum import Enum
 
 from bot.model.settings.dolphin import DolphinSettings
-from bot.model.settings.llama_3 import Llama31Settings
+from bot.model.settings.llama_3 import Llama3Settings
 from bot.model.settings.mistral import MistralSettings
 from bot.model.settings.openchat import OpenChat35Settings, OpenChat36Settings
 from bot.model.settings.phi_3 import PhiThreeSettings
@@ -19,7 +19,7 @@ class ModelType(Enum):
     OPENCHAT_3_6 = "openchat-3.6"
     STARLING = "starling"
     PHI_3 = "phi-3"
-    LLAMA_3_1 = "llama-3.1"
+    LLAMA_3 = "llama-3"
 
 
 SUPPORTED_MODELS = {
@@ -31,7 +31,7 @@ class ModelType(Enum):
     ModelType.OPENCHAT_3_6.value: OpenChat36Settings,
     ModelType.STARLING.value: StarlingSettings,
     ModelType.PHI_3.value: PhiThreeSettings,
-    ModelType.LLAMA_3_1.value: Llama31Settings,
+    ModelType.LLAMA_3.value: Llama3Settings,
 }
 
 

diff --git a/chatbot/bot/model/settings/llama_3.py b/chatbot/bot/model/settings/llama_3.py
@@ -2,7 +2,7 @@
 from bot.model.model import Model
 
 
-class Llama31Settings(Model):
+class Llama3Settings(Model):
     url = "https://huggingface.co/bartowski/Meta-Llama-3.1-8B-Instruct-GGUF/resolve/main/Meta-Llama-3.1-8B-Instruct-Q4_K_M.gguf"
     file_name = "Meta-Llama-3.1-8B-Instruct-Q4_K_M.gguf"
     clients = [LlmClientType.LAMA_CPP]