Logo ROOT  
Reference Guide
TMVA::Envelope Class Referenceabstract

Abstract base class for all high level ml algorithms, you can book ml methods like BDT, MLP.

SVM etc.. and set a TMVA::DataLoader object to run your code in the overloaded method Evaluate.

Base class for all machine learning algorithms

Definition at line 43 of file Envelope.h.

Public Member Functions

 ~Envelope ()
 Default destructor. More...
 
virtual void BookMethod (TString methodname, TString methodtitle, TString options="")
 Method to book the machine learning method to perform the algorithm. More...
 
virtual void BookMethod (Types::EMVA method, TString methodtitle, TString options="")
 Method to book the machine learning method to perform the algorithm. More...
 
virtual void Evaluate ()=0
 Virtual method to be implemented with your algorithm. More...
 
DataLoaderGetDataLoader ()
 Method to get the pointer to TMVA::DataLoader object. More...
 
TFileGetFile ()
 Method to get the pointer to TFile object. More...
 
std::vector< OptionMap > & GetMethods ()
 Method get the Booked methods in a option map object. More...
 
Bool_t HasMethod (TString methodname, TString methodtitle)
 function to check methods booked More...
 
Bool_t IsModelPersistence ()
 Method to see if the algorithm model is saved in xml or serialized files. More...
 
Bool_t IsSilentFile ()
 Method to see if a file is available to save results. More...
 
Bool_t IsVerbose ()
 Method to see if the algorithm should print extra information. More...
 
virtual void ParseOptions ()
 Method to parse the internal option string. More...
 
void SetDataLoader (DataLoader *dalaloader)
 Method to set the pointer to TMVA::DataLoader object. More...
 
void SetFile (TFile *file)
 Method to set the pointer to TFile object, with a writable file. More...
 
void SetModelPersistence (Bool_t status=kTRUE)
 Method enable model persistence, then algorithms model is saved in xml or serialized files. More...
 
void SetVerbose (Bool_t status)
 Method enable print extra information in the algorithms. More...
 
- Public Member Functions inherited from TMVA::Configurable
 Configurable (const TString &theOption="")
 constructor More...
 
virtual ~Configurable ()
 default destructor More...
 
void AddOptionsXMLTo (void *parent) const
 write options to XML file More...
 
template<class T >
void AddPreDefVal (const T &)
 
template<class T >
void AddPreDefVal (const TString &optname, const T &)
 
void CheckForUnusedOptions () const
 checks for unused options in option string More...
 
template<class T >
TMVA::OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc)
 
template<class T >
OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc="")
 
template<class T >
TMVA::OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc)
 
template<class T >
OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc="")
 
const char * GetConfigDescription () const
 
const char * GetConfigName () const
 
const TStringGetOptions () const
 
MsgLoggerLog () const
 
void PrintOptions () const
 prints out the options set in the options string and the defaults More...
 
void ReadOptionsFromStream (std::istream &istr)
 read option back from the weight file More...
 
void ReadOptionsFromXML (void *node)
 
void SetConfigDescription (const char *d)
 
void SetConfigName (const char *n)
 
void SetMsgType (EMsgType t)
 
void SetOptions (const TString &s)
 
