Welcome to Quantum Rings SDK documentation!

Getting Started

• Setup and install the SDK
  • Choosing the correct version
  • Minimum System Requirements
  • NVIDIA GPU Support
• Installation Procedure for CPU only Mode
  • Microsoft Windows
  • macOS Sequoia or later
  • Google Colab
  • Linux or GB10
• Installation Procedure for GPU Enabled Mode
  • Using the GPU Mode
  • Installing on an AWS SageMaker instance
  • Using a hybrid Mode
• Installing the toolkit for Qiskit
  • Supported Qiskit version
  • Checking the QuantumRingsLib version
  • Installing the toolkit
    • Qiskit 2.x users
    • Qiskit 1.x users
• Installing the Quantum Rings SDK for NVIDIA CUDA-Q
  • A note on using the GPU Mode

Core Concepts

• Using the Core SDK
  • Obtaining the backend for execution
  • Executing the Code
  • Importing QASM2 code
  • Using c_if control statements
  • Generating equivalent QASM2 code
  • Creating Parameterized Quantum Circuits
• Using the toolkit for qiskit
  • Using the Sampler
  • Using the Estimator
  • Using the Statevector Sampler
  • Using the Statevector Estimator

Tutorials

• Saving the Quantum Rings account locally
• Changing the precision
• Selecting the backend
• options and run_options for the Sampler and Estimator classes
• Executing Sycamore Circuits

Example Programs

• Quantum Rings Core SDK Examples
• Toolkit for Qiskit Examples from Qiskit Tutorials
  • Basic Usage
  • Qiskit Examples
  • Qiskit Finance Package
  • Qiskit Nature Package
  • Qiskit Optimization Package

API Reference

• Python API Reference
  • QuantumRingsLib
    • AncillaRegister module
    • BackendV2 module
    • ClassicalRegister module
    • job_monitor module
    • JobV1 module
    • OptimizeQuantumCircuit module
    • Parameter module
    • ParameterVector module
    • qasm2 module
    • QuantumCircuit module
    • QuantumRegister module
    • QuantumRingsProvider module
    • Result module
  • Quantum Rings Toolkit for Qiskit
    • QrBackendV2 module
    • QrEstimatorV1 module (for Qiskit 1.x versions)
    • QrEstimatorV2 module
    • QrJobV1 module
    • QrSamplerV1 module (for Qiskit 1.x versions)
    • QrSamplerV2 module
    • QrStatevector module
    • QrStatevectorSampler module
    • QrStatevectorEstimator module
    • QrSession module
    • QrRuntimeService module
  • Quantum Rings Toolkit for Qiskit 1.x - Machine Learning Package
    • QrEstimatorQNN module
    • QrSamplerQNN module
    • QrFidelityQuantumKernel module
    • QrTrainableFidelityQuantumKernel module

Appendices

• Frequently Asked Questions
• Credits and Acknowledgements
• Bibliography
• License Terms
• Glossary