EarlyStopping Class Reference


                    
                    
                    name

Name of the callback.

Declaration

Swift

public var name: String


                    
                    
                    execute

Position of the execution.

Declaration

Swift

public var execute: [LoopPosition]


                    
                    
                    State

Typealais for tuple holding current state.

Declaration

Swift

public typealias State = (
    maximizeScore: Bool,
    bestIteration: Int,
    bestScore: Float,
    bestMsg: String
)


                    
                    
                    state

Current state of training.

Declaration

Swift

public var state: State


                    
                    
                    dataName

Name of watched DMatrix.

Declaration

Swift

public var dataName: String


                    
                    
                    metricName

Name of watched metric.

Declaration

Swift

public var metricName: String


                    
                    
                    stoppingRounds

Number of stopping rounds.

Declaration

Swift

public var stoppingRounds: Int


                    
                    
                    verbose

If true, statistics will be printed.

Declaration

Swift

public var verbose: Bool


                    
                    
                    init(dataName:metricName:stoppingRounds:state:verbose:)

Declaration

Swift

public required init(
    dataName: String,
    metricName: String,
    stoppingRounds: Int,
    state: State,
    verbose: Bool = false
)

Parameters

`dataName`	Name of data used for early stopping.
`metricName`	Metric to look for.
`stoppingRounds`	Number of rounds to check improvence for.
`state`	Initial state.
`verbose`	Print on new best or stopping.


                    
                    
                    init(dataName:metricName:stoppingRounds:maximize:verbose:)

Declaration

Swift

public convenience init(
    dataName: String,
    metricName: String,
    stoppingRounds: Int,
    maximize: Bool = false,
    verbose: Bool = false
)

Parameters

`dataName`	Name of data used for early stopping.
`metricName`	Metric to look for.
`stoppingRounds`	Number of rounds to check improvence for.
`maximize`	If metric should be maximized, minimzed otherwise.
`verbose`	Print on new best or stopping.


                    
                    
                    init(dataName:metricName:stoppingRounds:maximize:booster:verbose:)

Declaration

Swift

public convenience init(
    dataName: String,
    metricName: String,
    stoppingRounds: Int,
    maximize: Bool,
    booster: Booster,
    verbose: Bool = false
) throws

Parameters

`dataName`	Name of data used for early stopping.
`metricName`	Metric to look for.
`stoppingRounds`	Number of rounds to check improvence for.
`maximize`	If metric should be maximized, minimzed otherwise.
`booster`	Booster to load state from.
`verbose`	Print on new best or stopping.


                    
                    
                    call(booster:iteration:evaluation:)

Call used in Booster training.

Declaration

Swift

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

Parameters

`booster`	Booster.
`iteration`	Current iteration.
`evaluation`	Dictionary with evaluations.


                    
                    
                    call(iteration:evaluation:)

Call used in cross-validation training.

Declaration

Swift

public func call(
    iteration: Int,
    evaluation: CVEvaluation
) throws -> AfterIterationOutput

Parameters

`iteration`	Current iteration.
`evaluation`	Cross-validation evaluation.