Skip to main content

Autonomous quantum AI research agent

Project description

QuantumMetaGPT

License: Commercial Python 3.10+ Qiskit Documentation

Autonomous Quantum AI Research Agent

QuantumMetaGPT is a cutting-edge system that combines reinforcement learning, large language models, and quantum computing to automatically generate, optimize, and evaluate quantum algorithms.

🚀 Quick Start

Installation

# Install QuantumMetaGPT
pip install quantummetagpt

# Get your machine ID for licensing
python -c "import qmetagpt; print(f'Machine ID: {qmetagpt.get_machine_id()}')"

# Contact bajpaikrishna715@gmail.com with your machine ID for license

Basic Usage

import qmetagpt
import numpy as np

# Initialize RL agent
agent = qmetagpt.PPOAgent(state_dim=8, action_dim=12)
agent.build_model()

# Generate quantum circuit
task_state = np.array([1, 0, 1, 0, 0, 1, 1, 0])
circuit = agent.generate_circuit(task_state)

# Evaluate performance
evaluator = qmetagpt.QuantumEvaluator()
results = evaluator.evaluate(circuit, shots=1024)

print(f"Fidelity: {results['fidelity']:.4f}")

📚 Documentation

Comprehensive Documentation Available

Our complete documentation is available at: https://yourusername.github.io/QuantumMetaGPT/

Documentation Sections

🛠️ Building Documentation Locally

To build and serve the documentation locally:

# Install documentation dependencies
pip install mkdocs mkdocs-material

# Clone repository
git clone https://github.com/yourusername/QuantumMetaGPT.git
cd QuantumMetaGPT

# Serve documentation locally
mkdocs serve
# Visit http://127.0.0.1:8000

# Build static documentation
mkdocs build
# Output in site/ directory

🚀 Deploy Documentation to GitHub Pages

The repository includes automatic GitHub Pages deployment:

  1. Enable GitHub Pages in repository settings
  2. Set source to "GitHub Actions"
  3. Push to main branch - documentation deploys automatically

The GitHub Actions workflow (.github/workflows/docs.yml) handles:

  • Automatic builds on push to main
  • Validation of documentation
  • Deployment to GitHub Pages
  • Link checking and quality assurance

🏗️ Architecture

graph TB
    A[Task Input] --> B[Task Synthesizer]
    B --> C[LLM Paper Parser]
    C --> D[Algorithm Generator]
    D --> E[RL Agents]
    E --> F[Quantum Circuits]
    F --> G[Evaluation Engine]
    G --> H[Optimizer Engine]
    H --> I[Report Generator]
    I --> J[Results Output]
    
    subgraph "License Protection"
    K[License Enforcer]
    K -.-> C
    K -.-> D
    K -.-> E
    K -.-> G
    K -.-> H
    K -.-> I
    end

Set environment variables

export IBMQ_TOKEN="your_ibmq_token" export OPENAI_API_KEY="your_openai_key"

Generate license

python -m qmetagpt.security_licensing.cli_license generate Usage python from QuantumMetaGPT import run_pipeline

Run full pipeline

run_pipeline(arxiv_id="quant-ph/2310.12345")


### Module Structure

```plaintext
quantummetagpt/
├── llm_paper_parser       # arXiv paper processing
├── task_synthesizer       # Quantum task formalization
├── quantum_algorithm_generator  # RL-based circuit generation
├── optimizer_engine       # Hybrid quantum-classical optimization
├── evaluation_engine      # Quantum hardware evaluation
├── report_generator       # Scientific report creation
├── security_licensing     # License management
└── utils                  # Logging and error handling

Contributing Contributions are welcome! Please see our contribution guidelines.

License Commercial license required. See LICENSE for details.

CONTRIBUTING.md

# Contribution Guidelines

We welcome contributions to QuantumMetaGPT! Please follow these guidelines:

## Development Setup
1. Fork the repository
2. Clone your fork: `git clone https://github.com/yourusername/QuantumMetaGPT.git`
3. Create a virtual environment: `python -m venv venv`
4. Activate environment: `source venv/bin/activate`
5. Install dependencies: `pip install -r requirements-dev.txt`

## Coding Standards
- Follow PEP 8 style guide
- Use type hints for all function signatures
- Document public methods with docstrings
- Write unit tests for new features
- Keep modules focused and cohesive

## Testing
Run the test suite with:
```bash
pytest --cov=qmetagpt --cov-report=html
Pull Requests
Create a new branch for your feature: git checkout -b feature-name

Implement your changes with tests

Ensure all tests pass: pytest

Update documentation if needed

Submit a pull request to the main repository

Reporting Issues
Please use GitHub issues to report bugs or request features. Include:

Detailed description of the issue

Steps to reproduce

Expected vs actual behavior

Environment details


### 16. `LICENSE`
```text
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution...

[Standard Apache 2.0 License Text]
17. .env.example
env
# IBM Quantum credentials
IBMQ_TOKEN="your_ibmq_token"

# OpenAI API
OPENAI_API_KEY="your_openai_key"

# LLM configuration
LLM_MODEL="gpt-4"
LLM_TEMPERATURE=0.7

# Quantum backend
QUANTUM_BACKEND="ibmq_manila"
USE_HARDWARE=false
SHOTS=1024

# RL training
RL_AGENT="PPO"
RL_TIMESTEPS=50000

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quantummetagpt-1.0.0.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quantummetagpt-1.0.0-py3-none-any.whl (30.9 kB view details)

Uploaded Python 3

File details

Details for the file quantummetagpt-1.0.0.tar.gz.

File metadata

  • Download URL: quantummetagpt-1.0.0.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for quantummetagpt-1.0.0.tar.gz
Algorithm Hash digest
SHA256 02125658d4274cbc9a4ba1fe14fc20988fe3281946141217e168f0cf9bdd1e12
MD5 c766add963716219f2f9e4f123bfbb6c
BLAKE2b-256 79b0c3ebd046c1ff1208dc3968af6bab293ab86670c69f14a51a347963fab9b9

See more details on using hashes here.

File details

Details for the file quantummetagpt-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: quantummetagpt-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 30.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for quantummetagpt-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 664e6a5ade12fe69d66115e7eff2af4a11f0e046f9be552f7231cbd086b32633
MD5 466a6efdd2e6e3eafc7b8296b9a11669
BLAKE2b-256 a55b83f40b7b6184972da2423e455d025b23104ce5de64d35965a618bc52ba6b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page