/* Mintlify Layout Optimization */

/*
 * Work with Mintlify's default layout system to ensure proper content distribution
 * This maintains the "On this page" navigation while optimizing content width
 */

/* Allow content to use available space without breaking layout */
.prose {
  max-width: none !important;
}

/* Ensure the overall page layout uses full width */
.page-wrapper,
.docs-layout {
  max-width: none !important;
  width: 100% !important;
}




Quick Start

Welcome to the comprehensive documentation for **Qubots**, an open source optimization framework built from developers for developers, and **Rastion**, the collaborative platform that powers optimization research and development.

Qubots Optimization Framework & Rastion Platform

Qubots & Rastion

Qubots is a comprehensive optimization framework designed to simplify the development, testing, and deployment of optimization algorithms. It provides a unified interface for working with various types of optimization problems and algorithms, while enabling seamless integration with the Rastion platform for collaboration and competition.

Introduction

Get started with the Qubots optimization framework by following these simple installation steps.

Installation

The Qubots framework is built on a foundation of carefully considered design principles that ensure modularity, extensibility, consistency, and performance. These principles guide every aspect of the framework's architecture and implementation.

Design Principles

The `AutoProblem` class is one of the core components of the Qubots framework, providing automatic loading and management of optimization problems from Git repositories.

AutoProblem

The `AutoOptimizer` class is the companion to AutoProblem, providing automatic loading and management of optimization algorithms from Git repositories.

AutoOptimizer

The `BaseProblem` class is the foundation of all optimization problems in the Qubots framework. It provides a standardized interface, comprehensive metadata system, and advanced features for the Rastion ecosystem.

BaseProblem

The `BaseOptimizer` class is the foundation of all optimization algorithms in the Qubots framework. It provides a standardized interface, comprehensive metadata system, and advanced features for algorithm development and integration.

BaseOptimizer

Complete guide to qubots configuration files, parameter schemas, and best practices

Configuration System

The `benchmarking.py` module provides tools for rigorous performance evaluation of optimization algorithms. Run multiple trials, collect statistics, and compare algorithms scientifically.

Benchmarking

Execute your qubots optimizations in the cloud using the Rastion platform's playground infrastructure. The `playground_integration.py` module handles cloud execution, progress monitoring, and result retrieval.

Playground Integration

Quick start guide for creating and uploading qubots optimizers

Examples & Tutorials Overview

Learn how to create MaxCut problem and optimizer qubots, connect them, and run locally or on Rastion

Maximum Cut Problem Example

Learn how to create TSP problem and optimizer qubots, connect them, and run locally or on Rastion

Traveling Salesman Problem Example

Learn how to create VRP problem and optimizer qubots, connect them, and run locally or on Rastion

Vehicle Routing Problem Example

The collaborative optimization platform for researchers and developers

Rastion Platform Introduction

Sign in to Rastion using your GitHub account and get your API token for platform access

Login via GitHub

Learn the basics of using the Rastion platform

First Steps

Step-by-step guide to upload your optimization algorithms and problems to the Rastion platform

How to Upload a Qubot Repository to Rastion

Learn how to run your uploaded optimization algorithms and problems in Rastion's cloud playground

How to Use Your Qubot Repositories in the Playground

Learn how to create and share optimization experiments on Rastion for community collaboration and research

How to Create a Public Optimization Experiment

Learn how to create and publish standardized benchmarks for the optimization community

How to Create a Public Optimization Benchmark

Learn how to participate in optimization competitions and submit your algorithms to public leaderboards

How to Join a Public Leaderboard

Navigate and manage your optimization repositories with a GitHub-like interface

File Browser Interface

Interactive environment for testing and comparing optimization algorithms

Playground Overview

Compete on standardized optimization problems and track your performance

Leaderboard System Overview

Step-by-step guide to submitting your algorithms to leaderboards

Making Submissions

Standardized optimization problems for fair algorithm comparison

Benchmark Problems

Stay updated on platform activity and submission status

Getting Started

Core Concepts

Examples & Tutorials

Qubots Optimization Framework & Rastion Platform

Quick Start

Qubots Framework

Rastion Platform

Getting Started

Core Concepts

Examples & Tutorials

​Quick Start

Qubots Framework

Rastion Platform

Quick Start