MVAUtils::ForestLGBM Class Reference

Implement LGBM with nan support. More...

#include <ForestLGBM.h>

Inheritance diagram for MVAUtils::ForestLGBM:

Collaboration diagram for MVAUtils::ForestLGBM:

Public Member Functions
	ForestLGBM (TTree *tree)
	ForestLGBM ()=default
	ForestLGBM (const ForestLGBM &)=default
ForestLGBM &	operator= (const ForestLGBM &)=default
	ForestLGBM (ForestLGBM &&)=default
ForestLGBM &	operator= (ForestLGBM &&)=default
	~ForestLGBM ()=default
virtual TTree *	WriteTree (TString name) const override
	Return a TTree representing the BDT. More...
virtual void	PrintForest () const override
virtual int	GetNVars () const override
	Get the number of input variable to be passed with std::vector to Get* methods. More...
virtual float	GetClassification (const std::vector< float > &values) const final
	Compute the prediction of a classification. More...
virtual float	GetClassification (const std::vector< float * > &pointers) const final
virtual float	GetTreeResponse (const std::vector< float > &values, unsigned int itree) const override final
	Return the response of one tree Must pass the features in a std::vector<float> values and the index of the tree. More...
virtual float	GetTreeResponse (const std::vector< float * > &pointers, unsigned int itree) const override final
virtual float	GetOffset () const override
	Return the offset of the forest. More...
virtual float	GetOffset () const =0
	Return the global offset. More...
virtual float	GetRawResponse (const std::vector< float > &values) const override final
	Return the response of the whole Forest. More...
virtual float	GetRawResponse (const std::vector< float * > &pointers) const override final
virtual float	GetResponse (const std::vector< float > &values) const override
	Compute the prediction for regression. More...
virtual float	GetResponse (const std::vector< float * > &pointers) const override
virtual std::vector< float >	GetMultiResponse (const std::vector< float > &values, unsigned int numClasses) const override
	Compute the prediction for multiclassification (a score for each class). More...
virtual std::vector< float >	GetMultiResponse (const std::vector< float * > &pointers, unsigned int numClasses) const override
virtual unsigned int	GetNTrees () const override final
virtual unsigned int	GetNTrees () const =0
virtual void	PrintForest () const override
virtual void	PrintTree (unsigned int itree) const override
std::vector< NodeLGBM >	GetTree (unsigned int itree) const
	Return the vector of nodes for the tree itree. More...

Protected Member Functions
float	GetTreeResponseFromNode (const std::vector< float > &values, index_t index) const
	Get the response of a tree. More...
float	GetTreeResponseFromNode (const std::vector< float * > &pointers, index_t index) const
void	newTree (const std::vector< NodeLGBM > &nodes)
	append a new tree (defined by a vector of nodes serialized in preorder) to the forest More...

Private Attributes
int	m_max_var =0
std::vector< index_t >	m_forest
	indices of the top-level nodes of each tree More...
std::vector< NodeLGBM >	m_nodes
	where the nodes of the forest are stored More...

Detailed Description

Implement LGBM with nan support.

Definition at line 61 of file ForestLGBM.h.

Constructor & Destructor Documentation

ForestLGBM() [1/4]

ForestLGBM::ForestLGBM ( TTree *  tree )

explicit

Definition at line 88 of file ForestLGBM.cxx.

  : ForestLGBMBase<NodeLGBM>()
  , m_max_var(0)
{
    
 
    // variables read from the TTree
    std::vector<int> *vars = nullptr;
    std::vector<float> *values = nullptr;
    std::vector<bool> *default_left = nullptr;
 
    std::vector<NodeLGBM> nodes;
 
    tree->SetBranchAddress("vars", &vars);
    tree->SetBranchAddress("values", &values);
    tree->SetBranchAddress("default_left", &default_left);
    int numEntries = tree->GetEntries();
    for (int entry = 0; entry < numEntries; ++entry) {
      // each entry in the TTree is a decision tree
      tree->GetEntry(entry);
      if (!vars) {
        throw std::runtime_error(
          "vars pointer is null in ForestLGBM constructor");
      }
      if (!values) {
        throw std::runtime_error(
          "values pointers is null in ForestLGBM constructor");
      }
      if (!default_left) {
        throw std::runtime_error(
          "default_left pointers is null in ForestLGBM constructor");
      }
      if (vars->size() != values->size()) {
        throw std::runtime_error(
          "inconsistent size for vars and values in ForestLGBM constructor");
      }
      if (default_left->size() != values->size()) {
        throw std::runtime_error("inconsistent size for default_left and "
                                 "values in ForestLGBM constructor");
      }
 
      nodes.clear();
 
      std::vector<MVAUtils::index_t> right = detail::computeRight(*vars);
 
      for (size_t i = 0; i < vars->size(); ++i) {
        nodes.emplace_back(
          vars->at(i), values->at(i), right[i], default_left->at(i));
        if (vars->at(i) > m_max_var) {
          m_max_var = vars->at(i);
        }
      }
      newTree(nodes);
    } // end loop on TTree, all decision tree loaded
    delete vars;
    delete values;
    delete default_left;
}

