qhana_plugin_runner
v1

Contents:

  • A Runner for QHAna Plugins
  • Writing Plugins
  • Writing Tests
  • Advanced Plugin Techniques
  • Special Plugin-Types
    • Quantum Circuit Executor Plugins
    • Minimizer Plugins
    • Objective Function Plugins
    • Interactions
  • Data Formats defined for QHAna Plugins
  • Cli Documentation of the Flask app
  • All Plugins
  • Architectural Decision Log
  • qhana_plugin_runner package
  • Changelog
qhana_plugin_runner
  • Special Plugin-Types
  • View page source

Special Plugin-Types

The main plugin types are covered by Writing Plugins. This document describes groups of plugins that implement a common interface and can be identified by the tags they use.

Interface

Tags

Description

Quantum Circuit Executor Plugins

circuit-executor, [qc-simulator]

A plugin that is capable of executing quantum circuits.

Minimizer Plugins

minimizer, [gradient]

A plugin that can minimize objective functions.

Objective Function Plugins

objective-function, [gradient]

A plugin that computes the value of an objective function used in an optimization process.

  • Quantum Circuit Executor Plugins
    • Interface
      • Main Interaction
      • Inputs
      • Outputs
      • Substeps
        • 1. "authentication" (optional)
      • Interaction Endpoints
        • devices (optional)
  • Minimizer Plugins
    • Interface
      • Main Interaction
      • Inputs
      • Outputs
      • Substeps
        • 1. optional plugin-specific steps
        • 2. "minimize" required
        • 3. optional plugin-specific steps
      • Interaction Endpoints
  • Objective Function Plugins
    • Interface
      • Main Interaction
      • Inputs
      • Outputs
      • Substeps
        • 1. optional plugin-specific steps
        • 2. "pass_data" required
        • 3. optional plugin-specific steps
        • 4. "evaluate" required
      • Interaction Endpoints
      • Task Specific Interaction Endpoints
        • of-weights (active during step 4)
        • of-evaluate (active during step 4)
        • of-evaluate-gradient (optional; active during step 4)
        • of-evaluate-combined (optional; active during step 4)
  • Interactions
    • Optimization Plugin Interaction (coarse)
    • Optimization Plugin Interaction (detailed)
Previous Next

© Copyright 2021, QHAna authors.

Built with Sphinx using a theme provided by Read the Docs.