Logo ROOT   6.14/05
Reference Guide
List of all members | Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
TMVA::MethodDL Class Reference

Definition at line 75 of file MethodDL.h.

Public Member Functions

 MethodDL (const TString &jobName, const TString &methodTitle, DataSetInfo &theData, const TString &theOption)
 Constructor. More...
 
 MethodDL (DataSetInfo &theData, const TString &theWeightFile)
 Constructor. More...
 
virtual ~MethodDL ()
 Virtual Destructor. More...
 
void AddWeightsXMLTo (void *parent) const
 
const RankingCreateRanking ()
 
TString GetArchitectureString () const
 
size_t GetBatchDepth () const
 
size_t GetBatchHeight () const
 
TString GetBatchLayoutString () const
 
size_t GetBatchWidth () const
 
const DeepNetImpl_tGetDeepNet () const
 
TString GetErrorStrategyString () const
 
size_t GetInputDepth () const
 
size_t GetInputHeight () const
 
TString GetInputLayoutString () const
 
size_t GetInputWidth () const
 
const KeyValueVector_tGetKeyValueSettings () const
 
KeyValueVector_tGetKeyValueSettings ()
 
TString GetLayoutString () const
 
DNN::ELossFunction GetLossFunction () const
 
Double_t GetMvaValue (Double_t *err=0, Double_t *errUpper=0)
 
DNN::EOutputFunction GetOutputFunction () const
 
const std::vector< TTrainingSettings > & GetTrainingSettings () const
 
std::vector< TTrainingSettings > & GetTrainingSettings ()
 
TString GetTrainingStrategyString () const
 
DNN::EInitialization GetWeightInitialization () const
 
TString GetWeightInitializationString () const
 
Bool_t HasAnalysisType (Types::EAnalysisType type, UInt_t numberClasses, UInt_t numberTargets)
 Check the type of analysis the deep learning network can do. More...
 
KeyValueVector_t ParseKeyValueString (TString parseString, TString blockDelim, TString tokenDelim)
 Function for parsing the training settings, provided as a string in a key-value form. More...
 
void ReadWeightsFromStream (std::istream &)
 
void ReadWeightsFromXML (void *wghtnode)
 
void SetArchitectureString (TString architectureString)
 
void SetBatchDepth (size_t batchDepth)
 
void SetBatchHeight (size_t batchHeight)
 
void SetBatchWidth (size_t batchWidth)
 
void SetErrorStrategyString (TString errorStrategy)
 
void SetInputDepth (size_t inputDepth)
 Setters. More...
 
void SetInputHeight (size_t inputHeight)
 
void SetInputWidth (size_t inputWidth)
 
void SetLayoutString (TString layoutString)
 
void SetOutputFunction (DNN::EOutputFunction outputFunction)
 
void SetTrainingStrategyString (TString trainingStrategyString)
 
void SetWeightInitialization (DNN::EInitialization weightInitialization)
 
void SetWeightInitializationString (TString weightInitializationString)
 
void Train ()
 Methods for training the deep learning network. More...
 
- Public Member Functions inherited from TMVA::MethodBase
 MethodBase (const TString &jobName, Types::EMVA methodType, const TString &methodTitle, DataSetInfo &dsi, const TString &theOption="")
 standard constructor More...
 
 MethodBase (Types::EMVA methodType, DataSetInfo &dsi, const TString &weightFile)
 constructor used for Testing + Application of the MVA, only (no training), using given WeightFiles More...
 
virtual ~MethodBase ()
 destructor More...
 
void AddOutput (Types::ETreeType type, Types::EAnalysisType analysisType)
 
TDirectoryBaseDir () const
 returns the ROOT directory where info/histograms etc of the corresponding MVA method instance are stored More...
 
virtual void CheckSetup ()
 check may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase) More...
 
DataSetData () const
 
DataSetInfoDataInfo () const
 
