API Reference

This section contains the detailed Python API reference for the Quantum Rings SDK.

If you are looking for “how to” guidance (recommended learning path), start with:

• Quick Start (5 Minutes)

• Backends

• Circuits

• Primitives (Toolkit for Qiskit)

Core SDK API (QuantumRingsLib)

Core SDK API overview: QuantumRingsLib

Backends

• QuantumRingsProvider module
• BackendV2 module

Circuits and registers

• QuantumCircuit module
• QuantumRegister module
• AncillaRegister module
• ClassicalRegister module
• qasm2 module
• OptimizeQuantumCircuit module

Jobs and results

• job_monitor module
• JobV1 module
• Result module

Parameters

• Parameter module
• ParameterVector module

Qiskit Toolkit API (quantumrings-toolkit-qiskit)

Toolkit API overview: Quantum Rings Toolkit for Qiskit

For setup and usage guidance, see Toolkit for Qiskit.

Backends and runtime

• QrRuntimeService module
• QrBackendV2 module
• QrSession module

Primitives (Sampler / Estimator)

• QrSamplerV1 module (for Qiskit 1.x versions)
• QrSamplerV2 module
• QrEstimatorV1 module (for Qiskit 1.x versions)
• QrEstimatorV2 module
• QrStatevector module
• QrStatevectorSampler module
• QrStatevectorEstimator module

Jobs

• QrJobV1 module

Machine learning (Qiskit 1.x)

• QrEstimatorQNN module
• QrSamplerQNN module
• QrFidelityQuantumKernel module
• QrTrainableFidelityQuantumKernel module

Return to Quantum Rings SDK Documentation.