110 lines
3.5 KiB
Plaintext
110 lines
3.5 KiB
Plaintext
---
|
||
title: GenerativeNetwork
|
||
description: API reference for qiskit.aqua.components.neural_networks.GenerativeNetwork
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork
|
||
---
|
||
|
||
# GenerativeNetwork
|
||
|
||
<Class id="qiskit.aqua.components.neural_networks.GenerativeNetwork" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/neural_networks/generative_network.py" signature="GenerativeNetwork" modifiers="class">
|
||
Bases: `abc.ABC`
|
||
|
||
Base class for generative Quantum and Classical Neural Networks.
|
||
|
||
This method should initialize the module, but raise an exception if a required component of the module is not available.
|
||
|
||
## Methods
|
||
|
||
### get\_output
|
||
|
||
<Function id="qiskit.aqua.components.neural_networks.GenerativeNetwork.get_output" signature="GenerativeNetwork.get_output(quantum_instance, params, shots)" modifiers="abstract">
|
||
Apply quantum/classical neural network to given input and get the respective output
|
||
|
||
**Parameters**
|
||
|
||
* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – Quantum Instance, used to run the generator circuit.
|
||
* **params** (*numpy.ndarray*) – parameters which should be used to run the generator, if None use self.\_params
|
||
* **shots** (*int*) – if not None use a number of shots that is different from the number set in quantum\_instance
|
||
|
||
**Returns**
|
||
|
||
Neural network output
|
||
|
||
**Raises**
|
||
|
||
**NotImplementedError** – not implemented
|
||
</Function>
|
||
|
||
### loss
|
||
|
||
<Function id="qiskit.aqua.components.neural_networks.GenerativeNetwork.loss" signature="GenerativeNetwork.loss()" modifiers="abstract">
|
||
Loss function used for optimization
|
||
</Function>
|
||
|
||
### set\_discriminator
|
||
|
||
<Function id="qiskit.aqua.components.neural_networks.GenerativeNetwork.set_discriminator" signature="GenerativeNetwork.set_discriminator(discriminator)" modifiers="abstract">
|
||
Set discriminator network.
|
||
|
||
**Parameters**
|
||
|
||
**discriminator** (*Discriminator*) – Discriminator used to compute the loss function.
|
||
|
||
**Raises**
|
||
|
||
**NotImplementedError** – not implemented
|
||
</Function>
|
||
|
||
### set\_seed
|
||
|
||
<Function id="qiskit.aqua.components.neural_networks.GenerativeNetwork.set_seed" signature="GenerativeNetwork.set_seed(seed)" modifiers="abstract">
|
||
Set seed.
|
||
|
||
**Parameters**
|
||
|
||
**seed** (*int*) – seed
|
||
|
||
**Raises**
|
||
|
||
**NotImplementedError** – not implemented
|
||
</Function>
|
||
|
||
### train
|
||
|
||
<Function id="qiskit.aqua.components.neural_networks.GenerativeNetwork.train" signature="GenerativeNetwork.train(quantum_instance=None, shots=None)" modifiers="abstract">
|
||
Perform one training step w\.r.t to the generator’s parameters
|
||
|
||
**Parameters**
|
||
|
||
* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – used to run generator network. Ignored for a classical network.
|
||
* **shots** (*int*) – Number of shots for hardware or qasm execution. Ignored for classical network
|
||
|
||
**Returns**
|
||
|
||
generator loss and updated parameters.
|
||
|
||
**Return type**
|
||
|
||
dict
|
||
|
||
**Raises**
|
||
|
||
**NotImplementedError** – not implemented
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### parameter\_values
|
||
|
||
<Attribute id="qiskit.aqua.components.neural_networks.GenerativeNetwork.parameter_values">
|
||
Get parameter values from the generator
|
||
|
||
**Raises**
|
||
|
||
**NotImplementedError** – not implemented
|
||
</Attribute>
|
||
</Class>
|
||
|