virtual void DeclareCompatibilityOptions ()
 options that are used ONLY for the READER to ensure backward compatibility they are hence without any effect (the reader is only reading the training options that HAD been used at the training of the .xml weight file at hand More...
 
void DisableWriting (Bool_t setter)
 
Bool_t DoMulticlass () const
 
Bool_t DoRegression () const
 
void ExitFromTraining ()
 
Types::EAnalysisType GetAnalysisType () const
 
UInt_t GetCurrentIter ()
 
virtual Double_t GetEfficiency (const TString &, Types::ETreeType, Double_t &err)
 fill background efficiency (resp. More...
 
const EventGetEvent () const
 
const EventGetEvent (const TMVA::Event *ev) const
 
const EventGetEvent (Long64_t ievt) const
 
const EventGetEvent (Long64_t ievt, Types::ETreeType type) const
 
const std::vector< TMVA::Event * > & GetEventCollection (Types::ETreeType type)
 returns the event collection (i.e. More...
 
TFileGetFile () const
 
const TStringGetInputLabel (Int_t i) const
 
const char * GetInputTitle (Int_t i) const
 
const TStringGetInputVar (Int_t i) const
 
TMultiGraphGetInteractiveTrainingError ()
 
const TStringGetJobName () const
 
virtual Double_t GetKSTrainingVsTest (Char_t SorB, TString opt="X")
 
virtual Double_t GetMaximumSignificance (Double_t SignalEvents, Double_t BackgroundEvents, Double_t &optimal_significance_value) const
 plot significance, \( \frac{S}{\sqrt{S^2 + B^2}} \), curve for given number of signal and background events; returns cut for maximum significance also returned via reference is the maximum significance More...
 
UInt_t GetMaxIter ()
 
Double_t GetMean (Int_t ivar) const
 
const TStringGetMethodName () const
 
Types::EMVA GetMethodType () const
 
TString GetMethodTypeName () const
 
virtual TMatrixD GetMulticlassConfusionMatrix (Double_t effB, Types::ETreeType type)
 Construct a confusion matrix for a multiclass classifier. More...
 
virtual std::vector< Float_tGetMulticlassEfficiency (std::vector< std::vector< Float_t > > &purity)
 
virtual std::vector< Float_tGetMulticlassTrainingEfficiency (std::vector< std::vector< Float_t > > &purity)
 
virtual const std::vector< Float_t > & GetMulticlassValues ()
 
Double_t GetMvaValue (const TMVA::Event *const ev, Double_t *err=0, Double_t *errUpper=0)
 
const char * GetName () const
 
UInt_t GetNEvents () const
 temporary event when testing on a different DataSet than the own one More...
 
UInt_t GetNTargets () const
 
UInt_t GetNvar () const
 
UInt_t GetNVariables () const
 
virtual Double_t GetProba (const Event *ev)
 
virtual Double_t GetProba (Double_t mvaVal, Double_t ap_sig)
 compute likelihood ratio More...
 
const TString GetProbaName () const
 
virtual Double_t GetRarity (Double_t mvaVal, Types::ESBType reftype=Types::kBackground) const
 compute rarity:

\[ R(x) = \int_{[-\infty..x]} { PDF(x') dx' } \]

where PDF(x) is the PDF of the classifier's signal or background distribution More...

 
virtual void GetRegressionDeviation (UInt_t tgtNum, Types::ETreeType type, Double_t &stddev, Double_t &stddev90Percent) const
 
const std::vector< Float_t > & GetRegressionValues (const TMVA::Event *const ev)
 
virtual const std::vector< Float_t > & GetRegressionValues ()
 
Double_t GetRMS (Int_t ivar) const
 
virtual Double_t GetROCIntegral (TH1D *histS, TH1D *histB) const
 calculate the area (integral) under the ROC curve as a overall quality measure of the classification More...
 
virtual Double_t GetROCIntegral (PDF *pdfS=0, PDF *pdfB=0) const
 calculate the area (integral) under the ROC curve as a overall quality measure of the classification More...
 
virtual Double_t GetSeparation (TH1 *, TH1 *) const
 compute "separation" defined as

\[ <s2> = \frac{1}{2} \int_{-\infty}^{+\infty} { \frac{(S(x) - B(x))^2}{(S(x) + B(x))} dx } \]

More...
 
virtual Double_t GetSeparation (PDF *pdfS=0, PDF *pdfB=0) const
 compute "separation" defined as

\[ <s2> = \frac{1}{2} \int_{-\infty}^{+\infty} { \frac{(S(x) - B(x))^2}{(S(x) + B(x))} dx } \]

More...
 
Double_t GetSignalReferenceCut () const
 
Double_t GetSignalReferenceCutOrientation () const
 
virtual Double_t GetSignificance () const
 compute significance of mean difference

\[ significance = \frac{|<S> - <B>|}{\sqrt{RMS_{S2} + RMS_{B2}}} \]

More...
 
const EventGetTestingEvent (Long64_t ievt) const
 
Double_t GetTestTime () const
 
const TStringGetTestvarName () const
 
virtual Double_t GetTrainingEfficiency (const TString &)
 
const EventGetTrainingEvent (Long64_t ievt) const
 
UInt_t GetTrainingROOTVersionCode () const
 
TString GetTrainingROOTVersionString () const
 calculates the ROOT version string from the training version code on the fly More...
 
UInt_t GetTrainingTMVAVersionCode () const
 
TString GetTrainingTMVAVersionString () const
 calculates the TMVA version string from the training version code on the fly More...
 
Double_t GetTrainTime () const
 
TransformationHandlerGetTransformationHandler (Bool_t takeReroutedIfAvailable=true)
 
const TransformationHandlerGetTransformationHandler (Bool_t takeReroutedIfAvailable=true) const
 
TString GetWeightFileName () const
 retrieve weight file name More...
 
Double_t GetXmax (Int_t ivar) const
 
Double_t GetXmin (Int_t ivar) const
 
Bool_t HasMVAPdfs () const
 
void InitIPythonInteractive ()
 
Bool_t IsModelPersistence ()
 
virtual Bool_t IsSignalLike ()
 uses a pre-set cut on the MVA output (SetSignalReferenceCut and SetSignalReferenceCutOrientation) for a quick determination if an event would be selected as signal or background More...
 
virtual Bool_t IsSignalLike (Double_t mvaVal)
 uses a pre-set cut on the MVA output (SetSignalReferenceCut and SetSignalReferenceCutOrientation) for a quick determination if an event with this mva output value would be selected as signal or background More...
 
Bool_t IsSilentFile ()
 
virtual void MakeClass (const TString &classFileName=TString("")) const
 create reader class for method (classification only at present) More...
 
TDirectoryMethodBaseDir () const
 returns the ROOT directory where all instances of the corresponding MVA method are stored More...
 
virtual std::map< TString, Double_tOptimizeTuningParameters (TString fomType="ROCIntegral", TString fitType="FitGA")
 call the Optimizer with the set of parameters and ranges that are meant to be tuned. More...
 
void PrintHelpMessage () const
 prints out method-specific help method More...
 
void ProcessSetup ()
 process all options the "CheckForUnusedOptions" is done in an independent call, since it may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase) More...
 
void ReadStateFromFile ()
 Function to write options and weights to file. More...
 
void ReadStateFromStream (std::istream &tf)
 read the header from the weight files of the different MVA methods More...
 
void ReadStateFromStream (TFile &rf)
 write reference MVA distributions (and other information) to a ROOT type weight file More...
 
void ReadStateFromXMLString (const char *xmlstr)
 for reading from memory More...
 
void RerouteTransformationHandler (TransformationHandler *fTargetTransformation)
 
virtual void Reset ()
 
virtual void SetAnalysisType (Types::EAnalysisType type)
 
void SetBaseDir (TDirectory *methodDir)
 
void SetFile (TFile *file)
 
void SetMethodBaseDir (TDirectory *methodDir)
 
void SetMethodDir (TDirectory *methodDir)
 
void SetModelPersistence (Bool_t status)
 
void SetSignalReferenceCut (Double_t cut)
 
void SetSignalReferenceCutOrientation (Double_t cutOrientation)
 
void SetSilentFile (Bool_t status)
 
void SetTestTime (Double_t testTime)
 
void SetTestvarName (const TString &v="")
 
void SetTrainTime (Double_t trainTime)
 
virtual void SetTuneParameters (std::map< TString, Double_t > tuneParameters)
 set the tuning parameters according to the argument This is just a dummy . More...
 
void SetupMethod ()
 setup of methods More...
 
virtual void TestClassification ()
 initialization More...
 
virtual void TestMulticlass ()
 test multiclass classification More...
 
virtual void TestRegression (Double_t &bias, Double_t &biasT, Double_t &dev, Double_t &devT, Double_t &rms, Double_t &rmsT, Double_t &mInf, Double_t &mInfT, Double_t &corr, Types::ETreeType type)
 calculate <sum-of-deviation-squared> of regression output versus "true" value from test sample More...
 
bool TrainingEnded ()
 
void TrainMethod ()
 
virtual void WriteEvaluationHistosToFile (Types::ETreeType treetype)
 writes all MVA evaluation histograms to file More...
 
virtual void WriteMonitoringHistosToFile () const
 write special monitoring histograms to file dummy implementation here --------------— More...
 
void WriteStateToFile () const
 write options and weights to file note that each one text file for the main configuration information and one ROOT file for ROOT objects are created More...
 
- Public Member Functions inherited from TMVA::IMethod
 IMethod ()
 
virtual ~IMethod ()
 
- 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 >
OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc="")
 
template<class T >
OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc="")
 
template<class T >
TMVA::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)
 
