NVIDIA cuQuantum
22.07.1

Contents

  • Overview
    • Introduction to quantum computing
      • Qubit
      • Multiple Qubits
      • Quantum Gates
      • Measurement
      • Quantum circuit
    • Quantum circuit simulation
    • References
    • Citing cuQuantum
  • Release Notes
    • cuQuantum SDK v22.07.1
    • cuQuantum SDK v22.07
    • cuQuantum SDK v22.05
    • cuQuantum SDK v22.03
    • cuQuantum SDK v0.1.1
    • cuQuantum SDK v0.1.0
  • cuStateVec
    • Release Notes
      • cuStateVec v1.1.0
      • cuStateVec v1.0.0
      • cuStateVec v0.1.1
      • cuStateVec v0.1.0
      • cuStateVec v0.0.1
    • Overview
      • Description of state vectors
      • Bit ordering
      • Supported data types
      • Workspace
      • Gate fusion
      • Multi-GPU Computation
      • References
    • Getting Started
      • Installation and Compilation
        • Linux
      • Code Example
      • Useful tips
    • API Reference
      • cuStateVec Data Types
        • Opaque Data Structures
        • Enumerators
      • cuStateVec Functions
        • Library Management
        • Gate Application
        • Measurement
        • Expectation
        • Sampling
        • Accessor
        • Qubit reordering
        • Matrix property testing
  • cuTensorNet
    • Release Notes
      • cuTensorNet v1.1.1
      • cuTensorNet v1.1.0
      • cuTensorNet v1.0.1
      • cuTensorNet v1.0.0
      • cuTensorNet v0.1.0
      • cuTensorNet v0.0.1
    • Overview
      • Introduction to tensor networks
        • Tensor and tensor network
        • Description of tensor networks
      • Contraction Optimizer
        • Graph partitioning
        • Slicing
        • Reconfiguration
        • Deferred rank simplification
      • Hyper-optimizer
      • Supported data types
      • References
    • Getting Started
      • Installation and Compilation
        • Linux
      • Code Example (Serial)
        • Headers and data types
        • Define tensor network and tensor sizes
        • Allocate memory and initialize data
        • cuTensorNet handle and network descriptor
        • Optimal contraction order and slicing
        • Create workspace descriptor and allocate workspace memory
        • Contraction plan and auto-tune
        • Network contraction execution
      • Code Example (Slice-based Parallelism)
      • Useful Tips
    • API Reference
      • cuTensorNet Data Types
        • cutensornetHandle_t
        • cutensornetLoggerCallback_t
        • cutensornetLoggerCallbackData_t
        • cutensornetStatus_t
        • cutensornetComputeType_t
        • cutensornetContractionOptimizerConfigAttributes_t
        • cutensornetContractionOptimizerInfoAttributes_t
        • cutensornetContractionAutotunePreferenceAttributes_t
        • cutensornetGraphAlgo_t
        • cutensornetMemoryModel_t
        • cutensornetOptimizerCost_t
        • cutensornetNetworkDescriptor_t
        • cutensornetContractionPlan_t
        • cutensornetNodePair_t
        • cutensornetContractionPath_t
        • cutensornetContractionOptimizerConfig_t
        • cutensornetContractionOptimizerInfo_t
        • cutensornetContractionAutotunePreference_t
        • cutensornetSliceGroup_t
        • cutensornetDeviceMemHandler_t
        • cutensornetWorkspaceDescriptor_t
        • cutensornetWorksizePref_t
        • cutensornetMemspace_t
        • cudaDataType_t
      • cuTensorNet Functions
        • Handle Management API
        • Network Descriptor API
        • Contraction Optimizer API
        • Contraction Plan API
        • Workspace Management API
        • Network Contraction API
        • Slice Group API
        • Memory Management API
        • Error Management API
        • Logger API
        • Versioning API
    • Acknowledgements
  • cuQuantum Python
    • Release Notes
      • cuQuantum Python v22.07.1
      • cuQuantum Python v22.07.0
      • cuQuantum Python v22.05.0
      • cuQuantum Python v22.03.0
      • cuQuantum Python v0.1.0.1
      • cuQuantum Python v0.1.0.0
    • Overview
      • Low-level Python bindings
        • Naming & calling convention
        • Memory management
        • Usage example
      • High-level pythonic APIs
        • Introduction
        • Usage example
        • Memory management
      • Circuit to tensor network converter
        • Introduction
        • Usage example
    • Getting Started
      • Documentation
      • Building
        • Requirements
        • Install cuQuantum Python from conda-forge
        • Install cuQuantum Python from PyPI
        • Install cuQuantum Python from source
      • Running
        • Requirements
        • Samples
      • Testing
      • Citing cuQuantum
    • Code of Conduct
      • Overview
      • Our Pledge
      • Our Standards
      • Our Responsibilities
      • Scope
      • Enforcement
      • Attribution
    • Contributing
    • API Reference
      • cuQuantum (cuquantum)
        • Python objects & constants
        • Python functions
      • cuStateVec (cuquantum.custatevec)
        • Python objects & constants
        • Python functions
      • cuTensorNet (cuquantum.cutensornet)
        • Python objects & constants
        • Python functions
  • cuQuantum Appliance
    • Release Notes
      • cuQuantum Appliance 22.07-Cirq
        • New features
        • Driver requirements
      • cuQuantum Appliance 22.03-Cirq
        • Resolved issues
      • cuQuantum Appliance 22.02-Cirq
        • Contents of the cuQuantum Appliance 22.02-Cirq container
        • Driver requirements
        • GPU Requirements
        • Known Limitations
    • Cirq
      • Notice
      • API Reference
        • qsimcirq.QSimOptions
    • Acknowledgements
  • Software License Agreement
    • NVIDIA cuQuantum SDK
    • NVIDIA cuQuantum Python
NVIDIA cuQuantum
  • »
  • cuQuantum Python: Python APIs for NVIDIA cuQuantum SDK »
  • API Reference
  • View page source

API Reference¶

This reference describes all Python components of the cuStateVec and cuTensorNet libraries.

cuQuantum (cuquantum)¶

  • Python objects & constants
    • Objects
    • Enums
  • Python functions
    • cuquantum.contract
    • cuquantum.contract_path
    • cuquantum.einsum
    • cuquantum.einsum_path

cuStateVec (cuquantum.custatevec)¶

  • Python objects & constants
    • Enums
  • Python functions
    • Library Management
    • Gate Application
    • Measurement
    • Expectation
    • Sampling
    • Accessor
    • Qubit reordering
    • Test gate matrix type

cuTensorNet (cuquantum.cutensornet)¶

  • Python objects & constants
    • Objects
    • Enums
  • Python functions
    • Handle Management API
    • Network Descriptor API
    • Contraction Optimizer API
    • Contraction Plan API
    • Workspace Management API
    • Memory Management API
    • Network Contraction API
    • Slice Group API
    • Versioning API
Previous Next

© Copyright 2022, NVIDIA Corporation & affiliates.

Built with Sphinx using a theme provided by Read the Docs.
NVIDIA cuQuantum v: 22.07.1