full code documentation

Author: zslrmhb

requirements.txt

@@ -0,0 +1,167 @@
+# This file may be used to create an environment using:
+# $ conda create --name <env> --file <this file>
+# platform: win-64
+altair=4.1.0=py_1
+argon2-cffi=21.3.0=pyhd3eb1b0_0
+argon2-cffi-bindings=21.2.0=py39h2bbff1b_0
+arrow-cpp=8.0.0=py39hbd6f097_0
+asttokens=2.0.5=pyhd3eb1b0_0
+attrs=22.1.0=py39haa95532_0
+aws-c-common=0.4.57=ha925a31_1
+aws-c-event-stream=0.1.6=hd77b12b_5
+aws-checksums=0.1.9=ha925a31_0
+aws-sdk-cpp=1.8.185=hd77b12b_0
+backcall=0.2.0=pyhd3eb1b0_0
+blas=1.0=mkl
+bleach=4.1.0=pyhd3eb1b0_0
+blinker=1.4=py39haa95532_0
+boost-cpp=1.73.0=h2bbff1b_12
+bottleneck=1.3.5=py39h080aedc_0
+brotli=1.0.9=h2bbff1b_7
+brotli-bin=1.0.9=h2bbff1b_7
+brotlipy=0.7.0=py39h2bbff1b_1003
+bzip2=1.0.8=he774522_0
+c-ares=1.18.1=h2bbff1b_0
+ca-certificates=2022.10.11=haa95532_0
+cachetools=4.2.2=pyhd3eb1b0_0
+certifi=2022.12.7=py39haa95532_0
+cffi=1.15.1=py39h2bbff1b_3
+charset-normalizer=2.0.4=pyhd3eb1b0_0
+click=8.0.4=py39haa95532_0
+colorama=0.4.6=py39haa95532_0
+commonmark=0.9.1=pyhd3eb1b0_0
+cryptography=38.0.4=py39h21b164f_0
+dataclasses=0.8=pyh6d0b6a4_7
+debugpy=1.5.1=py39hd77b12b_0
+decorator=5.1.1=pyhd3eb1b0_0
+defusedxml=0.7.1=pyhd3eb1b0_0
+entrypoints=0.4=py39haa95532_0
+executing=0.8.3=pyhd3eb1b0_0
+flit-core=3.6.0=pyhd3eb1b0_0
+freetype=2.12.1=ha860e81_0
+future=0.18.2=py39haa95532_1
+gflags=2.2.2=ha925a31_0
+gitdb=4.0.7=pyhd3eb1b0_0
+gitpython=3.1.18=pyhd3eb1b0_1
+glog=0.5.0=hd77b12b_0
+idna=3.4=py39haa95532_0
+importlib-metadata=4.11.3=py39haa95532_0
+intel-openmp=2021.4.0=haa95532_3556
+ipykernel=6.15.2=py39haa95532_0
+ipython=8.7.0=py39haa95532_0
+ipython_genutils=0.2.0=pyhd3eb1b0_1
+ipywidgets=7.6.5=pyhd3eb1b0_1
+jedi=0.18.1=py39haa95532_1
+jinja2=3.1.2=py39haa95532_0
+jpeg=9e=h2bbff1b_0
+jsonschema=4.16.0=py39haa95532_0
+jupyter_client=7.4.8=py39haa95532_0
+jupyter_core=4.11.1=py39haa95532_0
+jupyterlab_pygments=0.1.2=py_0
+jupyterlab_widgets=1.0.0=pyhd3eb1b0_1
+lerc=3.0=hd77b12b_0
+libboost=1.73.0=h6c2663c_12
+libbrotlicommon=1.0.9=h2bbff1b_7
+libbrotlidec=1.0.9=h2bbff1b_7
+libbrotlienc=1.0.9=h2bbff1b_7
+libcurl=7.86.0=h86230a5_0
+libdeflate=1.8=h2bbff1b_5
+libffi=3.4.2=hd77b12b_6
+libiconv=1.16=h2bbff1b_2
+libpng=1.6.37=h2a8f88b_0
+libprotobuf=3.20.1=h23ce68f_0
+libsodium=1.0.18=h62dcd97_0
+libssh2=1.10.0=hcd4344a_0
+libthrift=0.15.0=he1d8c1a_0
+libtiff=4.5.0=h8a3f274_0
+libwebp=1.2.4=h2bbff1b_0
+libwebp-base=1.2.4=h2bbff1b_0
+libxml2=2.9.14=h0ad7f3c_0
+libxslt=1.1.35=h2bbff1b_0
+lz4-c=1.9.4=h2bbff1b_0
+markupsafe=2.1.1=py39h2bbff1b_0
+matplotlib-inline=0.1.6=py39haa95532_0
+mistune=0.8.4=py39h2bbff1b_1000
+mkl=2021.4.0=haa95532_640
+mkl-service=2.4.0=py39h2bbff1b_0
+mkl_fft=1.3.1=py39h277e83a_0
+mkl_random=1.2.2=py39hf11a4ad_0
+nbconvert=5.5.0=py_0
+nbformat=5.1.3=pyhd3eb1b0_0
+nest-asyncio=1.5.6=py39haa95532_0
+notebook=6.4.12=py39haa95532_0
+numexpr=2.8.4=py39h5b0cc5e_0
+numpy=1.23.5=py39h3b20f71_0
+numpy-base=1.23.5=py39h4da318b_0
+openssl=1.1.1s=h2bbff1b_0
+packaging=22.0=py39haa95532_0
+pandas=1.5.2=py39hf11a4ad_0
+pandoc=2.12=haa95532_1
+pandocfilters=1.5.0=pyhd3eb1b0_0
+parso=0.8.3=pyhd3eb1b0_0
+pickleshare=0.7.5=pyhd3eb1b0_1003
+pillow=9.3.0=py39hdc2b20a_1
+pip=22.3.1=py39haa95532_0
+prometheus_client=0.14.1=py39haa95532_0
+prompt-toolkit=3.0.36=py39haa95532_0
+protobuf=3.20.1=py39hd77b12b_0
+psutil=5.9.0=py39h2bbff1b_0
+pure_eval=0.2.2=pyhd3eb1b0_0
+pyarrow=8.0.0=py39h953b917_0
+pycparser=2.21=pyhd3eb1b0_0
+pydeck=0.7.1=py39haa95532_0
+pygments=2.11.2=pyhd3eb1b0_0
+pympler=0.9=py_0
+pyopenssl=22.0.0=pyhd3eb1b0_0
+pyrsistent=0.18.0=py39h196d8e1_0
+pysocks=1.7.1=py39haa95532_0
+python=3.9.16=h6244533_0
+python-dateutil=2.8.2=pyhd3eb1b0_0
+pytz=2022.7=py39haa95532_0
+pywin32=305=py39h2bbff1b_0
+pywinpty=2.0.2=py39h5da7b33_0
+pyyaml=6.0=py39h2bbff1b_1
+pyzmq=23.2.0=py39hd77b12b_0
+re2=2022.04.01=hd77b12b_0
+requests=2.28.1=py39haa95532_0
+rich=12.5.1=py39haa95532_0
+semver=2.13.0=pyhd3eb1b0_0
+send2trash=1.8.0=pyhd3eb1b0_1
+setuptools=65.6.3=py39haa95532_0
+six=1.16.0=pyhd3eb1b0_1
+smmap=4.0.0=pyhd3eb1b0_0
+snappy=1.1.9=h6c2663c_0
+sqlite=3.40.1=h2bbff1b_0
+stack_data=0.2.0=pyhd3eb1b0_0
+streamlit=1.17.0=pypi_0
+streamlit-chat=0.0.2.1=pypi_0
+terminado=0.17.1=py39haa95532_0
+testpath=0.6.0=py39haa95532_0
+tk=8.6.12=h2bbff1b_0
+toml=0.10.2=pyhd3eb1b0_0
+toolz=0.12.0=py39haa95532_0
+tornado=6.2=py39h2bbff1b_0
+traitlets=5.7.1=py39haa95532_0
+typing-extensions=4.4.0=py39haa95532_0
+typing_extensions=4.4.0=py39haa95532_0
+tzdata=2022g=h04d1e81_0
+tzlocal=2.1=py39haa95532_1
+urllib3=1.26.14=py39haa95532_0
+utf8proc=2.6.1=h2bbff1b_0
+validators=0.18.2=pyhd3eb1b0_0
+vc=14.2=h21ff451_1
+vs2015_runtime=14.27.29016=h5e58377_2
+watchdog=2.1.6=py39haa95532_0
+wcwidth=0.2.5=pyhd3eb1b0_0
+webencodings=0.5.1=py39haa95532_1
+wheel=0.37.1=pyhd3eb1b0_0
+widgetsnbextension=3.5.2=py39haa95532_0
+win_inet_pton=1.1.0=py39haa95532_0
+wincertstore=0.2=py39haa95532_2
+winpty=0.4.3=4
+xz=5.2.10=h8cc25b3_1
+yaml=0.2.5=he774522_0
+zeromq=4.3.4=hd77b12b_0
+zipp=3.11.0=py39haa95532_0
+zlib=1.2.13=h8cc25b3_0
+zstd=1.5.2=h19a0ad4_0