const char * GetConfigDescription () const
 
const char * GetConfigName () const
 
const TStringGetOptions () const
 
MsgLoggerLog () const
 
virtual void ParseOptions ()
 options parser More...
 
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 TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
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 * 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 ()
 Checked and record whether for 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, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
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

void GetHelpMessage () const
 
- Protected Member Functions inherited from TMVA::MethodBase
const TStringGetInternalVarName (Int_t ivar) const
 
virtual std::vector< Double_tGetMvaValues (Long64_t firstEvt=0, Long64_t lastEvt=-1, Bool_t logProgress=false)
 get all the MVA values for the events of the current Data type More...
 
const TStringGetOriginalVarName (Int_t ivar) const
 
const TStringGetWeightFileDir () const
 
Bool_t HasTrainingTree () const
 
Bool_t Help () const
 
Bool_t IgnoreEventsWithNegWeightsInTraining () const
 
Bool_t IsConstructedFromWeightFile () const
 
Bool_t IsNormalised () const
 
virtual void MakeClassSpecific (std::ostream &, const TString &="") const
 
virtual void MakeClassSpecificHeader (std::ostream &, const TString &="") const
 
void NoErrorCalc (Double_t *const err, Double_t *const errUpper)
 
virtual void ReadWeightsFromStream (TFile &)
 
