Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_static/image/bg_model_logo_chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/image/model_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions docs/tech-report/config-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Introduction of config-template.yaml

`config-template.yaml` is a config file for OpenAOE both in frontend and backend settings.

In `config-template.yaml`, you can add/remove models from Web-UI as follows:
![](../_static/image/model_list.png)


## Structure
The `config-template.yaml` is structured as following:
1. `models`: the main entry for models setting.
2. `internlm-chat-7b` or `gpt-4`: the model name that will be displayed in WEB-UI
3. `provider`: the vendor who providers the model
4. `webui`: the setting for WEB-UI, which contains two elements:
1. `avatar`: the logo of the model, svg file is recommended
2. `backgroud`: define the backgroud style of the logo in the chat
![](../_static/image/bg_model_logo_chat.png)
5. `api`: the setting for backend apis, which contains several elements like:
1. `api_base`: the base url of the model's api
2. `api_key`: the access key for calling the model's api
3. `{user_customer_param}`: also, you can define your own parameters in yaml that can be called in code like this:
`get_model_configuration(PROVIDER_OPENAI, {user_customer_param})`
```yaml
---
models:
internlm-chat-7b:
provider: internlm
webui:
avatar: 'https://oss.openmmlab.com/frontend/OpenAOE/internlm.svg'
background: 'linear-gradient(rgb(3 26 108 / 85%) 0%, rgb(29 60 161 / 85%) 100%)'
api:
api_base: http://localhost:23333
gpt-4:
provider: openai
webui:
avatar: 'https://oss.openmmlab.com/frontend/OpenAOE/openai.svg'
background: 'linear-gradient(180deg, rgba(156, 206, 116, 0.15) 0%, #08be00 100%)'
api:
api_base: https://api.openai.com/v1
api_key:
{user_customer_param}:
...

```
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ def recursive_files(base_dir):

setup(
name='openaoe',
version='0.0.2',
version='0.0.3',
description='LLM Group Chat Framework: chat with multiple LLMs at the same time',
long_description=utils.get_file_content("README.md"),
long_description_content_type='text/markdown',
Expand Down