pennylane-braket

This section contains the API documentation for the PennyLane-Braket plugin.

Warning

Unless you are a PennyLane plugin developer, you likely do not need to use these classes and functions directly.

See the overview page for more details using the available Braket devices with PennyLane.

Classes

AAMS(phi_0, phi_1, theta, wires)

IonQ native Arbitrary-Angle Mølmer-Sørenson gate.

BraketAwsAhsDevice(wires, device_arn[, ...])

Amazon Braket AHS device for hardware in PennyLane.

BraketAwsQubitDevice(wires, device_arn[, ...])

Amazon Braket AwsDevice qubit device for PennyLane.

BraketLocalAhsDevice(wires, *[, shots])

Amazon Braket LocalSimulator AHS device for PennyLane.

BraketLocalQubitDevice(wires[, backend, shots])

Amazon Braket LocalSimulator qubit device for PennyLane.

CPhaseShift00(phi, wires)

Controlled phase shift gate phasing the \(| 00 \rangle\) state.

CPhaseShift01(phi, wires)

Controlled phase shift gate phasing the \(| 01 \rangle\) state.

CPhaseShift10(phi, wires)

Controlled phase shift gate phasing the \(| 10 \rangle\) state.

GPi(phi, wires)

IonQ native GPi gate.

GPi2(phi, wires)

IonQ native GPi2 gate.

MS(phi_0, phi_1, wires)

IonQ native Mølmer-Sørenson gate.

PSWAP(phi, wires)

Phase-SWAP gate.

Class Inheritance Diagram

digraph inheritancecca6c522ce { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "AAMS" [URL="code/api/braket.pennylane_plugin.AAMS.html#braket.pennylane_plugin.AAMS",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="AAMS(phi_0, phi_1, theta, wires)"]; "Operation" -> "AAMS" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ABC" [color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,tooltip="Helper class that provides a standard way to create an ABC using"]; "BraketAhsDevice" [color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,tooltip="Abstract Amazon Braket device for analog Hamiltonian simulation with PennyLane."]; "QubitDevice" -> "BraketAhsDevice" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BraketAwsAhsDevice" [URL="code/api/braket.pennylane_plugin.BraketAwsAhsDevice.html#braket.pennylane_plugin.BraketAwsAhsDevice",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="Amazon Braket AHS device for hardware in PennyLane."]; "BraketAhsDevice" -> "BraketAwsAhsDevice" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BraketAwsQubitDevice" [URL="code/api/braket.pennylane_plugin.BraketAwsQubitDevice.html#braket.pennylane_plugin.BraketAwsQubitDevice",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="Amazon Braket AwsDevice qubit device for PennyLane."]; "BraketQubitDevice" -> "BraketAwsQubitDevice" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BraketLocalAhsDevice" [URL="code/api/braket.pennylane_plugin.BraketLocalAhsDevice.html#braket.pennylane_plugin.BraketLocalAhsDevice",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="Amazon Braket LocalSimulator AHS device for PennyLane."]; "BraketAhsDevice" -> "BraketLocalAhsDevice" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BraketLocalQubitDevice" [URL="code/api/braket.pennylane_plugin.BraketLocalQubitDevice.html#braket.pennylane_plugin.BraketLocalQubitDevice",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="Amazon Braket LocalSimulator qubit device for PennyLane."]; "BraketQubitDevice" -> "BraketLocalQubitDevice" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BraketQubitDevice" [color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,tooltip="Abstract Amazon Braket qubit device for PennyLane."]; "QubitDevice" -> "BraketQubitDevice" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CPhaseShift00" [URL="code/api/braket.pennylane_plugin.CPhaseShift00.html#braket.pennylane_plugin.CPhaseShift00",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="CPhaseShift00(phi, wires)"]; "Operation" -> "CPhaseShift00" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CPhaseShift01" [URL="code/api/braket.pennylane_plugin.CPhaseShift01.html#braket.pennylane_plugin.CPhaseShift01",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="CPhaseShift01(phi, wires)"]; "Operation" -> "CPhaseShift01" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CPhaseShift10" [URL="code/api/braket.pennylane_plugin.CPhaseShift10.html#braket.pennylane_plugin.CPhaseShift10",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="CPhaseShift10(phi, wires)"]; "Operation" -> "CPhaseShift10" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Device" [color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,tooltip="Abstract base class for PennyLane devices."]; "ABC" -> "Device" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GPi" [URL="code/api/braket.pennylane_plugin.GPi.html#braket.pennylane_plugin.GPi",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="GPi(phi, wires)"]; "Operation" -> "GPi" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GPi2" [URL="code/api/braket.pennylane_plugin.GPi2.html#braket.pennylane_plugin.GPi2",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="GPi2(phi, wires)"]; "Operation" -> "GPi2" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MS" [URL="code/api/braket.pennylane_plugin.MS.html#braket.pennylane_plugin.MS",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="MS(phi_0, phi_1, wires)"]; "Operation" -> "MS" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Operation" [color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,tooltip="Base class representing quantum gates or channels applied to quantum states."]; "Operator" -> "Operation" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Operator" [color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,tooltip="Base class representing quantum operators."]; "ABC" -> "Operator" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PSWAP" [URL="code/api/braket.pennylane_plugin.PSWAP.html#braket.pennylane_plugin.PSWAP",color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="PSWAP(phi, wires)"]; "Operation" -> "PSWAP" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QubitDevice" [color=lightskyblue1,fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,tooltip="Abstract base class for PennyLane qubit devices."]; "Device" -> "QubitDevice" [arrowsize=0.5,style="setlinewidth(0.5)"]; }