renamed the variables in context file

pages/2_Context-based_chatbot.py

@@ -14,13 +14,13 @@ from nltk.corpus import wordnet as wn
 from nltk.tokenize import word_tokenize
 
 @st.cache_resource
-def get_models(llama=False):
+def get_models_context(llama=False):
   st.write('Loading the model...')
   model = pipeline("fill-mask")
   st.write("_The assistant is loaded and ready to use! :tada:_")
   return model 
 
-model = get_models()
+model_context = get_models_context()
 
 def remove_punctuation(word):
     # Create a translation table that maps all punctuation characters to None
@@ -31,7 +31,7 @@ def remove_punctuation(word):
     
     return word_without_punctuation
 
-def return_top_k(sentence, word=None, rels=False):
+def return_top_k_context(sentence, word=None, rels=False):
 
   if sentence[-1] != ".":
     sentence = sentence + "."
@@ -41,7 +41,7 @@ def return_top_k(sentence, word=None, rels=False):
 #   else:
 #     inputs = [f"Description : {sentence} Word : "]
     
-  output = model(sentence) 
+  output = model_context(sentence) 
   output = [output[i]['token_str'].strip() for i in range(len(output))]
   return output
 
@@ -72,7 +72,7 @@ def return_top_k(sentence, word=None, rels=False):
       
     #   return ", ".join(beam_preds[:num])
 
-#if 'messages' not in st.session_state:
+#if 'messages_context' not in st.session_state:
 
 def get_text():
   input_text = st.chat_input()
@@ -92,9 +92,9 @@ def write_bot(input, remember=True, blink=True):
         time.sleep(0.5)
       message_placeholder.markdown(full_response)
     if remember == True:
-      st.session_state.messages.append({'role': 'assistant', 'content': full_response})
+      st.session_state.messages_context.append({'role': 'assistant', 'content': full_response})
     
-def ask_if_helped():
+def ask_if_helped_context():
   y = st.button('Yes!', key=60)
   n = st.button('No...', key=61)
   new = st.button('I have a new word', key=62)
@@ -103,22 +103,22 @@ def ask_if_helped():
     again = st.button('Play again')
     if again:
       write_bot("Please describe your word!")
-    st.session_state.is_helpful['ask'] = False
+    st.session_state.is_helpful_context['ask'] = False
   elif n:
-    st.session_state.actions.append('cue')
-    st.session_state.is_helpful['ask'] = False
+    st.session_state.actions_context.append('cue')
+    st.session_state.is_helpful_context['ask'] = False
     #cue_generation()
   elif new:
     write_bot("Please describe your word!")
-    st.session_state.is_helpful['ask'] = False
+    st.session_state.is_helpful_context['ask'] = False
 
-## removed: if st.session_state.actions[-1] == "result":
+## removed: if st.session_state.actions_context[-1] == "result":
 
 # JS
 # def get_related_words_llama(relation, target, device, num=5):
-#     prompt = f"Provide {num} {relation}s for the word '{target}'. Your answer consists of these {num} words only. Do not include the word '{target}' itself in your answer"
+#     prompt_context = f"Provide {num} {relation}s for the word '{target}'. Your answer consists of these {num} words only. Do not include the word '{target}' itself in your answer"
 
-#     inputs = tokenizer([prompt], return_tensors='pt').to(device)
+#     inputs = tokenizer([prompt_context], return_tensors='pt').to(device)
 #     output = model.generate(
 #         **inputs, max_new_tokens=40, temperature=.75, early_stopping=True, 
 #         )
@@ -172,25 +172,25 @@ def get_available_cues(target):
 
 # JS: moved the cue generation further down
 #def cue_generation():
- # if st.session_state.actions[-1] == 'cue':
+ # if st.session_state.actions_context[-1] == 'cue':
 
-if 'messages' not in st.session_state:
-  st.session_state.messages = []
+if 'messages_context' not in st.session_state:
+  st.session_state.messages_context = []
   
-if 'results' not in st.session_state:
-  st.session_state.results = {'results': False, 'results_print': False}
+if 'results_context' not in st.session_state:
+  st.session_state.results_context = {'results_context': False, 'results_context_print': False}
   
-if 'actions' not in st.session_state:
-  st.session_state.actions = [""]
+if 'actions_context' not in st.session_state:
+  st.session_state.actions_context = [""]
   
-if 'counters' not in st.session_state:
-  st.session_state.counters = {"letter_count": 0, "word_count": 0}
+if 'counter_context' not in st.session_state:
+  st.session_state.counter_context = {"letter_count": 0, "word_count": 0}
   
-if 'is_helpful' not in st.session_state:
-  st.session_state.is_helpful = {'ask':False}
+if 'is_helpful_context' not in st.session_state:
+  st.session_state.is_helpful_context = {'ask':False}
   
-if 'descriptions' not in st.session_state:
-  st.session_state.descriptions = []
+if 'descriptions_context' not in st.session_state:
+  st.session_state.descriptions_context = []
   
 st.title("You name it! 🗣")
 
