update descriptions for apps

minggnim · Aug 11, 2023 · 1e52bd7 · 1e52bd7
1 parent 026f64f
commit 1e52bd7
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 19 deletions.
diff --git a/apps/README.md b/apps/README.md
@@ -0,0 +1,16 @@
+## Instructions to run applications
+
+1. Install the latest nlp_models package
+
+    ```
+    pip install -U nlp_models
+    ```
+
+2. Download Llama2 quantization model `llama-2-7b-chat.ggmlv3.q8_0.bin` 
+
+    from https://huggingface.co/TheBloke/Llama-2-13B-chat-GGML/tree/main and place it under `models` folder
+
+
+3. Run the application of interest
+    - Chat `streamlit run chat.py`
+    - Q&A `streamlit run qa.py` 
diff --git a/apps/chat.py b/apps/chat.py
@@ -1,14 +1,3 @@
-"""
-To run Llama2 chat UI on CPU
-1. Install the latest nlp_models package 
-`pip install -U nlp_models`
-2. Download `llama-2-7b-chat.ggmlv3.q8_0.bin` 
-from https://huggingface.co/TheBloke/Llama-2-13B-chat-GGML/tree/main 
-and place it under `models` folder
-3. Run `streamlit run chat.py` to spin up the UI
-"""
-
-
 import streamlit as st
 from langchain.memory import ConversationBufferWindowMemory
 from nlp_models.llm.base import LlmConfig

diff --git a/apps/qa.py b/apps/qa.py
@@ -1,11 +1,3 @@
-"""
-To run Llama2 QA UI on CPU
-1. Install the latest nlp_models package `pip install -U nlp_models`
-2. Download `llama-2-7b-chat.ggmlv3.q8_0.bin` from https://huggingface.co/TheBloke/Llama-2-13B-chat-GGML/tree/main and place it under `models` folder
-3. Run `streamlit run qa.py` to spin up the UI
-"""
-
-
 import streamlit as st
 from tempfile import NamedTemporaryFile
 from nlp_models.llm.base import LlmConfig