Update app.py

comments, bug fixes

app.py

@@ -3,25 +3,33 @@ import gradio as gr
 from huggingface_hub import InferenceClient
 import random
 
-# lists for random gen, not the best format here but it runs fine
-book_genres = ["Adventure", "Romance","Mystery", "Science Fiction","Fantasy","Thriller","Horror","Historical Fiction","Biography","Autobiography","Self-Help","Non-Fiction","Science","Cooking","Travel","Dystopian","Young Adult","Children's","Poetry","Classic","Graphic Novel","Humor","Crime","Western","Memoir","Religion","Psychology","Philosophy","Business","Finance","Parenting","Health","Fitness","Art","Music","Sports","Politics","Education","Technology","Science Fiction Fantasy","Steampunk","Drama","Historical Non-Fiction","Biographical Fiction","Mythology","Anthology","Short Stories","Essays","Fairy Tales","Magic Realism","True Crime","Satire","Romantic Suspense","Paranormal","Urban Fantasy","War","Epic Fantasy","Contemporary Fiction","Legal Thriller","Espionage","Post-Apocalyptic","Time Travel","Cultural","Medical","Environmental","Artificial Intelligence","Cyberpunk","Space Opera","Alternate History","Historical Romance","Science Fiction Romance","Young Adult Fantasy","Middle Grade","Adventure Fantasy","Superhero","Graphic Memoir","Travel Memoir","Political Thriller","Economic","Psychological Thriller","Nature","True Adventure","Historical Mystery","Social Science","Science Biography","Space Exploration","Pop Culture","Art History","Culinary","Nature Writing","Family Drama","Classic Literature","Cultural History","Political Science","Economics","Essays and Criticism","Art Criticism","Criminal Justice","Historical Biography","Personal Development","Cookbook","Fashion","Crafts and Hobbies","Memoir","Essays","Graphic Non-Fiction", "Fantasy Romance"]
+# lists for random gen, not the best format here but it runs fine, might add these as json or txt files later
+book_genres = ["Adventure", "Romance","Mystery", "Science Fiction","Fantasy","Thriller","Horror","Historical Fiction","Biography","Autobiography","Self-Help","Non-Fiction","Science","Cooking","Travel","Dystopian","Young Adult","Children's","Poetry","Classic","Graphic Novel","Humor","Crime","Western","Memoir","Religion","Psychology","Philosophy","Business","Finance","Parenting","Health","Fitness","Art","Music","Sports","Politics","Education","Technology","Science Fiction Fantasy","Steampunk","Drama","Historical Non-Fiction","Biographical Fiction","Mythology","Anthology","Short Stories","Essays","Fairy Tales","Magic Realism","True Crime","Satire","Romantic Suspense","Paranormal","Urban Fantasy","War","Epic Fantasy","Contemporary Fiction","Legal Thriller","Espionage","Post-Apocalyptic","Time Travel","Cultural","Medical","Environmental","Artificial Intelligence","Cyberpunk","Space Opera","Alternate History","Historical Romance","Science Fiction Romance","Young Adult Fantasy","Adventure Fantasy","Superhero","Graphic Memoir","Travel Memoir","Political Thriller","Economic","Psychological Thriller","Nature","True Adventure","Historical Mystery","Social Science","Science Biography","Space Exploration","Pop Culture","Art History","Culinary","Nature Writing","Family Drama","Classic Literature","Cultural History","Political Science","Economics","Essays and Criticism","Art Criticism","Criminal Justice","Historical Biography","Personal Development","Cookbook","Fashion","Crafts and Hobbies","Memoir","Essays","Graphic Non-Fiction", "Fantasy Romance"]
 book_themes = ["Love and Relationships","Friendship","Family","Coming of Age","Identity and Self-discovery","Adventure and Exploration","Mystery and Intrigue","Science and Technology","Fantasy Worlds","Historical Events","War and Conflict","Survival","Good vs. Evil","Justice and Morality","Revenge","Betrayal","Hope and Resilience","Isolation and Loneliness","Social Justice","Environmental Conservation","Political Corruption","Human Rights","Dystopia","Utopia","Alien Encounters","Time Travel","Art and Creativity","Death and Mortality","Cultural Identity","Personal Growth","Addiction","Education and Knowledge","Freedom and Liberation","Equality and Inequality","Society and Class","Legacy and Inheritance","Religion and Spirituality","Grief and Loss","Ambition","Transformation","Humor and Satire","Survival of the Fittest","Dreams and Aspirations","Change and Adaptation","Forgiveness","Nature and the Environment","Exploration of the Unknown","Conflict Resolution","Fate and Destiny","Artificial Intelligence","Cybersecurity","Space Exploration","Parallel Universes","Economic Struggles","Social Media and Technology","Innovation and Invention","Psychological Thrills","Philosophical Contemplation","Ancient Mythology","Modern Mythology","Epic Journeys","The Power of Imagination","Unrequited Love","Secrets and Hidden Truths","Warriors and Heroes","Surviving Adversity","Dreams and Nightmares","Rivalry and Competition","Alien Worlds","Conspiracy","Apocalyptic Scenarios","Conformity vs. Individuality","Legacy and Heritage","Nature vs. Nurture","Moral Dilemmas","Adventure and Discovery","Journey of Self-Discovery","Unlikely Friendships","Struggle for Power","Exploration of Fear","The Supernatural","Cultural Clashes","Identity Crisis","The Quest for Knowledge","The Human Condition","Hidden Agendas","Escapism","The Pursuit of Happiness","Redemption","Rebellion","Feminism and Gender Issues","Exploration of Dreams","Innocence vs. Experience","Chaos and Order","Exploration of Evil"]
 writing_tones = ["Formal","Informal","Humorous","Serious","Sarcastic","Satirical","Melancholic","Optimistic","Pessimistic","Cynical","Hopeful","Lighthearted","Dark","Gothic","Whimsical","Mysterious","Eerie","Solemn","Playful","Thoughtful","Reflective","Ironic","Sensual","Nostalgic","Surreal","Dreamy","Awe-Inspiring","Introspective","Confessional","Dramatic","Exuberant","Melodramatic","Hypnotic","Inspirational","Tongue-in-Cheek","Witty","Calm","Passionate","Detached","Frightening","Intense","Calm","Suspenseful","Brave","Desperate","Eloquent","Vivid","Casual","Whispering","Eloquent","Bitter","Tragic","Pensive","Frenzied","Melodious","Resolute","Soothing","Brisk","Lyrical","Objective","Factual","Contemplative","Sardonic","Sympathetic","Objective","Sincere","Wistful","Stoic","Empathetic","Matter-of-fact","Sentimental","Sharp","Understated","Exaggerated","Casual","Bombastic","Poetic","Charming","Apologetic","Defensive","Confrontational","Inquisitive","Candid","Reverent","Matter-of-fact","Amusing","Enthusiastic","Questioning","Reproachful","Hopeless","Despondent","Wry","Sulking","Serene","Detached","Confident","Steadfast","Foolish","Impassioned","Indignant","Self-Deprecating","Wandering","Inspiring","Bewildered"]
 