@@ -201,8 +201,8 @@ with st.chat_message('user'):
 bot = st.chat_message('assistant')
 bot.write("Hello human! Wanna practice naming some words?")
 
-#for showing history of messages
-for message in st.session_state.messages:
+#for showing history of messages_context
+for message in st.session_state.messages_context:
   if message['role'] == 'user':
     with st.chat_message(message['role']):
       st.markdown(message['content'])
@@ -211,61 +211,62 @@ for message in st.session_state.messages:
       st.markdown(message['content'])
   
 #display user message in chat message container
-prompt = get_text() 
-if prompt:
+prompt_context = get_text() 
+if prompt_context:
   #JS: would replace Simon by some neutral character 
   with st.chat_message('user'):
-    st.markdown(prompt)
+    st.markdown(prompt_context)
   #add to history
-  st.session_state.messages.append({'role': 'user', 'content': prompt})
+  st.session_state.messages_context.append({'role': 'user', 'content': prompt_context})
   #TODO: replace it with zero-shot classifier
   yes = ['yes', 'again', 'Yes', 'sure', 'new word', 'yes!', 'yep', 'yeah']
-  if prompt in yes:
+  if prompt_context in yes:
     write_bot("Please give a sentence using a <mask> instead of the word you have in mind!")
-  elif prompt == 'it is similar to the best place on earth':
+  elif prompt_context == 'it is similar to the best place on earth':
     write_bot("Great! Let me think what it could be...")
     time.sleep(3)
     write_bot("Do you mean Saarland?")
-  #if previously we asked to give a prompt
-  elif (st.session_state.messages[-2]['content'] == "Please give a sentence using a <mask> instead of the word you have in mind!") & (st.session_state.messages[-1]['content'] != "no"):
+  #if previously we asked to give a prompt_context
+  elif (st.session_state.messages_context[-2]['content'] == "Please give a sentence using a <mask> instead of the word you have in mind!") & (st.session_state.messages_context[-1]['content'] != "no"):
     write_bot("Great! Let me think what it could be...")
-    st.session_state.descriptions.append(prompt)
-    st.session_state.results['results'] = return_top_k(st.session_state.descriptions[-1])
-    st.session_state.results['results_print'] = dict(zip(range(1, 11), st.session_state.results['results']))
+    st.session_state.descriptions_context.append(prompt_context)
+    st.session_state.results_context['results_context'] = return_top_k_context
+    (st.session_state.descriptions_context[-1])
+    st.session_state.results_context['results_context_print'] = dict(zip(range(1, 11), st.session_state.results_context['results_context']))
     write_bot("I think I have some ideas. Do you want to see my guesses or do you want a cue?")
-    st.session_state.actions.append("result")
+    st.session_state.actions_context.append("result")
   
-if st.session_state.actions[-1] == "result":
+if st.session_state.actions_context[-1] == "result":
   col1, col2, col3, col4, col5 = st.columns(5)
   with col1:
-    a1 = st.button('Results', key=10)
+    a1 = st.button('results_context', key=10)
   with col2:
     a2 = st.button('Cue', key=11)
   if a1:
     write_bot("Here are my guesses about your word:")
-    st.write(st.session_state.results['results_print'])
+    st.write(st.session_state.results_context['results_context_print'])
     time.sleep(1)
     write_bot('Does it help you remember the word?', remember=False)
-    st.session_state.is_helpful['ask'] = True
+    st.session_state.is_helpful_context['ask'] = True
   elif a2:
-    #write_bot(f'The first letter is {st.session_state.results["results"][0][0]}.')
+    #write_bot(f'The first letter is {st.session_state.results_context["results_context"][0][0]}.')
     #time.sleep(1)
-    st.session_state.actions.append('cue')
+    st.session_state.actions_context.append('cue')
     #cue_generation()
     #write_bot('Does it help you remember the word?', remember=False)
-    #st.session_state.is_helpful['ask'] = True
+    #st.session_state.is_helpful_context['ask'] = True
     
-if st.session_state.is_helpful['ask']:
-    ask_if_helped()
+if st.session_state.is_helpful_context['ask']:
+    ask_if_helped_context()
 
-if st.session_state.actions[-1] == 'cue':
+if st.session_state.actions_context[-1] == 'cue':
   guessed = False
   write_bot('What do you want to see?', remember=False, blink=False)
 
   while guessed == False:
     # JS
-    word_count = st.session_state.counters["word_count"]
-    target = st.session_state.results["results"][word_count]
+    word_count = st.session_state.counter_context["word_count"]
+    target = st.session_state.results_context["results_context"][word_count]
     
     col1, col2, col3, col4, col5 = st.columns(5)
   
@@ -289,38 +290,38 @@ if st.session_state.actions[-1] == 'cue':
     new = st.button('Play again', key=64, type='primary')
 
     if b1:
