Mirrors/text-generation-webui
1
0
Fork 0
mirror of https://github.com/oobabooga/text-generation-webui.git synced 2024-12-04 21:10:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Contributing guidelines (markdown)

oobabooga 2023-08-03 19:02:31 -03:00
parent 8094b16c93
commit 6387f55826
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Contributing-guidelines.md

@ -52,4 +52,20 @@ There are two main installation methods for this project:
1) Manual installation as described in the README.
2) The one-click-installers available at https://github.com/oobabooga/one-click-installers.
Some Docker files are available in the repository, but I do not use Docker. Pull requests about Docker should contain straightforward fixes or updates only.
Some Docker files are available in the repository, but I do not use Docker. Pull requests about Docker should contain straightforward fixes or updates only.
## Some important variables
* The `shared.settings` variable contains default values for Gradio components. It can be customized through a `settings.yaml` file.
* The `shared.args` variable contains the command-line arguments. They represent variables that need to be changed often.
* The chat history is represented as a dictionary with the following structure:
```python
{
'internal': [['hi', 'hey'], ['how are you?', "i'm fine, thanks!"]],
'visible': [['hi', 'hey'], ['how are you?', "i'm fine, thanks!"]]
}
```
Each row is in the format `[input, reply]`. `history['visible']` contains the messages as they will appear in the UI, and `history['internal']` contains the messages as they appear in the prompt. When no extension is used, the two will be identical, but many extensions add images, audio widgets, or translations to `history['visible']`.