Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK. Go to the latest version.

LearningRate

class LearningRate(learning_rate)

GitHub

Bases: Generator

Represents a Learning Rate. Will be an attribute of GradientDescentState. Note that GradientDescent also has a learning rate. That learning rate can be a float, a list, an array, a function returning a generator and will be used to create a generator to be used during the optimization process. This class wraps Generator so that we can also access the last yielded value.

Parameters

learning_rate (Union[float, List[float], ndarray, Callable[[], Iterator]]) – Used to create a generator to iterate on.


Methods

close

LearningRate.close()

Raise GeneratorExit inside generator.

send

LearningRate.send(value)

Send a value into the generator. Return next yielded value or raise StopIteration.

throw

LearningRate.throw(typ, val=None, tb=None)

Raise an exception in the generator. Return next yielded value or raise StopIteration.


Attributes

current

Returns the current value of the learning rate.

Was this page helpful?
Report a bug or request content on GitHub.