void SetNormalised (Bool_t norm)
 
void SetWeightFileDir (TString fileDir)
 set directory of weight file More...
 
void SetWeightFileName (TString)
 set the weight file name (depreciated) More...
 
void Statistics (Types::ETreeType treeType, const TString &theVarName, Double_t &, Double_t &, Double_t &, Double_t &, Double_t &, Double_t &)
 calculates rms,mean, xmin, xmax of the event variable this can be either done for the variables as they are or for normalised variables (in the range of 0-1) if "norm" is set to kTRUE More...
 
Bool_t TxtWeightsOnly () const
 
Bool_t Verbose () const
 
- 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 ()
 

Private Types

using ArchitectureImpl_t = TMVA::DNN::TReference< Double_t >
 
using DeepNetImpl_t = TMVA::DNN::TDeepNet< ArchitectureImpl_t >
 
using KeyValueVector_t = std::vector< std::map< TString, TString > >
 

Private Member Functions

template<typename Architecture_t , typename Layer_t >
void CreateDeepNet (DNN::TDeepNet< Architecture_t, Layer_t > &deepNet, std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &nets)
 After calling the ProcesOptions(), all of the options are parsed, so using the parsed options, and given the architecture and the type of the layers, we build the Deep Network passed as a reference in the function. More...
 
void DeclareOptions ()
 The option handling methods. More...
 
void Init ()
 default initializations More...
 
void ParseBatchLayout ()
 Parse the input layout. More...
 
template<typename Architecture_t , typename Layer_t >
void ParseConvLayer (DNN::TDeepNet< Architecture_t, Layer_t > &deepNet, std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &nets, TString layerString, TString delim)
 Pases the layer string and creates the appropriate convolutional layer. More...
 
template<typename Architecture_t , typename Layer_t >
void ParseDenseLayer (DNN::TDeepNet< Architecture_t, Layer_t > &deepNet, std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &nets, TString layerString, TString delim)
 Pases the layer string and creates the appropriate dense layer. More...
 
void ParseInputLayout ()
 Parse the input layout. More...
 
template<typename Architecture_t , typename Layer_t >
void ParseLstmLayer (DNN::TDeepNet< Architecture_t, Layer_t > &deepNet, std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &nets, TString layerString, TString delim)
 Pases the layer string and creates the appropriate lstm layer. More...
 
template<typename Architecture_t , typename Layer_t >
void ParseMaxPoolLayer (DNN::TDeepNet< Architecture_t, Layer_t > &deepNet, std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &nets, TString layerString, TString delim)
 Pases the layer string and creates the appropriate max pool layer. More...
 
template<typename Architecture_t , typename Layer_t >
void ParseReshapeLayer (DNN::TDeepNet< Architecture_t, Layer_t > &deepNet, std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &nets, TString layerString, TString delim)
 Pases the layer string and creates the appropriate reshape layer. More...
 
template<typename Architecture_t , typename Layer_t >
void ParseRnnLayer (DNN::TDeepNet< Architecture_t, Layer_t > &deepNet, std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &nets, TString layerString, TString delim)
 Pases the layer string and creates the appropriate rnn layer. More...
 
void ProcessOptions ()
 
template<typename Architecture_t >
void TrainDeepNet ()
 Implementation of architecture specific train method. More...
 

Private Attributes

TString fArchitectureString
 The string defining the architecure: CPU or GPU. More...
 
size_t fBatchDepth
 The depth of the batch used to train the deep net. More...
 
size_t fBatchHeight
 The height of the batch used to train the deep net. More...
 
TString fBatchLayoutString
 The string defining the layout of the batch. More...
 
size_t fBatchWidth
 The width of the batch used to train the deep net. More...
 
bool fBuildNet
 Flag to control whether to build fNet, the stored network used for the evaluation. More...
 
TString fErrorStrategy
 The string defining the error strategy for training. More...
 
size_t fInputDepth
 The depth of the input. More...
 
size_t fInputHeight
 The height of the input. More...
 
TString fInputLayoutString
 The string defining the layout of the input. More...
 
size_t fInputWidth
 The width of the input. More...
 
TString fLayoutString
 The string defining the layout of the deep net. More...
 
DNN::ELossFunction fLossFunction
 The loss function. More...
 
std::unique_ptr< DeepNetImpl_tfNet
 