scripts/__pycache__/config.cpython-39.pyc

@@ -3,25 +3,25 @@
 from notetaker import NoteTaker
 from notebot import NoteBot
 
+import time
+
 import streamlit as st
 from streamlit_chat import message
 
-import re
-import time
-
 # Page Config
 st.set_page_config(layout='wide')
 
 # Session States
+# We want to use session states to manage the execution of each widget, 
+# so a widget that is not click on will not be excuted
 if "generated" not in st.session_state:
     st.session_state["generated"] = False
-    st.session_state["downloaded"] = True
+    st.session_state["downloaded"] = False
     st.session_state["asked"] = False
     st.session_state["most_recent_note"] = ""
     st.session_state["user_chat_history"] = []
     st.session_state["notebot_response_history"] = []
 
-
 # Welcome page
 st.title("i-Note-it")
 st.caption("---Enhance Note-Taking Experience with Artificial Intelligence.")
@@ -32,12 +32,13 @@
 NoteTakingService = NoteTaker()
 NoteBotService = NoteBot()
 
+# Left, Right Columns
 col1, col2 = st.columns(2, gap="medium")
 
 with col1:
     st.header("Your Text")
     generate_button = st.button("Generate")
-    text = st.text_area(":keyboard: Input the text ", height=300, max_chars=5000, help="Copy & Paste the text you want to convert into markdown note")  # Corresponds to approximately 2040 tokens (max. tokens for the model)
+    text = st.text_area(":keyboard: Input the text ", height=300, max_chars=5000, help="Copy & Paste or type the text you want to convert into markdown note")  # Corresponds to approximately 2040 tokens (max. tokens for the model)
 
 with col2:
     st.header("Your Note")
