docs
Introduction

GSwarm - Gensyn RL Swarm Supervisor

⚠️ Important Notice: This is a third-party application

GSwarm is NOT affiliated with or endorsed by the official Gensyn team. This is an independent, community-developed supervisor tool designed to enhance the user experience of running Gensyn RL Swarm. We cannot modify the core RL Swarm functionality, training algorithms, or blockchain integration.

A robust Go-based supervisor for Gensyn RL Swarm that provides automatic restart capabilities, dependency management, comprehensive logging, and Telegram monitoring.

✨ Features

  • 🔄 Auto-restart: Automatically restarts the RL Swarm process on errors
  • 📊 Comprehensive Logging: Detailed logs with timestamps and process IDs
  • 🐍 Python Environment Management: Automatic Python dependency installation
  • 💬 Interactive CLI: Handles interactive prompts when flags are missing
  • Performance Monitoring: Real-time output streaming with error detection
  • 🛡️ Graceful Shutdown: Proper signal handling for clean process termination
  • 🚀 Dual Mode: Supports both command line flags and interactive prompts
  • 📱 Telegram Monitoring: Real-time blockchain activity notifications via Telegram

🚀 Quick Start

Prerequisites

  • Go 1.21+ (for building the supervisor)
  • Python 3.10+ (for the RL Swarm application)

Installation

Option 1: Install with Go (Recommended)

go install github.com/Deep-Commit/gswarm/cmd/gswarm@latest

This will place the gswarm binary in your $GOPATH/bin or $HOME/go/bin (make sure this is in your PATH).

Verify installation:

gswarm --version

Option 2: Clone and Build from Source

git clone https://github.com/Deep-Commit/gswarm.git
cd gswarm
make build
make install

After this, you can run gswarm from anywhere (if your Go bin directory is in your PATH).

Basic Usage

Navigate to your Gensyn RL Swarm directory (where your RL Swarm code and config are located):

cd /path/to/your/gensyn-rl-swarm

Run the supervisor:

gswarm

The supervisor will:

  • Automatically handle Python dependencies from requirements.txt or requirements-*.txt
  • Start and supervise the RL Swarm process with automatic restart on errors

📋 About This Project

Third-Party Status

GSwarm is an independent, community-developed tool that operates as a supervisor/wrapper around the official Gensyn RL Swarm application. We are not affiliated with the Gensyn team and cannot modify the core RL Swarm functionality.

What We Can Do

  • Process management and supervision
  • Environment setup and dependency management
  • Monitoring and logging
  • Configuration management
  • User experience improvements
  • Telegram monitoring and notifications

What We Cannot Do

  • Modify training algorithms
  • Change blockchain smart contracts
  • Alter model architectures
  • Modify core hivemind functionality
  • Change the official Gensyn protocol

Support

For issues related to the core RL Swarm application, please contact the official Gensyn team. For issues with GSwarm itself, please use our GitHub issues page.

💝 Support the Project

If you find GSwarm helpful and would like to support its development, consider making a donation:

Ethereum Address:

0xA22e20BA3336f5Bd6eCE959F5ac4083C9693e316

Your support helps us:

  • Maintain and improve the supervisor tool
  • Add new features and enhancements
  • Provide better documentation and support
  • Keep the project free and open source

Thank you for your support! 🙏

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔗 Related