Update readme

This commit is contained in:
Ash
2023-01-08 16:54:32 +04:00
parent 637a60812f
commit d8136649c1
4 changed files with 27 additions and 26 deletions

View File

@@ -1,37 +1,38 @@
### TavernAI is a adventure chat shell for AI language models ### @^TavernAI is a adventure atmospheric chat (KoboldAI, NovelAI)^@
<br><img src="readme/1.png" width="600" /> <br><img src="readme/1.png" height="200" /><img src="readme/4.png" height="200" /><img src="readme/5.png" height="200" />
TavernAI helps the AI model is in the chat format and makes the answers a longer than they usually are for this format. In most cases, the shell fixes the problem when the model tries to answer for the user. [@@@Download TavernAI@@@](https://github.com/TavernAI/TavernAI/archive/refs/heads/main.zip)
## Features
* Creating characters with personality setup
* Choosing name and avatar for your character
* Deleting and regenerating messages
* Editing any messages
* More longer messages from characters
* Choosing atmospheric backgrounds
* Creating and easy chosing preset settings
Through the interface, you can easily create/edit characters, switch presets and change the background on the fly.
## How to install ## How to install
### In Detail: ### In Detail:
* [Detailed installation and connection guide to KoboldAI Colab model step by step](https://github.com/TavernAI/TavernAI/wiki/How-to-install)<br> * [Install with KoboldAI](https://github.com/TavernAI/TavernAI/wiki/How-to-install)<br>
* [Install with NovelAI](https://github.com/TavernAI/TavernAI/wiki/How-to-install-Novel)<br>
### Briefly: ### Briefly:
1. Download and Install [Node.js v19.1.0](https://nodejs.org/download/release/v19.1.0/) 1. Download [TavernAI](https://github.com/TavernAI/TavernAI/archive/refs/heads/main.zip)
2. Run Start.bat or use command: *node server.js* 2. Install [Node.js v19.1.0](https://nodejs.org/download/release/v19.1.0/)
## Connecting to API 3. Run Start.bat (or use command: *node server.js*)
### KoboldAI ## AI Models
To use KoboldAI install it locally, or run it through Google Colab. Details: [KoboldAI](https://github.com/KoboldAI/KoboldAI-Client) * [KoboldAI](https://github.com/KoboldAI/KoboldAI-Client)
### KoboldAI Settings * [NovelAI](https://novelai.net/)
In most cases, you can use available presets in TavernAI for any models, making minimal changes. Later they will be calibrated more accurately for each model.
<br><br>It is recommended either not to use Repetition Penalty at all, or to set the minimum value in the region of 1.01 - 1.05 for small models. Also, highly strict sample settings force the AI to answer less long and more monosyllabic messages. Accordingly, settings with minimal sampling will produce longer, but less logical messages.
<br><br>It's a little harder for Nerys to understand the chat format than Erebus models.
## Compatibility
Tested on Windows 7/10 x64 (FireFox 108.0, Google Chrome 108.0, Microsoft Edge 108.0)
## Additionally Tips ## Tips
Use this button to edit the message<br><br>
<img src="readme/3.png" width="600" /><br><br>
If the message is not finished, you can simply send the request again, TavernAI will understand that this is a continuation.<br> If the message is not finished, you can simply send the request again, TavernAI will understand that this is a continuation.<br>
<br><img src="readme/2.png" width="600" /> <br><img src="readme/2.png" width="600" />
<br>Later, it is planned to make TavernAI combine such messages into one. ## Additional materials
## What's next? https://www.reddit.com/user/Crataco/comments/zuowi9/opensource_chatbot_companions/
* Ability to create an examples of a character's messages ## For thanks and support
* Wildcards for characters TavernAI is being developed with love and care on a voluntary basis. If you like the project and want to support it, your donation would make a huge impact!
* Ability to edit all messages
* Displaying whether a message is in context or not
* Access for many chats for one character
* Design presets
## Donation
BTC 1LASziomyYNkZ2zk8Sa4ZLTkvczBMrjyjP<br> BTC 1LASziomyYNkZ2zk8Sa4ZLTkvczBMrjyjP<br>
ETH 0x975E5C91042ce8168B3d37b17F99949c5eFB3Dfe<br> ETH 0x975E5C91042ce8168B3d37b17F99949c5eFB3Dfe<br>
TRX TCiBKCt6xEGrsjpgQA2jDXWJLyUh1KN2Sn TRX TCiBKCt6xEGrsjpgQA2jDXWJLyUh1KN2Sn

BIN
readme/3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

BIN
readme/4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 195 KiB

BIN
readme/5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 187 KiB