@@ -52,7 +53,7 @@
         try:
             generated_note = NoteTakingService.run(text)
             generate_success = True
-        except KeyError:
+        except KeyError:        
             st.error("Try with fewer text!")
 
         if generate_success:
@@ -61,13 +62,13 @@
             with st.spinner('Wait for it...'):
                 time.sleep(3)
 
-            # if st.session_state["downloaded"]:
-            #     download_button = st.download_button("Download", post_processed_note, 'i-Note-it.md')
             st.session_state["most_recent_note"] = post_processed_note
             st.session_state["generated"] = False
 
+    st.download_button("Download", st.session_state["most_recent_note"], 'i-Note-it.md')
     st.markdown(st.session_state["most_recent_note"])
 
+# NoteBot Section
 with st.expander("Ask your NoteBot!"):
 
     question = st.text_input("Question")
@@ -76,7 +77,6 @@
         st.session_state["user_chat_history"].clear()
         bot_hist = st.session_state["notebot_response_history"].clear()
 
-
     if question: 
         st.session_state["asked"] = True
 
@@ -87,7 +87,7 @@
         user_hist.append(question)
         bot_hist.append(NoteBotService.run(text,question))
 
-
+        # Dialogue DIsplay
         for i in range(len(user_hist)-1, -1, -1):
             message(bot_hist[i], key=str(i) +'_bot')
             message(user_hist[i], is_user=True, key=str(i) + '_user')

