Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cakecrusher/mimicbot
Mimicbot enables the effortless yet modular creation of an AI chat bot model that imitates another person's manner of speech.
https://github.com/cakecrusher/mimicbot
ai bot data-science discord discord-bot huggingface natural-language-processing pypi python python-package
Last synced: 2 months ago
JSON representation
Mimicbot enables the effortless yet modular creation of an AI chat bot model that imitates another person's manner of speech.
- Host: GitHub
- URL: https://github.com/cakecrusher/mimicbot
- Owner: CakeCrusher
- License: mit
- Created: 2022-06-26T20:03:50.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-03T04:32:07.000Z (7 months ago)
- Last Synced: 2024-11-22T08:07:39.981Z (2 months ago)
- Topics: ai, bot, data-science, discord, discord-bot, huggingface, natural-language-processing, pypi, python, python-package
- Language: Python
- Homepage:
- Size: 301 KB
- Stars: 10
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mimicbot 🤖
https://user-images.githubusercontent.com/37946988/190918228-a46ba035-c8d1-4fd5-9893-ad87451b22b7.mp4
## About
Mimicbot enables the effortless yet modular creation of an AI chat bot model that imitates another person's manner of speech. For example, if mimicbot were based on Shakespeare, mimicbot will adjust its responses to elizabethan english.
It offers a a general pipeline for creating a mimicbot from scratch provided data on the user to mimic, and another pipeline that runs entirely on Discord without the need for external data. The pipeline consists multiple other commands that are also available for modular use.
## New
You can now create a mimicbot independent of the discord platform.
## Important Commands
Type `python -m mimicbot_cli --help` to see a list of commands. Similarly you can use `python -m mimicbot_cli --help` to see details on a specific command.
## Quickstart
### Verify the following prerequisites are met
- Python 3.x (verify with `python --version` or `python3 --version` or `py --version`)
- Download from the official [Python website](https://www.python.org/downloads/)
- git-lfs (verify with `git lfs --version`)
- Install with `git lfs install` or follow the official [git lfs installation guide](https://git-lfs.github.com/).
- pip (verify with `pip --version`)
- Install with `py get-pip.py` or follow the official [pip installation guide](https://pip.pypa.io/en/stable/installation/).
### Note
If you run into any issues, you dont know how to deal with. Utilize the mimicbot [Dockerfile](https://github.com/CakeCrusher/mimicbot/blob/master/Dockerfile) to [spin up a functional environment](https://github.com/CakeCrusher/mimicbot#spining-up-docker-environement).
### Steps
1. Run `pip install mimicbot-cli`.
2. Run the command `python -m mimicbot_cli forge`. This command will guide you through the creation of the bot from start to finish.
3. Opt to build a Discord bot.
4. Once the mimicbot is activated on discord, you can interact with it by simply sending it a message as you would to the person it is imitating, with a `@` mention somewhere in the text. The mimicbot will then reply with a message similar to how the original user would have said it.
### Contribute
1. Clone the repository `git clone https://github.com/CakeCrusher/mimicbot.git`
2. Navigate into the cloned directory `cd mimicbot`
3. Install the dependencies `pip install -r requirements.txt`. If you have [CUDA](https://developer.nvidia.com/cuda-downloads) installed use `pip install -r requirements-gpu.txt` instead. (WARNING: the dependencies will consume a lot of space. If you have an environment with pytorch already installed it is advisable that you use that environment.)
4. Run the command `python -m mimicbot_cli forge`. This command will guide you through the creation of the bot from start to finish.
5. Once the mimicbot is activated on discord, you can interact with it by simply sending it a message as you would to the person it is imitating, with a `@` mention somewhere in the text. The mimicbot will then reply with a message similar to how the original user would have said it.
## Deploy
Although technically you could deploy your bot to any server using this repository it is not recommended primarily because of the heavy dependencies. Consequently, the [mimicbot-deploy](https://github.com/CakeCrusher/mimicbot-deploy) repository was built for ease of deployment.
Follow the steps listed in its README to deploy your bot.
If you are still interested in deploying with this repository you can do so by either running `forge` on the server or passing the configuration files and data files to the appropriate paths on the server and then running `activate`.
## Todo
(Feel free to contribute)
- [x] Incorporate github actions to run the pytest tests.
- [x] Enable bots to mention users in the channel.
- [ ] More error handling.
- [ ] Linux support.
- [ ] Add linting.
- [ ] github action.
- [ ] Use [DiscordChatExporter](https://github.com/Tyrrrz/DiscordChatExporter) cli as the primary source of mining data to be able to capture dm data in addition to guild data. It also does not require admin access for guilds. The only catch is its security is yet to be determined.
- [ ] Embed training settings into the CLI command
- [ ] More flexible with inputs
- [ ] Target user input
- [ ] Guild channel names
- [ ] Make sure the bot learns as it is being used.
- [ ] Create a public server for running through the pipeline and adding deploying the bot. Will work by simply downloading the bot and commanding it to copy a user, then wait a couple minutes and BAM! It's mimicing.
- [ ] Add testing
- [ ] `activate` command unit tests
- [ ] `train` command unit tests
- [ ] End to end tests
## Mini-guides
Quick guides to clear up the more confusing parts to getting up and running with mimicbot.
### Setting up Discord bot (and retrieving API token)
If you are running `mimicbot_cli forge` on the CLI make sure to complete this guide before submitting the API key.
1. Create a discord developer account and log in.
2. Create a discord application in [applications page of the developer portal](https://discord.com/developers/applications). 
3. Add a bot to the application in the bot settings inside your application. 
4. Click on the reset token button which will then prompt you to copy the token, this is the token you will provide to mimicbot. Then activate the "server members intent" and the "message content intent". 
5. Navigate to OAuth2 > URL Generator then check "bot" as the scope. Then check the "Read Messages/View Channels" general permission and "Send Messages" text permission. Finally, once all of those are checked copy the Generated URL. 
6. (You must be signed into your discord account on the browser) Simply navigate to the URL you copied, then select the server (you must have admin privileges) where you want to both: mine data and activate the bot. Click create. 
7. Click authorize, click through Captcha, and you're done! Your discord bot is be ready to go! 
8. If you are running `mimicbot_cli forge` make sure to return to the CLI, enter your Discord API token and continue on the CLI.
### Retrieving Huggingface API token
If you are running `mimicbot_cli forge` on the CLI make sure to complete this guide before moving submitting the API key.
1. Create a huggingface account and log in.
2. Navigate to [your settings](https://huggingface.co/settings/profile).
3. Click on the "Access Tokens" tab, then create a "New Token". Then label it, select its "Role" as "write", and press "Generate a token". 
4. Copy the "write" token, this is the token you will provide to mimicbot. 
5. If you are running `mimicbot_cli forge` make sure to return to the CLI, enter your Huggingface API token and continue on the CLI.
### Spining up Docker Environement
1. Verify you have docker installed and running by using `docker ps`. You may install it from their [official installation page](https://docs.docker.com/get-docker/).
2. Create a new docker image by running `docker build -t mimicbot .`.
3. Run the docker image with `docker run -it --name mimicbot /bin/bash`.
4. You are now ready to start using mimicbot's CLI.
5. You may return to the same container by running `docker start -ai `
## Troubleshooting
Errors may occur here are common ones with solutions.
### GPU error
1. Visit [this colab notebook](https://colab.research.google.com/drive/1a196Ev2FJ8U_L__BjTTLFqCXrq9YFhc7?usp=sharing).
2. Copy all files in your `/DATA_PATH/colab` into the root directory of the notebook. (If you don't know what your `DATA_PATH` is, enter the following command in a terminal: `python -m mimicbot_cli config`. Then find the line that with the text `data_path = ...` your `DATA_PATH` is listed there.) 
3. Click on the "Edit" tab and then click on the "Notebook settings". Select "GPU" for Hardware accelerator, and finally click "Save".  
4. Click on the "Runtime" tab, then click "Run all". 
5. Wait for the script to finish. You will know it is done with the following indicators: 1. The favicon is yellow, 2. There is a green checkmark next to the cell, and 3. Scroll all the way down to the bottom of the output and you should see a timestamped message saying "Training finished". 