Options for the FANN MVA method. More...

#include <FastBDT.h>

Inheritance diagram for FastBDTOptions:

Collaboration diagram for FastBDTOptions:

Public Member Functions
virtual void	load (const boost::property_tree::ptree &pt) override
	Load mechanism to load Options from a xml tree.

virtual void	save (boost::property_tree::ptree &pt) const override
	Save mechanism to store Options in a xml tree.

virtual po::options_description	getDescription () override
	Returns a program options description for all available options.

virtual std::string	getMethod () const override
	Return method name.

Public Attributes
unsigned int	m_nTrees = 200
	Number of trees.

unsigned int	m_nCuts = 8
	Number of cut Levels = log_2(Number of Cuts)

unsigned int	m_nLevels = 3
	Depth of tree.

double	m_shrinkage = 0.1
	Shrinkage during the boosting step.

double	m_randRatio = 0.5
	Fraction of data to use in the stochastic training.

Detailed Description

Options for the FANN MVA method.

Definition at line 53 of file FastBDT.h.

Member Function Documentation

◆ getDescription()

po::options_description getDescription ( )

overridevirtual

Returns a program options description for all available options.

Implements Options.

Definition at line 126 of file FastBDT.cc.

    {
      po::options_description description("FastBDT options");
      description.add_options()
      ("nTrees", po::value<unsigned int>(&m_nTrees), "Number of trees in the forest. Reasonable values are between 10 and 1000")
      ("nLevels", po::value<unsigned int>(&m_nLevels)->notifier(check_bounds<unsigned int>(0, 20, "nLevels")),
       "Depth d of trees. The last layer of the tree will contain 2^d bins. Maximum is 20. Reasonable values are 2 and 6.")
      ("shrinkage", po::value<double>(&m_shrinkage)->notifier(check_bounds<double>(0.0, 1.0, "shrinkage")),
       "Shrinkage of the boosting algorithm. Reasonable values are between 0.01 and 1.0.")
      ("nCutLevels", po::value<unsigned int>(&m_nCuts)->notifier(check_bounds<unsigned int>(0, 20, "nCutLevels")),
       "Number of cut levels N per feature. 2^N Bins will be used per feature. Reasonable values are between 6 and 12.")
#if FastBDT_VERSION_MAJOR >= 5
      ("individualNCutLevels", po::value<std::vector<unsigned int>>(&m_individual_nCuts)->multitoken()->notifier(
         check_bounds_vector<unsigned int>(0, 20, "individualNCutLevels")),
       "Number of cut levels N per feature. 2^N Bins will be used per feature. Reasonable values are between 6 and 12. One value per feature (including spectators) should be provided, if parameter is not set the global value specified by nCutLevels is used for all features.")
      ("sPlot", po::value<bool>(&m_sPlot),
       "Since in sPlot each event enters twice, this option modifies the sampling algorithm so that the matching signal and background events are selected together.")
      ("flatnessLoss", po::value<double>(&m_flatnessLoss),
       "Activate Flatness Loss, all spectator variables are assumed to be variables in which the signal and background efficiency should be flat. negative values deactivates flatness loss.")
      ("purityTransformation", po::value<bool>(&m_purityTransformation),
       "Activates purity transformation on all features: Add the purity transformed of all features in addition to the training. This will double the number of features and slow down the inference considerably")
      ("individualPurityTransformation", po::value<std::vector<bool>>(&m_individualPurityTransformation)->multitoken(),
       "Activates purity transformation for each feature: Vector of boolean values which decide if the purity transformed of the feature should be added in addition to this training.")
#endif
      ("randRatio", po::value<double>(&m_randRatio)->notifier(check_bounds<double>(0.0, 1.0001, "randRatio")),
       "Fraction of the data sampled each training iteration. Reasonable values are between 0.1 and 1.0.");
      return description;
    }

◆ getMethod()

virtual std::string getMethod ( ) const

inlineoverridevirtual

Return method name.

Implements SpecificOptions.

Definition at line 76 of file FastBDT.h.

76{ return "FastBDT"; }

◆ load()

void load ( const boost::property_tree::ptree & pt )

overridevirtual

Load mechanism to load Options from a xml tree.

Parameters

pt xml tree

Implements Options.