DNN::EOutputFunction fOutputFunction
 The output function for making the predictions. More...
 
size_t fRandomSeed
 The random seed used to initialize the weights and shuffling batches (default is zero) More...
 
bool fResume
 
KeyValueVector_t fSettings
 Map for the training strategy. More...
 
std::vector< TTrainingSettingsfTrainingSettings
 The vector defining each training strategy. More...
 
TString fTrainingStrategyString
 The string defining the training strategy. More...
 
DNN::EInitialization fWeightInitialization
 The initialization method. More...
 
TString fWeightInitializationString
 The string defining the weight initialization method. More...
 

Additional Inherited Members

- Public Types inherited from TMVA::MethodBase
enum  EWeightFileType { kROOT =0, kTEXT }
 
- 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...
 
- Public Attributes inherited from TMVA::MethodBase
Bool_t fSetupCompleted
 
const EventfTmpEvent
 
- Protected Attributes inherited from TMVA::MethodBase
Types::EAnalysisType fAnalysisType
 
UInt_t fBackgroundClass
 
bool fExitFromTraining = false
 
std::vector< TString > * fInputVars
 
IPythonInteractivefInteractive = nullptr
 
UInt_t fIPyCurrentIter = 0
 
UInt_t fIPyMaxIter = 0
 
std::vector< Float_t > * fMulticlassReturnVal
 
Int_t fNbins
 
Int_t fNbinsH
 
Int_t fNbinsMVAoutput
 
RankingfRanking
 
std::vector< Float_t > * fRegressionReturnVal
 
ResultsfResults
 
UInt_t fSignalClass
 
- Protected Attributes inherited from TMVA::Configurable
MsgLoggerfLogger
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TMVA/MethodDL.h>

Inheritance diagram for TMVA::MethodDL:
[legend]

Member Typedef Documentation

◆ ArchitectureImpl_t

using TMVA::MethodDL::ArchitectureImpl_t = TMVA::DNN::TReference<Double_t>
private

Definition at line 87 of file MethodDL.h.

◆ DeepNetImpl_t

using TMVA::MethodDL::DeepNetImpl_t = TMVA::DNN::TDeepNet<ArchitectureImpl_t>
private

Definition at line 90 of file MethodDL.h.

◆ KeyValueVector_t

using TMVA::MethodDL::KeyValueVector_t = std::vector<std::map<TString, TString> >
private

Definition at line 79 of file MethodDL.h.

Constructor & Destructor Documentation

◆ MethodDL() [1/2]

TMVA::MethodDL::MethodDL ( const TString jobName,
const TString methodTitle,
DataSetInfo theData,
const TString theOption 
)

Constructor.

Standard constructor.

Definition at line 883 of file MethodDL.cxx.

◆ MethodDL() [2/2]

TMVA::MethodDL::MethodDL ( DataSetInfo theData,
const TString theWeightFile 
)

Constructor.

Constructor from a weight file.

Definition at line 894 of file MethodDL.cxx.

◆ ~MethodDL()

TMVA::MethodDL::~MethodDL ( )
virtual

Virtual Destructor.

Destructor.

Definition at line 905 of file MethodDL.cxx.

Member Function Documentation

◆ AddWeightsXMLTo()

void TMVA::MethodDL::AddWeightsXMLTo ( void parent) const
virtual

Implements TMVA::MethodBase.

Definition at line 1433 of file MethodDL.cxx.

◆ CreateDeepNet()

template<typename Architecture_t , typename Layer_t >
void TMVA::MethodDL::CreateDeepNet ( DNN::TDeepNet< Architecture_t, Layer_t > &  deepNet,
std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &  nets 
)
private

After calling the ProcesOptions(), all of the options are parsed, so using the parsed options, and given the architecture and the type of the layers, we build the Deep Network passed as a reference in the function.

Create a deep net based on the layout string.

Definition at line 459 of file MethodDL.cxx.

◆ CreateRanking()

const Ranking * TMVA::MethodDL::CreateRanking ( )
virtual

Implements TMVA::MethodBase.

Definition at line 1657 of file MethodDL.cxx.

◆ DeclareOptions()

void TMVA::MethodDL::DeclareOptions ( )
privatevirtual

The option handling methods.

Implements TMVA::MethodBase.

Definition at line 151 of file MethodDL.cxx.

◆ GetArchitectureString()

TString TMVA::MethodDL::GetArchitectureString ( ) const
inline

Definition at line 225 of file MethodDL.h.

◆ GetBatchDepth()

size_t TMVA::MethodDL::GetBatchDepth ( ) const
inline

Definition at line 209 of file MethodDL.h.

◆ GetBatchHeight()

size_t TMVA::MethodDL::GetBatchHeight ( ) const
inline

Definition at line 210 of file MethodDL.h.

◆ GetBatchLayoutString()