ForestLGBM() [2/4]

MVAUtils::ForestLGBM::ForestLGBM ( )

default

ForestLGBM() [3/4]

MVAUtils::ForestLGBM::ForestLGBM ( const ForestLGBM &  )

default

ForestLGBM() [4/4]

MVAUtils::ForestLGBM::ForestLGBM ( ForestLGBM &&  )

default

~ForestLGBM()

MVAUtils::ForestLGBM::~ForestLGBM ( )

default

Member Function Documentation

GetClassification() [1/2]

virtual float MVAUtils::ForestLGBMBase< NodeLGBM >::GetClassification ( const std::vector< float * > &  pointers ) const

inlinefinalvirtualinherited

Implements MVAUtils::IForest.

Definition at line 35 of file ForestLGBM.h.

        {
            return detail::sigmoid(GetResponse(pointers));
        }

GetClassification() [2/2]

virtual float MVAUtils::ForestLGBMBase< NodeLGBM >::GetClassification ( const std::vector< float > &  values ) const

inlinefinalvirtualinherited

Compute the prediction of a classification.

Implements MVAUtils::IForest.

Definition at line 31 of file ForestLGBM.h.

        {
            return detail::sigmoid(GetResponse(values));
        }

GetMultiResponse() [1/2]

virtual std::vector<float> MVAUtils::Forest< NodeLGBM >::GetMultiResponse ( const std::vector< float * > &  pointers, unsigned int  numClasses  ) const

overridevirtualinherited

Implements MVAUtils::IForest.

GetMultiResponse() [2/2]

virtual std::vector<float> MVAUtils::Forest< NodeLGBM >::GetMultiResponse ( const std::vector< float > &  values, unsigned int  numClasses  ) const

overridevirtualinherited

Compute the prediction for multiclassification (a score for each class).

In addition to the input values need to pass the number of classes

Implements MVAUtils::IForest.

GetNTrees() [1/2]

virtual unsigned int MVAUtils::IForest::GetNTrees ( ) const

pure virtualinherited

Implemented in MVAUtils::Forest< Node_t >.

GetNTrees() [2/2]

virtual unsigned int MVAUtils::Forest< NodeLGBM >::GetNTrees

inlinefinaloverridevirtualinherited

Definition at line 94 of file Forest.h.

      {
        return m_forest.size();
      }

GetNVars()

virtual int MVAUtils::ForestLGBM::GetNVars ( ) const

inlineoverridevirtual

Get the number of input variable to be passed with std::vector to Get* methods.

Implements MVAUtils::IForest.

Definition at line 73 of file ForestLGBM.h.

{ return m_max_var + 1; }

GetOffset() [1/2]

virtual float MVAUtils::IForest::GetOffset ( ) const

pure virtualinherited

Return the global offset.

For many implementation this is just 0

Implemented in MVAUtils::Forest< Node_t >, and MVAUtils::ForestWeighted< Node_t >.

GetOffset() [2/2]

virtual float MVAUtils::Forest< NodeLGBM >::GetOffset

inlineoverridevirtualinherited

Return the offset of the forest.

Since by default there is no offset, return 0

Definition at line 63 of file Forest.h.

{ return 0.; }

GetRawResponse() [1/2]

virtual float MVAUtils::Forest< NodeLGBM >::GetRawResponse ( const std::vector< float * > &  pointers ) const

finaloverridevirtualinherited

Implements MVAUtils::IForest.

GetRawResponse() [2/2]

virtual float MVAUtils::Forest< NodeLGBM >::GetRawResponse ( const std::vector< float > &  values ) const

finaloverridevirtualinherited

Return the response of the whole Forest.

Raw is just the sum of all the trees

Implements MVAUtils::IForest.

GetResponse() [1/2]