-
+# initialize client
 client = InferenceClient(
     "mistralai/Mixtral-8x7B-Instruct-v0.1"
 )
 
-def format_prompt(message, history, genres, moods, themes):
+# helper function to format the prompt appropriately. 
+# For this creative writing tool, the user doesn't design the prompt itself for rather genres, tones, & themes of a book to include
+def format_prompt(message, history, genres, tones, themes):
+    # pick random ones if user leaves it blank
+    # TODO: use NLP or somethign so that there aren't contrasting ideas in the same prompt (ex. western and cyberpunk genres or dark and lighthearted tones)
     if not genres:
         genres = ", ".join(random.sample(book_genres, random.randint(3, 5)))
-    if not moods:       
-        moods = ", ".join(random.sample(writing_tones, random.randint(3, 5)))
+    if not tones:       
+        tones = ", ".join(random.sample(writing_tones, random.randint(3, 5)))
     if not themes:
         themes = ", ".join(random.sample(book_themes, random.randint(3, 5)))
-    
-    prompt = f"Write a simple novel title and interesting summary for a book that falls under the following \n genres: {genres}, \n themes: {themes}, \n and moods: {moods}. \n Title:"
+
+    #BOS token
+    prompt = '<s>'
+    #prompt we are using for now
+    user_prompt = f"Write a novel title and a detailed, creative summary/synopsis for a book that falls under the following \n genres: {genres}, \n themes: {themes}, \n and tones: {tones}."
+    # create our prompt according to Mistral's guidelines
     for user_prompt, bot_response in history:
         prompt += f"[INST] {user_prompt} [/INST]"
         prompt += f" {bot_response}</s> "
@@ -29,9 +37,9 @@ def format_prompt(message, history, genres, moods, themes):
     return prompt
 
 
-
-def generate(genres, moods, themes, history,  system_prompt, temperature=1.25, max_new_tokens=256, top_p=0.95, repetition_penalty=1.15,):
- 
+# main function
+def generate(genres, themes, tones, history,  system_prompt, temperature=1.25, max_new_tokens=256, top_p=0.95, repetition_penalty=1.15,):
+    # check the temperature value, should not be too low, and make sure the values are floats
     temperature = float(temperature)
     if temperature < 1e-2:
         temperature = 1e-2
@@ -46,7 +54,7 @@ def generate(genres, moods, themes, history,  system_prompt, temperature=1.25, m
         seed=42,
     )
 
-    formatted_prompt = format_prompt(f"{system_prompt}, '' ", history, genres, moods, themes)
+    formatted_prompt = format_prompt(f"{system_prompt}, '' ", history, genres, tones, themes)
     stream = client.text_generation(formatted_prompt, **generate_kwargs, stream=True, details=True, return_full_text=False)
     output = ""
 
@@ -69,7 +77,7 @@ additional_inputs=[
         maximum=1.0,
         step=0.05,
         interactive=True,
-        info="Higher values produce more diverse outputs",
+        info="Higher values produce more diverse outputs but can cause loss of coherence",
     ),
     gr.Slider(
         label="Max new tokens",
@@ -78,7 +86,7 @@ additional_inputs=[
         maximum=1048,
         step=64,
         interactive=True,
-        info="The maximum numbers of new tokens",
+        info="The maximum numbers of new tokens (approx. wordcount) generated",
     ),
     gr.Slider(
         label="Top-p (nucleus sampling)",
@@ -96,7 +104,7 @@ additional_inputs=[
         maximum=2.0,
         step=0.05,
         interactive=True,
-        info="Penalize repeated tokens",
+        info="Penalize repeated tokens, encourages creativity",
     )
 ]
 
@@ -107,13 +115,11 @@ def launch_interface():
           gr.Textbox("", label="Book Genres (comma-separated, or leave blank!)"),
           gr.Textbox("", label="Book Themes (comma-separated, or leave blank!)"),
           gr.Textbox("", label="Writing Tone (comma-separated, or leave blank!)"),
-          gr.Slider(0.1, 10.0, 1.3, label="Temperature (Creativity)"),
       ],
     additional_inputs=additional_inputs,
     outputs="text",
     live=False,
     title="Novel Title and Summary Generator",
-    layout = 'panel'
     theme='ParityError/Interstellar',
   )