gagan3012 commited on
Commit
467a781
1 Parent(s): 6f346cb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +45 -1
README.md CHANGED
@@ -1,3 +1,47 @@
1
- # Key to Text
 
 
2
 
3
  Idea is to build a model which will take keywords as inputs and generate sentences as outputs.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # keytotext
2
+
3
+ ![keytotext (1)](https://user-images.githubusercontent.com/49101362/116334480-f5e57a00-a7dd-11eb-987c-186477f94b6e.png)
4
 
5
  Idea is to build a model which will take keywords as inputs and generate sentences as outputs.
6
+
7
+ ### Keytotext is powered by Huggingface 🤗
8
+
9
+ [![pypi Version](https://img.shields.io/pypi/v/keytotext.svg?style=flat-square&logo=pypi&logoColor=white)](https://pypi.org/project/keytotext/)
10
+ [![Downloads](https://static.pepy.tech/personalized-badge/keytotext?period=total&units=none&left_color=grey&right_color=orange&left_text=Pip%20Downloads)](https://pepy.tech/project/keytotext)
11
+ [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/gagan3012/keytotext/blob/master/Examples/K2T.ipynb)
12
+ [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://share.streamlit.io/gagan3012/keytotext/UI/app.py)
13
+
14
+ ## Model:
15
+
16
+ Keytotext is based on the Amazing T5 Model:
17
+
18
+ - `k2t`: [Model](https://huggingface.co/gagan3012/k2t)
19
+ - `k2t-tiny`: [Model](https://huggingface.co/gagan3012/k2t-tiny)
20
+ - `k2t-base`: [Model](https://huggingface.co/gagan3012/k2t-base)
21
+
22
+ Training Notebooks can be found in the [`Training Notebooks`](https://github.com/gagan3012/keytotext/tree/master/Training%20Notebooks) Folder
23
+
24
+ ## Usage:
25
+
26
+ Example usage: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/gagan3012/keytotext/blob/master/Examples/K2T.ipynb)
27
+
28
+ Example Notebooks can be found in the [`Notebooks`](https://github.com/gagan3012/keytotext/tree/master/Examples) Folder
29
+
30
+ ```
31
+ pip install keytotext
32
+ ```
33
+
34
+ ![carbon (3)](https://user-images.githubusercontent.com/49101362/116220679-90e64180-a755-11eb-9246-82d93d924a6c.png)
35
+
36
+
37
+ ## UI:
38
+
39
+ UI: [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://share.streamlit.io/gagan3012/keytotext/UI/app.py)
40
+
41
+ ```
42
+ pip install streamlit-tags
43
+ ```
44
+ This uses a custom streamlit component built by me: [GitHub](https://github.com/gagan3012/streamlit-tags)
45
+
46
+ ![image](https://user-images.githubusercontent.com/49101362/116162205-fc042980-a6fd-11eb-892e-8f6902f193f4.png)
47
+