virtual float MVAUtils::Forest< NodeLGBM >::GetResponse ( const std::vector< float * > &  pointers ) const

overridevirtualinherited

Implements MVAUtils::IForest.

GetResponse() [2/2]

virtual float MVAUtils::Forest< NodeLGBM >::GetResponse ( const std::vector< float > &  values ) const

overridevirtualinherited

Compute the prediction for regression.

Implements MVAUtils::IForest.

GetTree()

std::vector<NodeLGBM > MVAUtils::Forest< NodeLGBM >::GetTree ( unsigned int  itree ) const

inherited

Return the vector of nodes for the tree itree.

GetTreeResponse() [1/2]

virtual float MVAUtils::Forest< NodeLGBM >::GetTreeResponse ( const std::vector< float * > &  pointers, unsigned int  itree  ) const

finaloverridevirtualinherited

Implements MVAUtils::IForest.

GetTreeResponse() [2/2]

virtual float MVAUtils::Forest< NodeLGBM >::GetTreeResponse ( const std::vector< float > &  values, unsigned int  itree  ) const

finaloverridevirtualinherited

Return the response of one tree Must pass the features in a std::vector<float> values and the index of the tree.

Implements MVAUtils::IForest.

GetTreeResponseFromNode() [1/2]

float MVAUtils::Forest< NodeLGBM >::GetTreeResponseFromNode ( const std::vector< float * > &  pointers, index_t  index  ) const

protectedinherited

GetTreeResponseFromNode() [2/2]

float MVAUtils::Forest< NodeLGBM >::GetTreeResponseFromNode ( const std::vector< float > &  values, index_t  index  ) const

protectedinherited

Get the response of a tree.

Instead of specifying the index of the tree (as in GetTreeResponse) the index of the top node of the tree should be specified

newTree()

void MVAUtils::Forest< NodeLGBM >::newTree ( const std::vector< NodeLGBM > &  nodes )

protectedinherited

append a new tree (defined by a vector of nodes serialized in preorder) to the forest

operator=() [1/2]

ForestLGBM& MVAUtils::ForestLGBM::operator= ( const ForestLGBM &  )

default

operator=() [2/2]

ForestLGBM& MVAUtils::ForestLGBM::operator= ( ForestLGBM &&  )

default

PrintForest() [1/2]

void ForestLGBM::PrintForest ( ) const

overridevirtual

Implements MVAUtils::IForest.

Definition at line 174 of file ForestLGBM.cxx.

{
    std::cout << "***BDT LGBM: Printing entire forest***" << std::endl;
    Forest::PrintForest();
}

PrintForest() [2/2]

virtual void MVAUtils::Forest< NodeLGBM >::PrintForest

overridevirtualinherited

PrintTree()

virtual void MVAUtils::Forest< NodeLGBM >::PrintTree ( unsigned int  itree ) const

overridevirtualinherited

Implements MVAUtils::IForest.

WriteTree()

TTree * ForestLGBM::WriteTree ( TString  ) const

overridevirtual

Return a TTree representing the BDT.

The called is the owner of the returned TTree

Implements MVAUtils::IForest.

Definition at line 148 of file ForestLGBM.cxx.

{
    TTree *tree = new TTree(name.Data(), "creator=lgbm;node_type=lgbm");
 
    std::vector<int> vars;
    std::vector<float> values;
    std::vector<bool> default_left;
 
    tree->Branch("vars", &vars);
    tree->Branch("values", &values);
    tree->Branch("default_left", &default_left);
 
    for (size_t itree = 0; itree < GetNTrees(); ++itree) {
        vars.clear();
        values.clear();
        default_left.clear();
        for(const auto& node : GetTree(itree)) {
            vars.push_back(node.GetVar());
            values.push_back(node.GetVal());
            default_left.push_back(node.GetDefaultLeft());
        }
        tree->Fill();
    }
    return tree;
}

Member Data Documentation

m_forest

std::vector<index_t> MVAUtils::Forest< NodeLGBM >::m_forest

privateinherited

indices of the top-level nodes of each tree

Definition at line 117 of file Forest.h.

m_max_var

int MVAUtils::ForestLGBM::m_max_var =0

private

Definition at line 75 of file ForestLGBM.h.

m_nodes

std::vector<NodeLGBM > MVAUtils::Forest< NodeLGBM >::m_nodes

privateinherited

where the nodes of the forest are stored

Definition at line 118 of file Forest.h.

---

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

• ForestLGBM.h
• ForestLGBM.cxx