Update README.md
Browse files
README.md
CHANGED
@@ -1,3 +1,47 @@
|
|
1 |
-
#
|
|
|
|
|
2 |
|
3 |
Idea is to build a model which will take keywords as inputs and generate sentences as outputs.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# keytotext
|
2 |
+
|
3 |
+

|
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 |
+
[](https://pypi.org/project/keytotext/)
|
10 |
+
[](https://pepy.tech/project/keytotext)
|
11 |
+
[](https://colab.research.google.com/github/gagan3012/keytotext/blob/master/Examples/K2T.ipynb)
|
12 |
+
[](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: [](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 |
+

|
35 |
+
|
36 |
+
|
37 |
+
## UI:
|
38 |
+
|
39 |
+
UI: [](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 |
+

|
47 |
+
|