TString TMVA::MethodDL::GetBatchLayoutString ( ) const
inline

Definition at line 220 of file MethodDL.h.

◆ GetBatchWidth()

size_t TMVA::MethodDL::GetBatchWidth ( ) const
inline

Definition at line 211 of file MethodDL.h.

◆ GetDeepNet()

const DeepNetImpl_t& TMVA::MethodDL::GetDeepNet ( ) const
inline

Definition at line 213 of file MethodDL.h.

◆ GetErrorStrategyString()

TString TMVA::MethodDL::GetErrorStrategyString ( ) const
inline

Definition at line 222 of file MethodDL.h.

◆ GetHelpMessage()

void TMVA::MethodDL::GetHelpMessage ( ) const
protectedvirtual

Implements TMVA::IMethod.

Definition at line 1664 of file MethodDL.cxx.

◆ GetInputDepth()

size_t TMVA::MethodDL::GetInputDepth ( ) const
inline

Definition at line 205 of file MethodDL.h.

◆ GetInputHeight()

size_t TMVA::MethodDL::GetInputHeight ( ) const
inline

Definition at line 206 of file MethodDL.h.

◆ GetInputLayoutString()

TString TMVA::MethodDL::GetInputLayoutString ( ) const
inline

Definition at line 219 of file MethodDL.h.

◆ GetInputWidth()

size_t TMVA::MethodDL::GetInputWidth ( ) const
inline

Definition at line 207 of file MethodDL.h.

◆ GetKeyValueSettings() [1/2]

const KeyValueVector_t& TMVA::MethodDL::GetKeyValueSettings ( ) const
inline

Definition at line 229 of file MethodDL.h.

◆ GetKeyValueSettings() [2/2]

KeyValueVector_t& TMVA::MethodDL::GetKeyValueSettings ( )
inline

Definition at line 230 of file MethodDL.h.

◆ GetLayoutString()

TString TMVA::MethodDL::GetLayoutString ( ) const
inline

Definition at line 221 of file MethodDL.h.

◆ GetLossFunction()

DNN::ELossFunction TMVA::MethodDL::GetLossFunction ( ) const
inline

Definition at line 217 of file MethodDL.h.

◆ GetMvaValue()

Double_t TMVA::MethodDL::GetMvaValue ( Double_t err = 0,
Double_t errUpper = 0 
)
virtual

Implements TMVA::MethodBase.

Definition at line 1331 of file MethodDL.cxx.

◆ GetOutputFunction()

DNN::EOutputFunction TMVA::MethodDL::GetOutputFunction ( ) const
inline

Definition at line 216 of file MethodDL.h.

◆ GetTrainingSettings() [1/2]

const std::vector<TTrainingSettings>& TMVA::MethodDL::GetTrainingSettings ( ) const
inline

Definition at line 227 of file MethodDL.h.

◆ GetTrainingSettings() [2/2]

std::vector<TTrainingSettings>& TMVA::MethodDL::GetTrainingSettings ( )
inline

Definition at line 228 of file MethodDL.h.

◆ GetTrainingStrategyString()

TString TMVA::MethodDL::GetTrainingStrategyString ( ) const
inline

Definition at line 223 of file MethodDL.h.

◆ GetWeightInitialization()

DNN::EInitialization TMVA::MethodDL::GetWeightInitialization ( ) const
inline

Definition at line 215 of file MethodDL.h.

◆ GetWeightInitializationString()

TString TMVA::MethodDL::GetWeightInitializationString ( ) const
inline

Definition at line 224 of file MethodDL.h.

◆ HasAnalysisType()

Bool_t TMVA::MethodDL::HasAnalysisType ( Types::EAnalysisType  type,
UInt_t  numberClasses,
UInt_t  numberTargets 
)
virtual

Check the type of analysis the deep learning network can do.

What kind of analysis type can handle the CNN.

Implements TMVA::IMethod.

Definition at line 951 of file MethodDL.cxx.

◆ Init()

void TMVA::MethodDL::Init ( void  )
privatevirtual

default initializations

Implements TMVA::MethodBase.

Definition at line 359 of file MethodDL.cxx.

◆ ParseBatchLayout()

void TMVA::MethodDL::ParseBatchLayout ( )
private

Parse the input layout.

Definition at line 412 of file MethodDL.cxx.

◆ ParseConvLayer()

template<typename Architecture_t , typename Layer_t >
void TMVA::MethodDL::ParseConvLayer ( DNN::TDeepNet< Architecture_t, Layer_t > &  deepNet,
std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &  nets,
TString  layerString,
TString  delim 
)
private

Pases the layer string and creates the appropriate convolutional layer.

Definition at line 583 of file MethodDL.cxx.

◆ ParseDenseLayer()