Definition at line 53 of file FastBDT.cc.

    {
      int version = pt.get<int>("FastBDT_version");
#if FastBDT_VERSION_MAJOR >= 5
      if (version != 1 and version != 2) {
        B2ERROR("Unknown weightfile version " << std::to_string(version));
        throw std::runtime_error("Unknown weightfile version " + std::to_string(version));
      }
#else
      if (version != 1) {
        B2ERROR("Unknown weightfile version " << std::to_string(version));
        throw std::runtime_error("Unknown weightfile version " + std::to_string(version));
      }
#endif
      m_nTrees = pt.get<int>("FastBDT_nTrees");
      m_nCuts = pt.get<int>("FastBDT_nCuts");
      m_nLevels = pt.get<int>("FastBDT_nLevels");
      m_shrinkage = pt.get<double>("FastBDT_shrinkage");
      m_randRatio = pt.get<double>("FastBDT_randRatio");
 
#if FastBDT_VERSION_MAJOR >= 5
      if (version > 1) {
 
        m_flatnessLoss = pt.get<double>("FastBDT_flatnessLoss");
        m_sPlot = pt.get<bool>("FastBDT_sPlot");
 
        unsigned int numberOfIndividualNCuts = pt.get<unsigned int>("FastBDT_number_individual_nCuts", 0);
        m_individual_nCuts.resize(numberOfIndividualNCuts);
        for (unsigned int i = 0; i < numberOfIndividualNCuts; ++i) {
          m_individual_nCuts[i] = pt.get<unsigned int>(std::string("FastBDT_individual_nCuts") + std::to_string(i));
        }
 
        m_purityTransformation = pt.get<bool>("FastBDT_purityTransformation");
        unsigned int numberOfIndividualPurityTransformation = pt.get<unsigned int>("FastBDT_number_individualPurityTransformation", 0);
        m_individualPurityTransformation.resize(numberOfIndividualPurityTransformation);
        for (unsigned int i = 0; i < numberOfIndividualPurityTransformation; ++i) {
          m_individualPurityTransformation[i] = pt.get<bool>(std::string("FastBDT_individualPurityTransformation") + std::to_string(i));
        }
 
      } else {
        m_flatnessLoss = -1.0;
        m_sPlot = false;
      }
#endif
    }

◆ save()

void save ( boost::property_tree::ptree & pt ) const

overridevirtual

Save mechanism to store Options in a xml tree.

Parameters

pt xml tree

Implements Options.

Definition at line 99 of file FastBDT.cc.

    {
#if FastBDT_VERSION_MAJOR >= 5
      pt.put("FastBDT_version", 2);
#else
      pt.put("FastBDT_version", 1);
#endif
      pt.put("FastBDT_nTrees", m_nTrees);
      pt.put("FastBDT_nCuts", m_nCuts);
      pt.put("FastBDT_nLevels", m_nLevels);
      pt.put("FastBDT_shrinkage", m_shrinkage);
      pt.put("FastBDT_randRatio", m_randRatio);
#if FastBDT_VERSION_MAJOR >= 5
      pt.put("FastBDT_flatnessLoss", m_flatnessLoss);
      pt.put("FastBDT_sPlot", m_sPlot);
      pt.put("FastBDT_number_individual_nCuts", m_individual_nCuts.size());
      for (unsigned int i = 0; i < m_individual_nCuts.size(); ++i) {
        pt.put(std::string("FastBDT_individual_nCuts") + std::to_string(i), m_individual_nCuts[i]);
      }
      pt.put("FastBDT_purityTransformation", m_purityTransformation);
      pt.put("FastBDT_number_individualPurityTransformation", m_individualPurityTransformation.size());
      for (unsigned int i = 0; i < m_individualPurityTransformation.size(); ++i) {
        pt.put(std::string("FastBDT_individualPurityTransformation") + std::to_string(i), m_individualPurityTransformation[i]);
      }
#endif
    }

Member Data Documentation

◆ m_nCuts

unsigned int m_nCuts = 8

Number of cut Levels = log_2(Number of Cuts)

Definition at line 79 of file FastBDT.h.

◆ m_nLevels

unsigned int m_nLevels = 3

Depth of tree.

Definition at line 80 of file FastBDT.h.

◆ m_nTrees

unsigned int m_nTrees = 200

Number of trees.

Definition at line 78 of file FastBDT.h.

◆ m_randRatio

double m_randRatio = 0.5

Fraction of data to use in the stochastic training.

Definition at line 82 of file FastBDT.h.

◆ m_shrinkage

double m_shrinkage = 0.1

Shrinkage during the boosting step.

Definition at line 81 of file FastBDT.h.

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

mva/methods/include/FastBDT.h
mva/methods/src/FastBDT.cc

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ getDescription()

◆ getMethod()

◆ load()

◆ save()

Member Data Documentation

◆ m_nCuts

◆ m_nLevels

◆ m_nTrees

◆ m_randRatio

◆ m_shrinkage