From 3b5f646108b7481bcb5e64ef40b4c704ee5b04b0 Mon Sep 17 00:00:00 2001
From: bitnom <14287229+bitnom@users.noreply.github.com>
Date: Wed, 7 Aug 2024 14:49:02 -0400
Subject: [PATCH] fix default model directory naming conflict by rn routellm/
 to routellm-models/

---
 README.md           | 7 +++++++
 config.example.yaml | 6 +++---
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 45cbe52..560a91b 100644
--- a/README.md
+++ b/README.md
@@ -191,6 +191,13 @@ The configuration for routers is specified in either the `config` argument for `
 
 An example configuration is provided in the `config.example.yaml` file - it provides the configurations for routers that have trained on Arena data augmented using GPT-4 as a judge. The models and datasets used are all hosted on Hugging Face under the [RouteLLM](https://huggingface.co/routellm) and [LMSYS](https://huggingface.co/lmsys) organizations.
 
+The default model paths in the **config.example.yaml** may lead you to issue something like the following:
+
+```bash
+git lfs install
+git clone https://huggingface.co/routellm/mf_gpt4_augmented ./routellm-models/mf_gpt4_augmented
+```
+
 ## Contribution
 
 We welcome contributions! Please feel free to open an issue or a pull request if you have any suggestions or improvements.
diff --git a/config.example.yaml b/config.example.yaml
index 98c69a7..05537fb 100644
--- a/config.example.yaml
+++ b/config.example.yaml
@@ -6,8 +6,8 @@ sw_ranking:
       - routellm/arena_battles_embeddings
       - routellm/gpt4_judge_battles_embeddings
 causal_llm:
-    checkpoint_path: routellm/causal_llm_gpt4_augmented
+    checkpoint_path: routellm-models/causal_llm_gpt4_augmented
 bert:
-    checkpoint_path: routellm/bert_gpt4_augmented
+    checkpoint_path: routellm-models/bert_gpt4_augmented
 mf:
-    checkpoint_path: routellm/mf_gpt4_augmented
+    checkpoint_path: routellm-models/mf_gpt4_augmented