void WriteOptionsToStream (std::ostream &o, const TString &prefix) const
 write options to output stream (e.g. in writing the MVA weight files More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Protected Member Functions

 Envelope (const TString &name, DataLoader *dataloader=nullptr, TFile *file=nullptr, const TString options="")
 timer to measute the time. More...
 
DataInputHandlerGetDataLoaderDataInput ()
 Utility method to get TMVA::DataInputHandler reference from the DataLoader. More...
 
DataSetInfoGetDataLoaderDataSetInfo ()
 Utility method to get TMVA::DataSetInfo reference from the DataLoader. More...
 
DataSetManagerGetDataLoaderDataSetManager ()
 Utility method to get TMVA::DataSetManager pointer from the DataLoader. More...
 
TDirectoryRootBaseDir ()
 Utility method to get base dir directory from current file. More...
 
void WriteDataInformation (TMVA::DataSetInfo &fDataSetInfo, TMVA::Types::EAnalysisType fAnalysisType)
 method to save Train/Test information into the output file. More...
 
- Protected Member Functions inherited from TMVA::Configurable
void EnableLooseOptions (Bool_t b=kTRUE)
 
const TStringGetReferenceFile () const
 
Bool_t LooseOptionCheckingEnabled () const
 
void ResetSetFlag ()
 resets the IsSet flag for all declare options to be called before options are read from stream More...
 
void WriteOptionsReferenceToFile ()
 write complete options to output stream More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Protected Attributes

std::shared_ptr< DataLoaderfDataLoader
 Booked method information. More...
 
std::shared_ptr< TFilefFile
 data More...
 
UInt_t fJobs
 procpool object More...
 
std::vector< OptionMapfMethods
 
Bool_t fModelPersistence
 file to save the results More...
 
Bool_t fSilentFile
 List of transformations to test. More...
 
TStopwatch fTimer
 number of jobs to run some high level algorithm in parallel More...
 
TString fTransformations
 flag for extra information More...
 
Bool_t fVerbose
 flag to save the trained model More...
 
TProcPool fWorkers
 if true dont produce file output More...
 
- Protected Attributes inherited from TMVA::Configurable
MsgLoggerfLogger
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TMVA/Envelope.h>

Inheritance diagram for TMVA::Envelope:
[legend]

Constructor & Destructor Documentation

◆ Envelope()

Envelope::Envelope ( const TString name,
DataLoader dataloader = nullptr,
TFile file = nullptr,
const TString  options = "" 
)
protected

timer to measute the time.

Constructor for the initialization of Envelopes, differents Envelopes may needs differents constructors then this is a generic one protected.

Parameters
namethe name algorithm.
dataloaderTMVA::DataLoader object with the data.
fileoptional file to save the results.
optionsextra options for the algorithm.

Definition at line 40 of file Envelope.cxx.

◆ ~Envelope()

Envelope::~Envelope ( )

Default destructor.

Definition at line 62 of file Envelope.cxx.

Member Function Documentation

◆ BookMethod() [1/2]

void TMVA::Envelope::BookMethod ( TString  methodName,
TString  methodTitle,
TString  options = "" 
)
virtual

Method to book the machine learning method to perform the algorithm.

Parameters
methodNameString with the name of the mva method
methodTitleString with the method title.
optionsString with the options for the method.

Definition at line 163 of file Envelope.cxx.

◆ BookMethod() [2/2]

void TMVA::Envelope::BookMethod ( Types::EMVA  method,
TString  methodTitle,
TString  options = "" 
)
virtual

Method to book the machine learning method to perform the algorithm.

Parameters
methodenum TMVA::Types::EMVA with the type of the mva method
methodTitleString with the method title.
optionsString with the options for the method.

Definition at line 152 of file Envelope.cxx.

◆ Evaluate()

virtual void TMVA::Envelope::Evaluate ( )
pure virtual

Virtual method to be implemented with your algorithm.

Implemented in TMVA::VariableImportance, TMVA::HyperParameterOptimisation, TMVA::CrossValidation, and TMVA::Experimental::Classification.

◆ GetDataLoader()

DataLoader * Envelope::GetDataLoader ( )

Method to get the pointer to TMVA::DataLoader object.

Returns
pointer to TMVA::DataLoader object.

Definition at line 118 of file Envelope.cxx.

◆ GetDataLoaderDataInput()

DataInputHandler& TMVA::Envelope::GetDataLoaderDataInput ( )
inlineprotected

Utility method to get TMVA::DataInputHandler reference from the DataLoader.

Returns
TMVA::DataInputHandler reference.

Definition at line 98 of file Envelope.h.

◆ GetDataLoaderDataSetInfo()

DataSetInfo& TMVA::Envelope::GetDataLoaderDataSetInfo ( )
inlineprotected

Utility method to get TMVA::DataSetInfo reference from the DataLoader.

Returns
TMVA::DataSetInfo reference.

Definition at line 104 of file Envelope.h.

◆ GetDataLoaderDataSetManager()

DataSetManager* TMVA::Envelope::GetDataLoaderDataSetManager ( )
inlineprotected

Utility method to get TMVA::DataSetManager pointer from the DataLoader.

Returns
TMVA::DataSetManager pointer.

Definition at line 110 of file Envelope.h.

◆ GetFile()

TFile * Envelope::GetFile ( )

Method to get the pointer to TFile object.

Returns
pointer to TFile object.

Definition at line 78 of file Envelope.cxx.

◆ GetMethods()

std::vector< OptionMap > & Envelope::GetMethods ( )

Method get the Booked methods in a option map object.

Returns
vector of TMVA::OptionMap objects with the information of the Booked method

Definition at line 107 of file Envelope.cxx.

◆ HasMethod()

Bool_t TMVA::Envelope::HasMethod ( TString  methodname,
TString  methodtitle 
)

function to check methods booked

Parameters
methodnameMethod's name.
methodtitletitle associated to the method.
Returns
true if the method was booked.

Definition at line 220 of file Envelope.cxx.

◆ IsModelPersistence()

Bool_t TMVA::Envelope::IsModelPersistence ( )

Method to see if the algorithm model is saved in xml or serialized files.

Returns
Boolean with the status.

Definition at line 136 of file Envelope.cxx.

◆ IsSilentFile()

Bool_t Envelope::IsSilentFile ( )

Method to see if a file is available to save results.

Returns
Boolean with the status.

Definition at line 71 of file Envelope.cxx.

◆ IsVerbose()

Bool_t Envelope::IsVerbose ( )

Method to see if the algorithm should print extra information.

Returns
Boolean with the status.

Definition at line 93 of file Envelope.cxx.

◆ ParseOptions()

void TMVA::Envelope::ParseOptions ( )
virtual

Method to parse the internal option string.

Reimplemented from TMVA::Configurable.

Reimplemented in TMVA::CrossValidation.

Definition at line 182 of file Envelope.cxx.

◆ RootBaseDir()

TDirectory* TMVA::Envelope::RootBaseDir ( )
inlineprotected

Utility method to get base dir directory from current file.

Returns
TDirectory* pointer.

Definition at line 119 of file Envelope.h.

◆ SetDataLoader()

void Envelope::SetDataLoader ( DataLoader dataloader)

Method to set the pointer to TMVA::DataLoader object.

Parameters
dataloaderpointer to TMVA::DataLoader object.

Definition at line 126 of file Envelope.cxx.

◆ SetFile()

void Envelope::SetFile ( TFile file)

Method to set the pointer to TFile object, with a writable file.

Parameters
filepointer to TFile object.

Definition at line 86 of file Envelope.cxx.

◆ SetModelPersistence()

void TMVA::Envelope::SetModelPersistence ( Bool_t  status = kTRUE)

Method enable model persistence, then algorithms model is saved in xml or serialized files.

Parameters
statusBoolean with the status.

Definition at line 143 of file Envelope.cxx.

◆ SetVerbose()

void Envelope::SetVerbose ( Bool_t  status)

Method enable print extra information in the algorithms.

Parameters
statusBoolean with the status.

Definition at line 100 of file Envelope.cxx.

◆ WriteDataInformation()

void TMVA::Envelope::WriteDataInformation ( TMVA::DataSetInfo fDataSetInfo,
TMVA::Types::EAnalysisType  fAnalysisType 
)
protected

method to save Train/Test information into the output file.

Parameters
fDataSetInfoTMVA::DataSetInfo object reference
fAnalysisTypeTypes::kMulticlass and Types::kRegression

Definition at line 235 of file Envelope.cxx.

Member Data Documentation

◆ fDataLoader

std::shared_ptr<DataLoader> TMVA::Envelope::fDataLoader
protected

Booked method information.

Definition at line 47 of file Envelope.h.

◆ fFile

std::shared_ptr<TFile> TMVA::Envelope::fFile
protected

data

Definition at line 48 of file Envelope.h.

◆ fJobs

UInt_t TMVA::Envelope::fJobs
protected

procpool object

Definition at line 56 of file Envelope.h.

◆ fMethods

std::vector<OptionMap> TMVA::Envelope::fMethods
protected

Definition at line 46 of file Envelope.h.

◆ fModelPersistence

Bool_t TMVA::Envelope::fModelPersistence
protected

file to save the results

Definition at line 49 of file Envelope.h.

◆ fSilentFile

Bool_t TMVA::Envelope::fSilentFile
protected

List of transformations to test.

Definition at line 52 of file Envelope.h.

◆ fTimer

TStopwatch TMVA::Envelope::fTimer
protected

number of jobs to run some high level algorithm in parallel

Definition at line 57 of file Envelope.h.

◆ fTransformations

TString TMVA::Envelope::fTransformations
protected

flag for extra information

Definition at line 51 of file Envelope.h.

◆ fVerbose

Bool_t TMVA::Envelope::fVerbose
protected

flag to save the trained model

Definition at line 50 of file Envelope.h.

◆ fWorkers

TProcPool TMVA::Envelope::fWorkers
protected

if true dont produce file output

Definition at line 54 of file Envelope.h.

Libraries for TMVA::Envelope:
[legend]

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