lollms/tests/endoints_unit_tests/node/README.md
Saifeddine ALOUI 8f32d26309 upgraded
2023-06-19 00:27:18 +02:00

2.0 KiB

# LoLLMs Endpoint Test Tool

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
  1. Navigate to the project directory.

    cd socketio-endpoint-test-tool
    
  2. Install the dependencies.

    npm install
    

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:

      lollms-server --host localhost --port 9600
      
    • To run the server on a different host and port:

      lollms-server --host mydomain.com --port 8080
      
    • For more information on the available options, you can use the --help flag:

      lollms-server --help
      
  2. Start the web server for the LoLLMs Endpoint Test Tool.

    npm start
    
  3. Open your web browser and visit http://localhost:8080/lollms_playground.html (or the appropriate URL) to access the LoLLMs Endpoint Test Tool.

  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.