deven367 commited on
Commit
cb40a92
Β·
1 Parent(s): 1e305c9

update readme

Browse files
Files changed (1) hide show
  1. README.md +18 -2
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- title: Frontend
3
  emoji: 🌍
4
  colorFrom: red
5
  colorTo: blue
@@ -9,4 +9,20 @@ app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: deven-cleric-frontend
3
  emoji: 🌍
4
  colorFrom: red
5
  colorTo: blue
 
9
  pinned: false
10
  ---
11
 
12
+ I've built the web app with Streamlit. The app is deployed on huggingface spaces. The app as expected takes comma seperated URLs and a question/questions as input and returns facts.
13
+
14
+ The facts received from the API are in `list` format, however, a single element of the `list` can contain multiple sentences, so I tokenize them into multiple sentences using `nltk`.
15
+
16
+ ## Install
17
+
18
+ Install the dependencies using,
19
+
20
+ ```sh
21
+ pip install -r requirements.txt
22
+ ```
23
+
24
+ Once installed, start the app using
25
+
26
+ ```sh
27
+ streamlit run app.py
28
+ ```