Houskeeping (#6)

* Add google API key example. * Update required Poetry elements. * Enable openai's gpt 4o mini * Updating reference to gpt4o * Removing falcon7b as standard because the api now returns an error. * Updating to use gpt4o (mini) --------- Co-authored-by: Erik Oosterop <[email protected]>
EJOOSTEROP · Jul 31, 2024 · 7e12aa4 · 7e12aa4
1 parent 79268a6
commit 7e12aa4
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 8 deletions.
diff --git a/.env.example b/.env.example
@@ -1,4 +1,5 @@
 OPENAI_API_KEY = "YOUR-KEY"
 HUGGINGFACEHUB_API_TOKEN = "YOUR-KEY"
 COHERE_API_KEY = "YOUR-KEY"
-REPLICATE_API_TOKEN = "YOUR-KEY"
+REPLICATE_API_TOKEN = "YOUR-KEY"
+GOOGLE_API_KEY = "YOUR-KEY"
diff --git a/README.md b/README.md
@@ -198,7 +198,7 @@ poetry run quke +experiment=openai
 ```
 uses an experiment file openai.yaml (see folder ./config/experiments) which specifies the LLM, embedding and questions to be used. It is equivalent to running:
 ```sh
-poetry run quke embedding=openai llm=gpt3-5 question=eps
+poetry run quke embedding=openai llm=gpt4o question=eps
 ```
 Multiple experiments can be run at once as follows:
 
@@ -256,6 +256,7 @@ The tool shares no information with me.
 * [![OpenAI][openai.com]][openai-url]
 * [![Replicate][replicate.com]][replicate-url]
 <br></br>
+
 * [![Hydra][hydra.com]][hydra-url]
 * [![LangChain][langchain.com]][langchain-url]
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -6,9 +6,9 @@ authors = ["Erik Oosterop"]
 maintainers = ["Erik Oosterop"]
 license = "MIT"
 readme = "README.md"
-homepage = ""
+homepage = "https://github.com/EJOOSTEROP/quke"
 repository = "https://github.com/EJOOSTEROP/quke"
-documentation = ""
+documentation = "https://github.com/EJOOSTEROP/quke"
 keywords = ["ML", "LLM", "compare", "chat", "semantic search"]
 
 

diff --git a/quke/conf/config.yaml b/quke/conf/config.yaml
@@ -6,7 +6,7 @@ embed_only: False
 
 defaults:
   - _self_
-  - llm: falcon7b
+  - llm: cohere
   - embedding: huggingface
   - question: eps
 

diff --git a/quke/conf/experiment/openai.yaml b/quke/conf/experiment/openai.yaml
@@ -1,5 +1,5 @@
 # @package _global_
 defaults:
-  - override /llm: gpt3-5
+  - override /llm: gpt4o
   - override /embedding: openai
   - override /question: eps
diff --git a/quke/conf/experiment/openaihf.yaml b/quke/conf/experiment/openaihf.yaml
@@ -1,5 +1,5 @@
 # @package _global_
 defaults:
-  - override /llm: gpt3-5
+  - override /llm: gpt4o
   - override /embedding: huggingface
   - override /question: eps
diff --git a/quke/conf/llm/gpt3-5.yaml → quke/conf/llm/gpt4o.yaml b/quke/conf/llm/gpt3-5.yaml → quke/conf/llm/gpt4o.yaml
@@ -1,7 +1,7 @@
 #type: OpenAI #import OpenAI maybe needed to set the API key, though langchain may just take it from env?
 module_name_llm: langchain.chat_models
 class_name_llm: ChatOpenAI
-name: gpt-3.5-turbo-0301
+name: gpt-4o-mini
 
 llm_args:
   model_name: ${llm.name}