-      st.session_state.counters["letter_count"] += 1
-      #word_count = st.session_state.counters["word_count"]
-      letter_count = st.session_state.counters["letter_count"]
+      st.session_state.counter_context["letter_count"] += 1
+      #word_count = st.session_state.counter_context["word_count"]
+      letter_count = st.session_state.counter_context["letter_count"]
       if letter_count < len(target):
-        write_bot(f'The word starts with {st.session_state.results["results"][word_count][:letter_count]}. \n Does this help you remember the word?', remember=False)
-        #ask_if_helped()
-        st.session_state.is_helpful['ask'] = True
+        write_bot(f'The word starts with {st.session_state.results_context["results_context"][word_count][:letter_count]}. \n Does this help you remember the word?', remember=False)
+        #ask_if_helped_context()
+        st.session_state.is_helpful_context['ask'] = True
       else:
         write_bot(f'This is my predicted word: "{target}". Does this match your query?')
-        #ask_if_helped()
-        st.session_state.is_helpful['ask'] = True
+        #ask_if_helped_context()
+        st.session_state.is_helpful_context['ask'] = True
 
     elif b2:
-      rels = return_top_k(st.session_state.descriptions[-1], word=target, rels=True)
+      rels = return_top_k_context(st.session_state.descriptions_context[-1], word=target, rels=True)
       write_bot(f'Here are words that are related to your word: {", ".join(rels)}. \n Does this help you remember the word?', remember=False)
-      #ask_if_helped()
-      st.session_state.is_helpful['ask'] = True
+      #ask_if_helped_context()
+      st.session_state.is_helpful_context['ask'] = True
 
     elif b3:
-      st.session_state.counters["letter_count"] = 1
-      letter_count = st.session_state.counters["letter_count"]
-      st.session_state.counters["word_count"] += 1
-      word_count = st.session_state.counters["word_count"]
-      #write_bot(f'The next word starts with {st.session_state.results["results"][word_count][:letter_count]}', remember=False)
+      st.session_state.counter_context["letter_count"] = 1
+      letter_count = st.session_state.counter_context["letter_count"]
+      st.session_state.counter_context["word_count"] += 1
+      word_count = st.session_state.counter_context["word_count"]
+      #write_bot(f'The next word starts with {st.session_state.results_context["results_context"][word_count][:letter_count]}', remember=False)
       if letter_count < len(target):
-        write_bot(f'The next word starts with {st.session_state.results["results"][word_count][:letter_count]}. \n Does this help you remember the word?', remember=False)
-        #ask_if_helped()
-        st.session_state.is_helpful['ask'] = True
+        write_bot(f'The next word starts with {st.session_state.results_context["results_context"][word_count][:letter_count]}. \n Does this help you remember the word?', remember=False)
+        #ask_if_helped_context()
+        st.session_state.is_helpful_context['ask'] = True
       else:
         write_bot(f'This is my predicted word: "{target}". Does this match your query?')
-        #ask_if_helped()
-        st.session_state.is_helpful['ask'] = True
+        #ask_if_helped_context()
+        st.session_state.is_helpful_context['ask'] = True
 
     #elif get_available_cues(target) and "Synonyms" in cues_buttons and cues_buttons['Synonyms']:
       #write_bot(f'Here are synonyms for the current word: {", ".join(avail_cues["Synonyms"])}', remember=False)
@@ -335,12 +336,12 @@ if st.session_state.actions[-1] == 'cue':
       #write_bot(f'Here are example contexts for the current word: {", ".join(avail_cues["Examples"])}', remember=False)
 
     elif b4:
-      write_bot(f"Here are all my guesses about your word: {st.session_state.results['results_print']}")
+      write_bot(f"Here are all my guesses about your word: {st.session_state.results_context['results_context_print']}")
 
     elif b5:
       write_bot("Yay! I am happy I could be of help!")
-      st.session_state.counters["word_count"] = 0
-      st.session_state.counters["letter_count"] = 0
+      st.session_state.counter_context["word_count"] = 0
+      st.session_state.counter_context["letter_count"] = 0
       new = st.button('Play again', key=63)
       if new:
         write_bot("Please describe your word!")
@@ -350,14 +351,14 @@ if st.session_state.actions[-1] == 'cue':
     
     elif b6:
       write_bot("I am sorry I couldn't help you this time. See you soon!")
-      st.session_state.counters["word_count"] = 0
-      st.session_state.counters["letter_count"] = 0
-    st.session_state.actions.append('cue')
+      st.session_state.counter_context["word_count"] = 0
+      st.session_state.counter_context["letter_count"] = 0
+    st.session_state.actions_context.append('cue')
     
     if new:
       write_bot("Please describe your word!")
-      st.session_state.counters["word_count"] = 0
-      st.session_state.counters["letter_count"] = 0
+      st.session_state.counter_context["word_count"] = 0
+      st.session_state.counter_context["letter_count"] = 0
 
     break