https://github.com/parisneo/petals_server

A FastAPI server for petals
https://github.com/parisneo/petals_server

Last synced: 21 days ago
JSON representation

A FastAPI server for petals

• Host: GitHub
• URL: https://github.com/parisneo/petals_server
• Owner: ParisNeo
• License: apache-2.0
• Created: 2024-01-14T10:15:32.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-02-19T23:23:25.000Z (11 months ago)
• Last Synced: 2024-10-31T11:29:02.442Z (2 months ago)
• Language: Python
• Size: 13.7 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🌺 **Petals Server**

![Petals Logo](.png)

**One decentralized tool for text generation and community collaboration**

## Table of Contents

1. [Introduction](#intro)

2. [Requirements](#requirements)

3. [Installation](#installation)

4. [Usage](#usage)

5. [License](#license)

6. [Contact](#contact)

7. [Endpoints](#endpoints)

---

## 🌺 **Introduction** ()

Petals is a decentralized text generation network designed to connect users with large language models, allowing them to harness the power of the community for efficient and collaborative text generation. With Petals Server, you can share your hardware resources (CPU and GPU) to contribute to the network while also utilizing it to generate text on demand.

---

## 🌺 **Requirements** ()

To get started with Petals Server, ensure you have the following prerequisites:

- Git for cloning the repository

- Python 3.11 or higher

- Operating system: Linux, macOS, or Windows with WSL (Windows Subsystem for Linux)

---

## 🌺 **Installation** ()

Follow these steps to install Petals Server on your local machine:

1. Clone the Git repository using `git clone https://github.com/ParisNeo/petals_server.git`

2. Navigate into the cloned directory (`cd petals_server`)

3. Install dependencies with pip by running `pip install -e .`

4. Launch the server with `petals_server`

---

## 🌺 **Usage** ()

Once installed, you can use Petals Server as a decentralized text generation client and contribute your hardware resources to the network.

---

## 🌺 **License** ()

Petals Server is licensed under the [Apache License v2.0](https://www.apache.org/licenses/LICENSE-2.0).

---

## 🌺 **Contact** ()

For any queries or feedback, reach out to ParisNeo on Twitter (@SpaceNerduino), Discord (https://discord.gg/BDxacQmv), or subscribe to the r/lollms Subreddit for community updates and discussions.

---

## 🌺 **Endpoints** ()

To explore all available endpoints, navigate to `http://localhost:8000/docs`.