add README

README.md

@@ -10,4 +10,10 @@ pinned: false
 license: mit
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+Codenames is a word association game where two teams guess secret words based on one-word clues. The game involves a 25-word grid, with each team identifying their words while avoiding the opposing team's words and the "assassin" word. This space uses Google's `gemini-1.5-flash` model to analyze the game board, provide relevant clues, and assist players in making informed guesses. I was largely successful in getting this to work along with few surprises and learnings along the way.
+ 
+
+## Requirements
+
+export GOOGLE_API_KEY=<YOUR_GOOGLE_API_KEY>
+

app.py

@@ -102,8 +102,8 @@ def group_words(words):
     '''
 
     grouping_system_prompt = ("You are an assistant for the game Codenames. Your task is to help players by grouping a "
-                              "given group of secrets into 3 to 4 groups. Each group should consist of secrets that "
-                              "share a common theme or other word connections such as homonym, hypernyms or synonyms")
+                              "given group of secrets into 3 to 4 groups of 2 to 4 words. Each group should consist of secrets that "
+                              "share a common theme or other word connections such as homonym, hypernyms or synonyms. Avoid clues that are not too generic or not unique enough to be guessed easily")
 
     prompt = render_jinja2_template(template, grouping_system_prompt, example_groupings, words)
     # print(prompt)
@@ -138,7 +138,7 @@ def generate_clues(group):
     '''
 
     clue_system_prompt = ("You are a codenames game companion. Your task is to give a single word clue related to "
-                          "a given group of words. You will only respond with a single word clue.")
+                          "a given group of words. You will only respond with a single word clue. The clue can be a common theme or other word connections such as homonym, hypernyms or synonyms. Avoid clues that are not too generic or not unique enough to be guessed easily")
 
     prompt = render_jinja2_template(template, clue_system_prompt, example_clues, group)
 
@@ -172,11 +172,8 @@ with gr.Blocks() as demo:
 
     with gr.Row():
         game_image = gr.Image(type="pil")
-        word_list_input = gr.Dropdown(label="Enter list of words (comma separated)",
-                                      choices='WEREWOLF, CHAIN, MOSQUITO, CRAFT, RANCH, LIP, VALENTINE, CLOUD, '
-                                              'BEARD, BUNK, SECOND, SADDLE, BUCKET, JAIL, ANT, POCKET, LACE, '
-                                              'BREAK, CUCKOO, FLAT, NIL, TIN, CHERRY, CHRISTMAS, MOSES, '
-                                              'TEAM'.split(', '),
+        word_list_input = gr.Dropdown(label="Detected words",
+                                      choices=[],
                                       multiselect=True,
                                       interactive=True)