xgboost.callback.TrainingCallback Class Reference

Inheritance diagram for xgboost.callback.TrainingCallback:

Public Member Functions
None	__init__ (self)
_Model	before_training (self, _Model model)
_Model	after_training (self, _Model model)
bool	before_iteration (self, _Model model, int epoch, EvalsLog evals_log)
bool	after_iteration (self, _Model model, int epoch, EvalsLog evals_log)

Static Public Attributes
	EvalsLog = Dict[str, Dict[str, _ScoreList]]

Detailed Description

Interface for training callback.

.. versionadded:: 1.3.0

Member Function Documentation

after_iteration()

bool xgboost.callback.TrainingCallback.after_iteration	(		self,
		_Model	model,
		int	epoch,
		EvalsLog	evals_log
	)

Run after each iteration.  Return True when training should stop.

Reimplemented in xgboost.callback.LearningRateScheduler, xgboost.callback.EarlyStopping, xgboost.callback.EvaluationMonitor, and xgboost.callback.TrainingCheckPoint.

after_training()

_Model xgboost.callback.TrainingCallback.after_training	(		self,
		_Model	model
	)

Run after training is finished.

Reimplemented in xgboost.callback.EarlyStopping, and xgboost.callback.EvaluationMonitor.

before_iteration()

bool xgboost.callback.TrainingCallback.before_iteration	(		self,
		_Model	model,
		int	epoch,
		EvalsLog	evals_log
	)

Run before each iteration.  Return True when training should stop.

before_training()

_Model xgboost.callback.TrainingCallback.before_training	(		self,
		_Model	model
	)

Run before training starts.

Reimplemented in xgboost.callback.EarlyStopping.

---

The documentation for this class was generated from the following file:

• External/xgboost/python-package/xgboost/callback.py