template<typename Architecture_t , typename Layer_t >
void TMVA::MethodDL::ParseDenseLayer ( DNN::TDeepNet< Architecture_t, Layer_t > &  deepNet,
std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &  nets,
TString  layerString,
TString  delim 
)
private

Pases the layer string and creates the appropriate dense layer.

Definition at line 506 of file MethodDL.cxx.

◆ ParseInputLayout()

void TMVA::MethodDL::ParseInputLayout ( )
private

Parse the input layout.

Definition at line 366 of file MethodDL.cxx.

◆ ParseKeyValueString()

auto TMVA::MethodDL::ParseKeyValueString ( TString  parseString,
TString  blockDelim,
TString  tokenDelim 
)

Function for parsing the training settings, provided as a string in a key-value form.

Parse key value pairs in blocks -> return vector of blocks with map of key value pairs.

Definition at line 912 of file MethodDL.cxx.

◆ ParseLstmLayer()

template<typename Architecture_t , typename Layer_t >
void TMVA::MethodDL::ParseLstmLayer ( DNN::TDeepNet< Architecture_t, Layer_t > &  deepNet,
std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &  nets,
TString  layerString,
TString  delim 
)
private

Pases the layer string and creates the appropriate lstm layer.

Definition at line 864 of file MethodDL.cxx.

◆ ParseMaxPoolLayer()

template<typename Architecture_t , typename Layer_t >
void TMVA::MethodDL::ParseMaxPoolLayer ( DNN::TDeepNet< Architecture_t, Layer_t > &  deepNet,
std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &  nets,
TString  layerString,
TString  delim 
)
private

Pases the layer string and creates the appropriate max pool layer.

Definition at line 682 of file MethodDL.cxx.

◆ ParseReshapeLayer()

template<typename Architecture_t , typename Layer_t >
void TMVA::MethodDL::ParseReshapeLayer ( DNN::TDeepNet< Architecture_t, Layer_t > &  deepNet,
std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &  nets,
TString  layerString,
TString  delim 
)
private

Pases the layer string and creates the appropriate reshape layer.

Definition at line 742 of file MethodDL.cxx.

◆ ParseRnnLayer()

template<typename Architecture_t , typename Layer_t >
void TMVA::MethodDL::ParseRnnLayer ( DNN::TDeepNet< Architecture_t, Layer_t > &  deepNet,
std::vector< DNN::TDeepNet< Architecture_t, Layer_t >> &  nets,
TString  layerString,
TString  delim 
)
private

Pases the layer string and creates the appropriate rnn layer.

Definition at line 803 of file MethodDL.cxx.

◆ ProcessOptions()

void TMVA::MethodDL::ProcessOptions ( )
privatevirtual

Implements TMVA::MethodBase.

Definition at line 205 of file MethodDL.cxx.

◆ ReadWeightsFromStream()

void TMVA::MethodDL::ReadWeightsFromStream ( std::istream &  )
virtual

Implements TMVA::MethodBase.

Definition at line 1652 of file MethodDL.cxx.

◆ ReadWeightsFromXML()

void TMVA::MethodDL::ReadWeightsFromXML ( void wghtnode)
virtual

Implements TMVA::MethodBase.

Definition at line 1494 of file MethodDL.cxx.

◆ SetArchitectureString()

void TMVA::MethodDL::SetArchitectureString ( TString  architectureString)
inline

Definition at line 252 of file MethodDL.h.

◆ SetBatchDepth()

void TMVA::MethodDL::SetBatchDepth ( size_t  batchDepth)
inline

Definition at line 237 of file MethodDL.h.

◆ SetBatchHeight()

void TMVA::MethodDL::SetBatchHeight ( size_t  batchHeight)
inline

Definition at line 238 of file MethodDL.h.

◆ SetBatchWidth()

void TMVA::MethodDL::SetBatchWidth ( size_t  batchWidth)
inline

Definition at line 239 of file MethodDL.h.

◆ SetErrorStrategyString()

void TMVA::MethodDL::SetErrorStrategyString ( TString  errorStrategy)
inline

Definition at line 246 of file MethodDL.h.

◆ SetInputDepth()

void TMVA::MethodDL::SetInputDepth ( size_t  inputDepth)
inline

Setters.

Definition at line 233 of file MethodDL.h.

◆ SetInputHeight()

void TMVA::MethodDL::SetInputHeight ( size_t  inputHeight)
inline

Definition at line 234 of file MethodDL.h.

◆ SetInputWidth()

void TMVA::MethodDL::SetInputWidth ( size_t  inputWidth)
inline

Definition at line 235 of file MethodDL.h.

◆ SetLayoutString()

void TMVA::MethodDL::SetLayoutString ( TString  layoutString)
inline

Definition at line 253 of file MethodDL.h.

◆ SetOutputFunction()

void TMVA::MethodDL::SetOutputFunction ( DNN::EOutputFunction  outputFunction)
inline

Definition at line 245 of file MethodDL.h.

