Functions

The following functions are available globally.


                    
                    
                    crossValidationTraining(folds:iterations:earlyStopping:objectiveFunction:evaluationFunction:beforeIteration:callbacks:afterIteration:afterCVIteration:)

Training with cross-validation.

Declaration

Swift

public func crossValidationTraining(
    folds: [CVPack],
    iterations: Int,
    earlyStopping: EarlyStopping? = nil,
    objectiveFunction: ObjectiveFunction? = nil,
    evaluationFunction: EvaluationFunction? = nil,
    beforeIteration: BeforeIteration = DefaultBeforeIteration,
    callbacks: [Callback] = [],
    afterIteration: AfterIteration = DefaultAfterIteration,
    afterCVIteration: AfterCVIteration = DefaultAfterCVIteration
) throws -> (results: CVEvaluation, folds: [CVPack])

Parameters

`folds`	Cross-validation folds to train.
`iterations`	Number training of iterations.
`earlyStopping`	Early stopping used for cross-validation results.
`objectiveFunction`	Custom objective function passed to the booster.train.
`evaluationFunction`	Custom evaluation function passed to the booster.train.
`beforeIteration`	Before iteration function passed to the booster.train.
`callbacks`	Callbacks passed to the booster.train.
`afterIteration`	After iteration function passed to the booster.train.
`afterCVIteration`	Function called after one cv iteration, e.g. after one training iteration of every fold.


                    
                    
                    crossValidationTraining(data:splits:iterations:parameters:earlyStopping:objectiveFunction:evaluationFunction:shuffle:beforeIteration:callbacks:afterIteration:afterCVIteration:)

Training with cross-validation.

Declaration

Swift

public func crossValidationTraining(
    data: Data,
    splits: Int,
    iterations: Int,
    parameters: [Parameter],
    earlyStopping: EarlyStopping? = nil,
    objectiveFunction: ObjectiveFunction? = nil,
    evaluationFunction: EvaluationFunction? = nil,
    shuffle: Bool = true,
    beforeIteration: BeforeIteration = DefaultBeforeIteration,
    callbacks: [Callback] = [],
    afterIteration: AfterIteration = DefaultAfterIteration,
    afterCVIteration: AfterCVIteration = DefaultAfterCVIteration
) throws -> (results: CVEvaluation, folds: [CVPack])

Parameters

`data`	Data to split.
`splits`	Number of cvfoolds that will be created.
`iterations`	Number training of iterations.
`parameters`	Parameters passed to the Booster initialized in CVPack.
`earlyStopping`	Early stopping used for cross-validation results.
`objectiveFunction`	Custom objective function passed to the booster.train.
`evaluationFunction`	Custom evaluation function passed to the booster.train.
`beforeIteration`	Before iteration function passed to the booster.train.
`callbacks`	Callbacks passed to the booster.train.
`afterIteration`	After iteration function passed to the booster.train.
`afterCVIteration`	Function called after one cv iteration, e.g. after one training iteration of every fold.