Skip to content

Commit 2c61470

Browse files
authored
Update README.md
1 parent d8adbae commit 2c61470

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
1-
# DIY-Chatbot
1+
# 🗣 DIY-Chatbot
22
> A lightweight chatbot that knows nothing and has to learn from scratch. Using sqlite and python. Also comes with a Discord intergration and custom Pre-Made Models.
33
44
## Introduction
55

6-
### What is this?
6+
### What is this?
77

88
This is a collection of parts from a small chatbot that learns from scratch (knowing nothing at the beginning). There's different pre-made integrations that come with this, such as a Discord Intergration and a Cleverbot Intergration (learns from another bot called cleverbot for extra training).
99

1010
If you're just interested in training it in a console, there's that too (and it's really small and lightweight). It's written in Python and uses sqlite.
1111

12-
### How does it work?
12+
### 💡 How does it work?
1313

14-
It used SQL and Python to store a table of word associations for responses to a previous sentence and uses this to match future responses. It's inspired by Cleverbot's method of learning.
14+
It used SQL and Python to store a table of word associations for responses to a previous sentence and uses this to match future responses. It's inspired by [Cleverbot](https://www.cleverbot.com/)'s method of learning.
1515

1616
It learns from the previous conversation with the user. It maintains a database of previous replies to the same questions and responds based on queries from the database.
1717

1818
It does not extract the meaning of sentences written by the user. When the user types a message, *it is understood as an answer to previous statement made by the chatbot.* The sentence typed by the user will then be associated with the words present in the previous message. The human message is decomposed in words. The program will try to identify which sentences correspond best to those words, according to the answers that the user gave it.
1919

20+
Who knows if that made any sense, but maybe the following will paint a better picture:
21+
2022
**Here's an example:** Let's say this bot knows nothing at the beginning, and just says "Hello" once, without knowing what that means.
2123

2224
```
@@ -49,11 +51,11 @@ Bot: I'm good.
4951

5052
As you can see, it's learnt only from user input.
5153

52-
## Setting up
54+
## Setting up
5355

5456
Setup is very easy and fast. However there's extra steps depending on what you want to do.
5557

56-
### Basic Setup.
58+
### Basic Setup.
5759

5860
1. Firstly, *clone the repo or download the zip* (obviously).
5961

@@ -70,7 +72,7 @@ If you want to start from scratch (without the bot knowing anything), simply run
7072
If you want to start with one of my pretrained models, add it to the Basic Bot folder and name it "botBrain.sqlite". See the README in the models folder or the Basic Bot folder for more info.
7173

7274

73-
### Discord Intergration
75+
### 👥 Discord Intergration
7476

7577
**The Discord Intergration allows you to let your bot chat to users in your server in a specific channel.**
7678

@@ -82,12 +84,12 @@ Not sure how to fill it in? I've provided more detail in [this README](https://g
8284

8385
![](https://cdn.discordapp.com/attachments/478201257417244675/516637578167058448/unknown.png)
8486

85-
### Pre-Made Models
87+
### 🧠 Pre-Made Models
8688

8789
**I've created my own premade models for everyone**, so if you *don't feel like compeltely training yourself, it can have a small headstart.* You can find them in the **Pre-Made Models** folder. ~~These are essentially a variety of different brains ;)~~ You don't have to use these, and I'll be adding more/training them more. These are created by letting my bot chat to other chatbots, as well as humans. It uses mostly correct grammar and is pretty good.
8890

8991
If you'd like to use them, put them in the same directory as the bot's main file, and name it **botBrain.sqlite**. The bot will still learn from users after starting off with this file.
9092

91-
## Contributing
93+
## 🤝 Contributing
9294

93-
I really appriciate contributions, as I'm not perfect and quite lazy. I know there's many flaws in my program, but we can make it better together. Open up a pull request, or even an issue. I'll check it out!
95+
I really appriciate contributions, as I'm not perfect and quite lazy. I know there's many flaws in my program, but we can make it better together. Open up a pull request, or even an issue. I'll check it out! Or, just give the repo a star, I appriciate it!

0 commit comments

Comments
 (0)