green commited on
Commit
87d17d7
β€’
1 Parent(s): 86e83a7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +39 -3
README.md CHANGED
@@ -1,8 +1,44 @@
1
- # TopicDig
 
 
 
 
 
 
 
 
2
 
3
- ### TopicDig uses whole article summarization to create topical digests from current news headlines
4
 
5
- #### [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://share.streamlit.io/mpolinsky/topicdig/main)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
 
7
  The app displays topics, the user chooses up to three, and the app spins up a topical digest scraped from the headlines.
8
  This project makes heavy use of HuggingFace for NLP, and Gazpacho for web scraping.
 
1
+ ---
2
+ title: TopicDig
3
+ emoji: πŸ•΅πŸ»
4
+ colorFrom: gray
5
+ colorTo: yellow
6
+ sdk: streamlit
7
+ app_file: app.py
8
+ pinned: false
9
+ ---
10
 
11
+ # Configuration
12
 
13
+ `title`: _string_
14
+ Display title for the Space
15
+
16
+ `emoji`: _string_
17
+ Space emoji (emoji-only character allowed)
18
+
19
+ `colorFrom`: _string_
20
+ Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray)
21
+
22
+ `colorTo`: _string_
23
+ Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray)
24
+
25
+ `sdk`: _string_
26
+ Can be either `gradio` or `streamlit`
27
+
28
+ `sdk_version` : _string_
29
+ Only applicable for `streamlit` SDK.
30
+ See [doc](https://hf.co/docs/hub/spaces) for more info on supported versions.
31
+
32
+ `app_file`: _string_
33
+ Path to your main application file (which contains either `gradio` or `streamlit` Python code).
34
+ Path is relative to the root of the repository.
35
+
36
+ `pinned`: _boolean_
37
+ Whether the Space stays on top of your list.
38
+
39
+ TopicDig
40
+
41
+ TopicDig uses whole article summarization to create topical digests from current news headlines
42
 
43
  The app displays topics, the user chooses up to three, and the app spins up a topical digest scraped from the headlines.
44
  This project makes heavy use of HuggingFace for NLP, and Gazpacho for web scraping.