Tuana commited on
Commit
764169e
1 Parent(s): 2e41d16

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +18 -3
README.md CHANGED
@@ -1,6 +1,22 @@
1
  # Simple app to get an overview of what the twitter user has been posting about and their tone
2
 
3
- In this repo you will find a template streamlit app set up for search applications.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
 
5
  ## Installation and Running
6
  To run the bare application which does _nothing_:
@@ -13,5 +29,4 @@ To run the bare application which does _nothing_:
13
 
14
  This will start up the app on `localhost:8501` where you will dind a simple search bar
15
 
16
- ## What to edit:
17
-
 
1
  # Simple app to get an overview of what the twitter user has been posting about and their tone
2
 
3
+ This is a demo just for fun 🥳
4
+ This repo contains a streamlit application that given a Twitter username, tells you what type of things they've been posting about lately, their tone, and the languages they use. It uses the LLM by OpenAI `text-davinci-003`.
5
+
6
+ It's been built with [Haystack](https://haystack.deepset.ai) using the [`PromptNode`](https://docs.haystack.deepset.ai/docs/prompt_node) and by creating a custom [`PromptTemplate`](https://docs.haystack.deepset.ai/docs/prompt_node#templates)
7
+
8
+ https://user-images.githubusercontent.com/15802862/220464834-f42c038d-54b4-4d5e-8d59-30d95143b616.mov
9
+
10
+
11
+ ### Points of improvement
12
+
13
+ Since we're using a generative model here, we need to be a bit creative with the prompt we provide it to minimize any hallucination or similar unwanted results. For this reason, I've tried to be a bit creative with the `PromptTemplate` and give some examples of _how_ to construct a summary. However, this still sometimes produces odd results.
14
+
15
+ If you try to run it yourself and find ways to make this app better, please feel free to create an issue/PR 🙌
16
+
17
+ ## To learn more about the PromptNode
18
+
19
+ Check out our tutorial on the PromptNode and how to create your own templates [here](https://haystack.deepset.ai/tutorials/21_customizing_promptnode)
20
 
21
  ## Installation and Running
22
  To run the bare application which does _nothing_:
 
29
 
30
  This will start up the app on `localhost:8501` where you will dind a simple search bar
31
 
32
+ #### The Haystack Community is on [Discord](https://discord.com/invite/VBpFzsgRVF)