Create README.md
Browse files
README.md
ADDED
@@ -0,0 +1,43 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
language:
|
3 |
+
- en
|
4 |
+
library_name: spacy
|
5 |
+
---
|
6 |
+
# Emoji Suggester
|
7 |
+
|
8 |
+
Emoji Suggester is a tool designed to recommend relevant emojis based on incoming messages from social media apps, enhancing expressiveness and engagement in your conversations. The suggestions are powered by a model trained on a dataset of Twitter messages.
|
9 |
+
|
10 |
+
## Table of Contents
|
11 |
+
|
12 |
+
- [Installation](#installation)
|
13 |
+
- [Usage](#usage)
|
14 |
+
- [Contributing](#contributing)
|
15 |
+
- [License](#license)
|
16 |
+
- [Contact](#contact)
|
17 |
+
|
18 |
+
## Installation
|
19 |
+
|
20 |
+
To install Emoji Suggester, follow these steps:
|
21 |
+
|
22 |
+
1. Clone the repository:
|
23 |
+
```bash
|
24 |
+
git clone https://huggingface.co/Rudra360/Emoji_Suggester
|
25 |
+
or
|
26 |
+
```bash
|
27 |
+
git clone git@huggingface.co:Rudra360/Emoji_Suggester.git
|
28 |
+
|
29 |
+
## Usage
|
30 |
+
|
31 |
+
Change the Directory
|
32 |
+
1. go to emoji_suggester
|
33 |
+
```bash
|
34 |
+
cd Emoji_Suggester
|
35 |
+
|
36 |
+
Then the run the follwing script
|
37 |
+
|
38 |
+
2. from util import predict
|
39 |
+
|
40 |
+
3. message = "I'm so happy today!"
|
41 |
+
suggested_emojis = predict(message)
|
42 |
+
print(suggested_emojis)
|
43 |
+
|