◆ SetTrainingStrategyString()

void TMVA::MethodDL::SetTrainingStrategyString ( TString  trainingStrategyString)
inline

Definition at line 247 of file MethodDL.h.

◆ SetWeightInitialization()

void TMVA::MethodDL::SetWeightInitialization ( DNN::EInitialization  weightInitialization)
inline

Definition at line 241 of file MethodDL.h.

◆ SetWeightInitializationString()

void TMVA::MethodDL::SetWeightInitializationString ( TString  weightInitializationString)
inline

Definition at line 248 of file MethodDL.h.

◆ Train()

void TMVA::MethodDL::Train ( void  )
virtual

Methods for training the deep learning network.

Implements TMVA::MethodBase.

Definition at line 1275 of file MethodDL.cxx.

◆ TrainDeepNet()

template<typename Architecture_t >
void TMVA::MethodDL::TrainDeepNet ( )
private

Implementation of architecture specific train method.

Definition at line 965 of file MethodDL.cxx.

Member Data Documentation

◆ fArchitectureString

TString TMVA::MethodDL::fArchitectureString
private

The string defining the architecure: CPU or GPU.

Definition at line 160 of file MethodDL.h.

◆ fBatchDepth

size_t TMVA::MethodDL::fBatchDepth
private

The depth of the batch used to train the deep net.

Definition at line 144 of file MethodDL.h.

◆ fBatchHeight

size_t TMVA::MethodDL::fBatchHeight
private

The height of the batch used to train the deep net.

Definition at line 145 of file MethodDL.h.

◆ fBatchLayoutString

TString TMVA::MethodDL::fBatchLayoutString
private

The string defining the layout of the batch.

Definition at line 155 of file MethodDL.h.

◆ fBatchWidth

size_t TMVA::MethodDL::fBatchWidth
private

The width of the batch used to train the deep net.

Definition at line 146 of file MethodDL.h.

◆ fBuildNet

bool TMVA::MethodDL::fBuildNet
private

Flag to control whether to build fNet, the stored network used for the evaluation.

Definition at line 162 of file MethodDL.h.

◆ fErrorStrategy

TString TMVA::MethodDL::fErrorStrategy
private

The string defining the error strategy for training.

Definition at line 157 of file MethodDL.h.

◆ fInputDepth

size_t TMVA::MethodDL::fInputDepth
private

The depth of the input.

Definition at line 140 of file MethodDL.h.

◆ fInputHeight

size_t TMVA::MethodDL::fInputHeight
private

The height of the input.

Definition at line 141 of file MethodDL.h.

◆ fInputLayoutString

TString TMVA::MethodDL::fInputLayoutString
private

The string defining the layout of the input.

Definition at line 154 of file MethodDL.h.

◆ fInputWidth

size_t TMVA::MethodDL::fInputWidth
private

The width of the input.

Definition at line 142 of file MethodDL.h.

◆ fLayoutString

TString TMVA::MethodDL::fLayoutString
private

The string defining the layout of the deep net.

Definition at line 156 of file MethodDL.h.

◆ fLossFunction

DNN::ELossFunction TMVA::MethodDL::fLossFunction
private

The loss function.

Definition at line 152 of file MethodDL.h.

◆ fNet

std::unique_ptr<DeepNetImpl_t> TMVA::MethodDL::fNet
private

Definition at line 91 of file MethodDL.h.

◆ fOutputFunction

DNN::EOutputFunction TMVA::MethodDL::fOutputFunction
private

The output function for making the predictions.

Definition at line 151 of file MethodDL.h.

◆ fRandomSeed

size_t TMVA::MethodDL::fRandomSeed
private

The random seed used to initialize the weights and shuffling batches (default is zero)

Definition at line 148 of file MethodDL.h.

◆ fResume

bool TMVA::MethodDL::fResume
private

Definition at line 161 of file MethodDL.h.

◆ fSettings

KeyValueVector_t TMVA::MethodDL::fSettings
private

Map for the training strategy.

Definition at line 164 of file MethodDL.h.

◆ fTrainingSettings

std::vector<TTrainingSettings> TMVA::MethodDL::fTrainingSettings
private

The vector defining each training strategy.

Definition at line 165 of file MethodDL.h.

◆ fTrainingStrategyString

TString TMVA::MethodDL::fTrainingStrategyString
private

The string defining the training strategy.

Definition at line 158 of file MethodDL.h.

◆ fWeightInitialization

DNN::EInitialization TMVA::MethodDL::fWeightInitialization
private

The initialization method.

Definition at line 150 of file MethodDL.h.

◆ fWeightInitializationString

TString TMVA::MethodDL::fWeightInitializationString
private

The string defining the weight initialization method.

Definition at line 159 of file MethodDL.h.

Libraries for TMVA::MethodDL:
[legend]

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