Skip to main content

Quick Start Guide

Synthonnel is Open Source, licensed under Creative Commons Attribution 4.0 International.

What is "Synthonnel"?​

Synthonnel is a portmanteau of synthetic personnel used to represent the concept of a personnel department to manage all the synthetic workers.

What is a "Parley"?​

The Parley is the whole multidimensional conversation of prompts and responses from the various active LLMs selected to participate.

So add a few models, ask a couple questions, receive your responses.. baby you got a Parley going!

Download the exe!​

  1. Download the release from GitHub.
  2. Unzip the file.
  3. Open the folder and double-click Synthonnel.exe
  4. Parley!

Install and Run Synthonnel from Source Code.​

Prerequisites​

  1. Ensure you have Git installed for downloading the source code.
  2. Make sure Python is installed on your system.
  3. It is recommended to use a virtual environment for managing project dependencies.

Step 1: Download Source from GitHub​

  1. Open a terminal and navigate to the desired directory.
  2. Run the following command to clone the repository:
git clone https://github.com/twadeclark/Synthonnel.git

Step 2: Create and Activate Virtual Environment​

  1. Create a virtual environment using the following command:
python -m venv venv
  1. Activate the virtual environment with the appropriate command based on your operating system:
  • Windows:
.\venv\Scripts\activate
  • macOS/Linux:
source venv/bin/activate

Step 3: Install Requirements​

  1. Install the required packages by running:
pip install -r requirements.txt

Step 4: Start FastAPI Backend​

  1. Start the FastAPI backend using the following command:
uvicorn main:app --reload

Step 5: Access the User Interface​

  1. Open your web browser and visit the following URL:
http://127.0.0.1:8000/

Step 6: Parley!​

Now you should be able to see and interact with Synthonnel. Enjoy!