ExternalVendorCode/lollms-webui
1
0
Fork 0
mirror of https://github.com/ParisNeo/lollms-webui.git synced 2024-12-19 20:37:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update noobs_tutorial.md

Browse Source
This commit is contained in:
Saifeddine ALOUI 2023-10-27 09:33:03 +02:00 committed by GitHub
parent 606c279247
commit 576c00ede5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 165 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

175
docs/tutorials/noobs_tutorial.md
View File

@ -10,23 +10,172 @@ Welcome to the LOLLMS WebUI tutorial! In this tutorial, we will walk you through
## Download and Launch the Tool
1. Visit the GitHub repository page at [github.com/ParisNeo/lollms-webui](https://github.com/ParisNeo/lollms-webui).
2. Click on the "Latest Release" button.
3. Depending on your platform, download either `webui.bat` for Windows or `webui.sh` for Linux.
3. Depending on your platform, download either `win_install.bat` for Windows or `linux_install.sh` for Linux or `macos_install.sh` for MacOS.
4. Choose a folder on your system to install the application launcher. For example, you can create a folder named `lollms-webui` in your `ai` directory.
5. Run the downloaded script (application launcher). Note: Some antivirus programs or Windows Defender might display a warning due to the tool's reputation. This warning is a false positive caused by the tool being relatively new. You can ignore the warning and proceed with the installation.
6. The installer will no longer prompt you to install the default model. This step will be performed in the UI, making it easier for you.
5. Run the downloaded script. Note: Some antivirus programs or Windows Defender might display a warning due to the tool's reputation. This warning is a false positive caused by the tool being relatively new. You can ignore the warning and proceed with the installation.
6. The installer will prompt you to choose either to install using CPU or one of the GPU options.
7. The installer will no longer prompt you to install the default model. This step will be performed in the UI, making it easier for you.
## Exploring the User Interface
1. The UI provides both light mode and dark mode themes for your preference.
2. You can access the GitHub repository directly from the UI.
3. On the left side, you will find the discussions panel, and the center side displays the messages flow.
2. On the top, under the application logo and slogan, you can find the tabs. Each tab allows you to access a specific functionality.
3. You can access the GitHub repository directly from the UI.
4. You can also access all ParisNeo socials to find videos and tutorials on LoLLMs use on the top right of the page.
5. On the left side, you will find the discussions panel, and the center side displays the messages flow.
## Main settings
LoLLMs main configuration section offers many options to control the discussion behavior.
### Main Configuration Page - General
The general section of the main configuration page offers several settings to control the LoLLMs server and client behavior. Notice that the database is stored on the client side.
#### Host
- Description: The host address of the LoLLMs server.
- Type: Text
- Required: Yes
- Default Value: None
- Example: `localhost`
#### Port
- Description: The port number to connect to the LoLLMs server.
- Type: Number
- Required: Yes
- Default Value: None
- Example: `8080`
#### Database Path
- Description: The path to the database file on the client side.
- Type: Text
- Required: Yes
- Default Value: None
- Example: `/path/to/database.db`
#### Auto Show Browser
- Description: Automatically show the browser when the LoLLMs server is started.
- Type: Checkbox
- Required: Yes
- Default Value: None
- Example: Checked or Unchecked
#### Enable GPU
- Description: Enable the use of GPU for processing.
- Type: Checkbox
- Required: Yes
- Default Value: None
- Example: Checked or Unchecked
- Note: If GPU is enabled, the "Upgrade from CPU to GPU" button will be displayed.
#### Auto Save
- Description: Automatically save changes made in the LoLLMs application.
- Type: Checkbox
- Required: Yes
- Default Value: None
- Example: Checked or Unchecked
#### Auto Update
- Description: Automatically update the LoLLMs application.
- Type: Checkbox
- Required: Yes
- Default Value: None
- Example: Checked or Unchecked
### User Configuration Page
The user section of the main configuration page allows you to customize your user information and preferences.
#### User Name
- Description: Your user name.
- Type: Text
- Required: Yes
- Default Value: None
- Example: "JohnDoe"
#### User Description
- Description: A description or biography about yourself.
- Type: Text
- Required: Yes
- Default Value: None
- Example: "I am a research engineer with a passion for artificial intelligence."
#### Use User Description in Discussion
- Description: Whether to use your user description in discussions.
- Type: Checkbox
- Required: Yes
- Default Value: None
- Example: Checked or Unchecked
#### User Avatar
- Description: Your user avatar or profile picture.
- Type: File
- Required: No
- Default Value: None
- Example: [Upload Avatar]
#### Use User Name in Discussions
- Description: Whether to use your user name in discussions.
- Type: Checkbox
- Required: Yes
- Default Value: None
- Example: Checked or Unchecked
### Main Configuration Page - Data Vectorization
The data vectorization section is used to configure various settings related to data vectorization. Here is a breakdown of the available options:
1. **Activate files support**: This option allows you to enable or disable support for files in the data vectorization process. When enabled, the system will include files in the vectorization process.
2. **Activate discussion vectorization**: This option enables or disables the vectorization of discussions. When enabled, discussions will be included in the vectorization process.
3. **Show vectorized data**: This option determines whether the vectorized data will be displayed or not.
4. **Activate data Vectorization**: This option enables or disables data vectorization. When enabled, data vectorization will be performed.
5. **Build keywords when querying the vectorized database**: This option determines whether keywords should be built when querying the vectorized database.
6. **Data vectorization method**: This option allows you to select the data vectorization method. The available options are `tfidf Vectorizer` and `Model Embedding`.
7. **Data visualization method**: This option allows you to select the data visualization method. The available options are `PCA` and `TSNE`.
8. **Save the new files to the database**: This option determines whether the new files should be saved to the database.
9. **Data vectorization chunk size(tokens)**: This option allows you to set the size of each chunk used for data vectorization.
10. **Data vectorization overlap size(tokens)**: This option allows you to set the overlap size between each chunk used for data vectorization.
11. **Number of chunks to use for each message**: This option allows you to specify the number of chunks to use for each message.
### Main Configuration Page - Audio
The audio section is used to configure various settings related to audio. Here is a breakdown of the available options:
1. **Send audio input automatically**: This option allows you to enable or disable automatic sending of audio input. When enabled, the system will automatically send audio input.
2. **Enable auto speak**: This option enables or disables the auto speak feature. When enabled, the system will automatically speak the responses.
3. **Audio pitch**: This option allows you to set the pitch of the audio.
4. **Audio in silence timer (ms)**: This option allows you to set the duration of silence in milliseconds before the audio input is considered complete.
5. **Input Audio Language**: This option allows you to choose the language for the input audio.
6. **Output Audio Voice**: This option allows you to choose the voice for the output audio.
## Binding Selection and Installation
1. To select and install a binding, navigate to the "Settings" tab.
2. Open the "Bindings Zoo" section.
3. Choose a binding from the provided list. For example, select "gpt4all".
4. If the binding was not already installed, please press install button and wait. You can check the installation progress in the console.
5. After the installation is complete, you can select the model by pressing the model card.
## Model Selection and Installation
1. To select and install a model for a specific binding, navigate to the "Settings" section.
1. To select and install a model for a specific binding, navigate to the "Settings" tab.
2. Open the "Models Zoo" tab.
3. Choose a binding from the provided list. For example, select "llama-cpp-official".
4. The first time you select a binding, you need to wait as it gets installed. You can check the installation progress in the console.
5. After the installation is complete, click "Install" next to a model you want to use and wait for the installation process to finish.
6. Note that clicking "Apply Changes" does not save the configuration. To save the changes, click the "Save" button and confirm.
3. You should find multiple models, if the one you are seeking does not exist, make sure you download it first by pressing the menue in the model card and selecting Download. You will be prompted to select a version of the model (in general it is just a quantization level for GGML/GGUF models and a single model.safetensor option for the others).
4. Once installed, you can select the model by checking the selection checkbox.
5. Depending on your main configuration settings, clicking "Apply Changes" may not save the configuration automatically. Make sure you check the autosave option in the main configurations sub section if you don't want to press save for each step. Since v 6.5, this is enabled by default.
6. If the auto save is not selected, to save the changes, click the "Save" button and confirm.
## Personality Selection and Installation
1. To select and mount a personality, navigate to the "Settings" tab.
2. Open the "Personalities Zoo" tab.
3. Either search for a personality by typing in the search text box, or just select a category.
4. To mount a personality, in the personality card, you can find a menu button. Click it and press mount.
5. If the personality needs installation, first press install, then, once installed, you can press mount.
6. You can mount any number of personalities to be used in your discussions
## Starting a Discussion
1. Return to the discussions view.
@ -34,6 +183,12 @@ Welcome to the LOLLMS WebUI tutorial! In this tutorial, we will walk you through
3. You will see a predefined welcome message based on the selected personality configuration. By default, the LoLLMs personality is used, which aims to be helpful.
4. Enter your query or prompt. For example, you can ask, "Who is Abraham Lincoln?"
5. You can stop the generation at any time by clicking the "Stop Generating" button.
6. You can view the current model and the current personality in the chatbox on the left
7. You can switch model by hovering on top of current model which causes the apearance of the other models as icons, then you can select the model you want
8. You can switch personality by hivering on top of the current personality which causes the apearance of the other mounted personalities as icons, then you can select the personality you want.
9. In a discussion, you can use multiple personas.
10. There is always a lead persona for the current discussion which is the one that shows its welcome message. So if you want a new discussion with a different persona, just select it and then press + to start a new discussion.
## Interacting with the Model
1. Once the generation is complete, you will see the generated response from the model.