Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PratikSavla authored Sep 1, 2019
1 parent fe48947 commit 889e806
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,45 @@

## All in one bot

#### Check List
### Requirements

```sh
pip install -r requirements.txt
```
### Demo

```sh
python main.py
```
### List of features
1. [Add user to database](#add-user-to-database)
2. [Detect User at start](#detect-user-at-start)
3. [Detect Emotion](#detect-emotion)
4. [Add your question and answers to your datafile](#add-your-question-and-answers-to-your-datafile)

#### Add user to database
In Users folder add a photo of the user with image name as their name (only name.jpg format).
Copy the "Unknown.template" file and rename the new file by replacing "Unknown" with "name"

#### Detect User at start
If bot detects user and remembers him/her then he will great with their name else it will say "I am a chatbot"

#### Detect Emotion
Currently you have to have "feeling" in sentence for emotion detection.
It will reply your emotion.

#### Add your question and answers to your datafile
To save your pre answered question:
Write question in this format:
```
>learn mode ques {question in second person grammer}
```
Write answer in this format:
```
>learn mode ans {answer in second person grammer}
```

### Check List
- [x] Finish chat template
- [x] Identify the user while starting the conversation
- [X] Detect user's emotion (Currently detects only when user asks)
Expand Down

0 comments on commit 889e806

Please sign in to comment.