squlearn.encoding_circuit.encoding_circuit_base.EncodingCircuitBase

class squlearn.encoding_circuit.encoding_circuit_base.EncodingCircuitBase(num_qubits: int, num_features: int)

Encoding circuit base class

Parameters:

  • num_qubits (int) – Number of Qubits of the encoding circuit

  • num_features (int) – Dimension of the feature vector

draw(output: str = None, feature_label: str = 'x', parameter_label: str = 'p', decompose: bool = False, **kwargs) → None

Draws the encoding circuit circuit using the QuantumCircuit.draw() function.

Parameters:

  • feature_label (str) – Label for the feature vector (default:”x”).

  • parameter_label (str) – Label for the parameter vector (default:”p”).

  • decompose (bool) – If True, the circuit is decomposed before printing (default: False).

  • kwargs – Additional arguments from Qiskit’s QuantumCircuit.draw() function.

Returns:

Returns the circuit in qiskit QuantumCircuit.draw() format

generate_initial_parameters(seed: int | None = None) → ndarray

Generates random parameters for the encoding circuit

Parameters:

seed (Union[int,None]) – Seed for the random number generator (default: None)

Returns:

The randomly generated parameters

get_circuit(features: ParameterVector | ndarray, parameters: ParameterVector | ndarray) → QuantumCircuit

Return the circuit encoding circuit (has to be overwritten, otherwise a NotImplementedError is thrown)

Parameters:

  • Union[ParameterVector (param_vec) – Input vector of the features from which the gate inputs are obtained

  • np.ndarray] – Input vector of the features from which the gate inputs are obtained

  • Union[ParameterVector – Input vector of the parameters from which the gate inputs are obtained

  • np.ndarray] – Input vector of the parameters from which the gate inputs are obtained

Returns:

Returns the circuit in qiskit QuantumCircuit format

get_params(deep: bool = True) → dict

Returns hyper-parameters and their values of the encoding circuit.

Parameters:

deep (bool) – If True, also the parameters for contained objects are returned (default=True).

Returns:

Dictionary with hyper-parameters and values.

set_params(**params) → EncodingCircuitBase

Sets value of the encoding circuit hyper-parameters.

Parameters:

params – Hyper-parameters and their values, e.g. num_qubits=2.