VariableLearningRate

public class VariableLearningRate : Callback

Class used for variable learning rate feature.

  • Name of the callback.

    Declaration

    Swift

    public var name: String
  • Position of the execution.

    Declaration

    Swift

    public var execute: [LoopPosition]
  • Typealias for learningRateFunction.

    Declaration

    Swift

    public typealias Function = (Int, Int) -> String
  • Initialize VariableLearningRate by array of learning rates.

    Precondition

    iterations == learningRates.count.

    Declaration

    Swift

    public init(
        learningRates: [String],
        iterations: Int
    )

    Parameters

    learningRates

    Array of learning rates that will be accessed at every iteration.

    iterations

    Number of iteration in training.

  • Initialize VariableLearningRate with function generating learning rate.

    Declaration

    Swift

    public init(
        learningRate: @escaping Function,
        iterations: Int
    )

    Parameters

    learningRate

    Function that will return learning rate at each iteration.

    iterations

    Number of iteration in training.

  • Declaration

    Swift

    public func call(
        booster: Booster?,
        iteration: Int,
        evaluation _: Evaluation?
    ) throws -> AfterIterationOutput

    Parameters

    booster

    Booster.

    iteration

    Current iteration.

    evaluation

    Dictionary with evaluations.