mirror of
https://github.com/ParisNeo/lollms.git
synced 2025-02-27 19:45:40 +00:00
102 lines
3.8 KiB
Markdown
102 lines
3.8 KiB
Markdown
|
|
# LoLLMs Playground
|
|
|
|
<div align="center">
|
|
<img src="https://github.com/ParisNeo/lollms/blob/main/lollms/assets/logo.png" alt="Logo" width="200" height="200">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
[](https://discord.gg/4rR282WJb6)
|
|
[](https://twitter.com/SpaceNerduino)
|
|
[](https://www.youtube.com/user/Parisneo)
|
|
[](https://github.com/ParisNeo/lollms-playground/actions/workflows/pages/pages-build-deployment)
|
|
|
|
|
|
This tool provides a web-based interface to test LoLLMs endpoints and generate text using a LoLLMs server.
|
|
|
|
## Prerequisites
|
|
|
|
To use this tool, you need to have [Node.js](https://nodejs.org) installed on your machine.
|
|
|
|
## Installation
|
|
|
|
1. Clone this repository or download the source code.
|
|
|
|
```bash
|
|
git clone https://github.com/ParisNeo/lollms-playground.git
|
|
```
|
|
|
|
2. Navigate to the project directory (if you are not yet inside that directory).
|
|
|
|
```bash
|
|
cd lollms-playground
|
|
```
|
|
|
|
3. Install the dependencies.
|
|
|
|
```bash
|
|
npm install http-server
|
|
```
|
|
|
|
## Usage
|
|
|
|
1. Start the LoLLMs server. You can use `lollms-server` to run the server with the desired configuration. Here are a few examples:
|
|
|
|
- To run the server on `localhost` and port `9600`:
|
|
|
|
```bash
|
|
lollms-server --host localhost --port 9600
|
|
```
|
|
|
|
- To run the server on a different host and port:
|
|
|
|
```bash
|
|
lollms-server --host mydomain.com --port 8080
|
|
```
|
|
|
|
- For more information on the available options, you can use the `--help` flag:
|
|
|
|
```bash
|
|
lollms-server --help
|
|
```
|
|
|
|
2. Start the web server for the LoLLMs Endpoint Test Tool.
|
|
|
|
```bash
|
|
http-server
|
|
```
|
|
|
|
|
|
3. Open your web browser and visit `http://localhost:8080` (or the appropriate URL) to access the LoLLMs Endpoint Test Tool.
|
|
|
|
4. Press the icon to get to the connection ui.
|
|
|
|
|
|
4. Fill in the host and port fields with the appropriate values for your LoLLMs server.
|
|
|
|
5. Click the "Connect" button to establish a connection with the LoLLMs server.
|
|
|
|
|
|
6. Once connected, you can enter a prompt and click the "Generate Text" button to initiate text generation.
|
|
|
|
|
|
7. The generated text will be displayed in the output section of the page.
|
|
|
|
|
|
|
|
## Customization
|
|
|
|
You can customize the appearance and behavior of the tool by modifying the HTML, CSS, and JavaScript code in the `test_generation.html` file.
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! If you find any issues or want to add new features, feel free to open an issue or submit a pull request.
|
|
|
|
## License
|
|
|
|
This project is licensed under the [Apache 2.0](LICENSE).
|
|
```
|