Belle II Software development
Teacher Class Referenceabstract

Abstract base class of all Teachers Each MVA library has its own implementation of this class, so all libraries can be accessed via this common interface. More...

#include <Teacher.h>

Inheritance diagram for Teacher:
CombinationTeacher FANNTeacher FastBDTTeacher PDFTeacher PythonTeacher RegressionTeacher< BaseClassifierTeacher, RegressionClassifierOptions > ReweighterTeacher TMVATeacher TrivialTeacher

Public Member Functions

 Teacher (const GeneralOptions &general_options)
 Constructs a new teacher using the GeneralOptions for this training.
 
virtual Weightfile train (Dataset &training_data) const =0
 Train a mva method using the given dataset returning a Weightfile.
 
virtual ~Teacher ()=default
 Virtual destructor.
 

Protected Attributes

GeneralOptions m_general_options
 GeneralOptions containing all shared options.
 

Detailed Description

Abstract base class of all Teachers Each MVA library has its own implementation of this class, so all libraries can be accessed via this common interface.

Definition at line 29 of file Teacher.h.

Constructor & Destructor Documentation

◆ Teacher()

Teacher ( const GeneralOptions general_options)
explicit

Constructs a new teacher using the GeneralOptions for this training.

Parameters
general_optionsdefining all shared options

Definition at line 18 of file Teacher.cc.

18: m_general_options(general_options) { }
GeneralOptions m_general_options
GeneralOptions containing all shared options.
Definition: Teacher.h:49

Member Function Documentation

◆ train()

virtual Weightfile train ( Dataset training_data) const
pure virtual

Member Data Documentation

◆ m_general_options

GeneralOptions m_general_options
protected

GeneralOptions containing all shared options.

Definition at line 49 of file Teacher.h.


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