scripts/__pycache__/notetaker.cpython-39.pyc

@@ -3,24 +3,25 @@
 import requests
 
 class NoteBot():
+    """ i-Note-it NoteBot
+    """
     def __init__(self):
-        """_summary_
-
-        Args:
-            instruction (_type_, optional): _description_. Defaults to None.
+        """init
         """
         self.instruction1 = "Context: "
         self.instruction2 = "\nQuestion: "
         self.instruction3 = "\nAnswer: "
 
-
-
     def get_response(self, transcript, question, to_json=True):
-        """_summary_
+        """ Get NoteBot Model Response
 
         Args:
-            transcript (_type_): _description_
-            question (_type_): _description_
+            transcript (str): input transcript
+            question (str): question to ask
+            to_json (bool, optional): convert to json format. Defaults to True.
+
+        Returns:
+            dict or str:  to_json=True -> dict, to_json=False -> str
         """
         payload = {
                     "prompt": f"{self.instruction1}{transcript}{self.instruction2}{question}{self.instruction3}",
@@ -68,18 +69,18 @@ def get_response(self, transcript, question, to_json=True):
             return response
 
     def run(self, transcript, question, to_json=True, get_text=True):
-        """_summary_
+        """ Run the Model
 
         Args:
-            input_text (_type_): _description_
-            to_json (bool, optional): _description_. Defaults to True.
+            transcript (str): input transcript
+            question (str): question to ask
+            to_json (bool, optional): convert to json format. Defaults to True.
+            get_text (bool, optional): Get the model completion response. Defaults to True.
 
         Returns:
-            _type_: _description_
+            str or dict: get_text=True -> str, get_text=False -> dict
         """
         if get_text:
             return self.get_response(transcript, question, to_json)['completions'][0]['data']['text']
         else:
-            return self.get_response(transcript, question, to_json)
-
-        
+            return self.get_response(transcript, question, to_json)  

scripts/main.py

@@ -1,29 +1,36 @@
 from config import API_TOKEN, NOTETAKER_MODEL_URL
-import requests
 
+import requests
 
 class NoteTaker:
-    """_summary_
+    """i-Note-it NoteTaker 
     """
     def __init__(self, instruction=None):
-        """_summary_
+        """init
+
+        Args:
+            instruction (str, optional): Prompt for the Note Taking Model. Defaults to None.
         """
         if instruction == None:
             self.instruction = "Imagine you are the best notetaker in the world. Write the most streamlined and hierarchical bullet point notes with sections for this text:\n"
         else: 
             self.instruction = instruction
 
     def request_note(self, input_text, to_json=True):
-        """
+        """Get NoteTaker Model Response
 
         Args:
-            input_text (_type_): _description_
+            input_text (str): input transcript
+            to_json (bool, optional): convert to json format. Defaults to True.
+
+        Returns:
+            dict or str:  to_json=True -> dict, to_json=False -> str
         """
         payload = {
                     "prompt": f"{self.instruction}{input_text}\n##\n",
                     "numResults": 1,
-                    "maxTokens": 2048,
-                    "temperature": 0,
+                    "maxTokens": 64,
+                    "temperature": 0.7,
                     "topKReturn": 0,
                     "topP":1,
                     "countPenalty": {
@@ -66,14 +73,15 @@ def request_note(self, input_text, to_json=True):
             return response
 
     def run(self, input_text, to_json=True, get_text=True):
-        """_summary_
+        """Run the Model
 
         Args:
-            input_text (_type_): _description_
-            to_json (bool, optional): _description_. Defaults to True.
+            input_text (str): Input transcript
+            to_json (bool, optional): convert to json format. Defaults to True.
+            get_text (bool, optional): Get the model completion response. Defaults to True.
 
         Returns:
-            _type_: _description_
+            str or dict: get_text=True -> str, get_text=False -> dict
         """
         if get_text:
             return self.request_note(input_text, to_json)['completions'][0]['data']['text']

scripts/notebot.py

@@ -1,8 +1,8 @@
 class PostProcessor:
-    """_summary_
+    """Post process the text from the i-Note-it NoteTaker to a markdown-ready text
     """
     def __init__(self):
-        """_summary_
+        """init
         """
         pass