Build status:

CUDA support for Yao.jl.

Only tested locally, expect some adventures and rough edges.


CuYao is a   Julia Language   package. It provides CUDA support for Yao.jl. To install CuYao, please open Julia's interactive session (known as REPL) and press ] key in the REPL to use the package mode, then type the following command

For stable release

pkg> add CuYao

For current master

pkg> add CuYao#master

You don't need to install Yao if you have CuYao installed. They share the same API except CUDA backend.


For documentation of Yao, please refer to documentation (stable).

CuYao.jl provides only two extra APIs, reg |> cu to upload a register to GPU, and cureg |> cpu to download a register to CPU.

To start, see the following example

using CuYao

cureg = rand_state(9; nbatch=1000) |> cu   # or `curand_state(9; nbatch=1000)`.
cureg |> put(9, 2=>Z)
measure!(cureg |> append_qubits!(1) |> focus!(4,1,3))
cureg |> relax!(4,1,3) |> cpu

Constructors curand_state, cuzero_state, cuproduct_state, cuuniform_state and cughz_state are tailored for GPU, they are faster than uploading a CPU register to CPU.


Supported Gates

  • general U(N) gate
  • general U(1) gate
  • better X, Y, Z gate
  • better T, S gate
  • SWAP gate
  • better control gates
  • BP diff blocks

Supported Register Operations

  • measure!, measure_reset!, measure_remove!, select
  • append_qudits!, append_qubits!
  • insert_qudit!, insert_qubits!
  • focus!, relax!
  • join
  • density_matrix
  • fidelity (not including density matrix)
  • expect

Other Operations

  • autodiff is supported when the only parameterized gates are rotation gates in a circuit.

The Team

This project is an effort of QuantumBFS, an open source organization for quantum science. Yao is currently maintained by Xiu-Zhe (Roger) Luo and Jin-Guo Liu with contributions from open source community. All the contributors are listed in the contributors.


CuYao is released under the Apache 2 license.