TrackQETeacherBaseTask Class Reference

Inheritance diagram for TrackQETeacherBaseTask:

Collaboration diagram for TrackQETeacherBaseTask:

Public Member Functions
def	weightfile_identifier_basename (self)
def	get_weightfile_xml_identifier (self, fast_bdt_option=None, recotrack_option=None)
def	tree_name (self)
def	random_seed (self)
Basf2PathTask	data_collection_task (self)
def	requires (self)
def	output (self)
def	process (self)

Static Public Attributes
	n_events_training = b2luigi.IntParameter()
	Number of events to generate for the training data set.
	experiment_number = b2luigi.IntParameter()
	Experiment number of the conditions database, e.g. More...
	process_type = b2luigi.Parameter(default="BBBAR")
	Define which kind of process shall be used. More...
	training_target = b2luigi.Parameter(default="truth")
	Feature/variable to use as truth label in the quality estimator MVA classifier.
	exclude_variables = b2luigi.ListParameter(hashed=True, default=[])
	List of collected variables to not use in the training of the QE MVA classifier. More...
	fast_bdt_option = b2luigi.ListParameter(hashed=True, default=[200, 8, 3, 0.1])
	Hyperparameter option of the FastBDT algorithm. More...

Detailed Description

A teacher task runs the basf2 mva teacher on the training data provided by a
data collection task.

Since teacher tasks are needed for all quality estimators covered by this
steering file and the only thing that changes is the required data
collection task and some training parameters, I decided to use inheritance
and have the basic functionality in this base class/interface and have the
specific teacher tasks inherit from it.

Definition at line 1014 of file combined_quality_estimator_teacher.py.

Member Function Documentation

data_collection_task()

Basf2PathTask data_collection_task

(

self

)

Property defining the specific ``DataCollectionTask`` to require.  Must
implemented by the inheriting specific teacher task class.

Definition at line 1087 of file combined_quality_estimator_teacher.py.

get_weightfile_xml_identifier()

def get_weightfile_xml_identifier	(		self,
			fast_bdt_option = None,
			recotrack_option = None
	)

Name of the xml weightfile that is created by the teacher task.
It is subsequently used as a local weightfile in the following validation tasks.

Definition at line 1051 of file combined_quality_estimator_teacher.py.

output()

def output

(

self

)

Generate list of output files that the task should produce.
The task is considered finished if and only if the outputs all exist.

Definition at line 1116 of file combined_quality_estimator_teacher.py.

process()

def process

(

self

)

Use basf2_mva teacher to create MVA weightfile from collected training
data variables.

This is the main process that is dispatched by the ``run`` method that
is inherited from ``Basf2Task``.

Definition at line 1123 of file combined_quality_estimator_teacher.py.

random_seed()

def random_seed

(

self

)

Property defining random seed to be used by the ``GenerateSimTask``.
Should differ from the random seed in the test data samples.  Must
implemented by the inheriting specific teacher task class.

Definition at line 1078 of file combined_quality_estimator_teacher.py.

requires()

def requires

(

self

)

Generate list of luigi Tasks that this Task depends on.

Reimplemented in RecoTrackQETeacherTask.

Definition at line 1096 of file combined_quality_estimator_teacher.py.

tree_name()

def tree_name

(

self

)

Property defining the name of the tree in the ROOT file from the
``data_collection_task`` that contains the recorded training data.  Must
implemented by the inheriting specific teacher task class.

Definition at line 1069 of file combined_quality_estimator_teacher.py.

weightfile_identifier_basename()

def weightfile_identifier_basename

(

self

)

Property defining the basename for the .xml and .root weightfiles that are created.
Has to be implemented by the inheriting teacher task class.

Definition at line 1042 of file combined_quality_estimator_teacher.py.

Member Data Documentation

exclude_variables

exclude_variables = b2luigi.ListParameter(hashed=True, default=[])

static

List of collected variables to not use in the training of the QE MVA classifier.

In addition to variables containing the "truth" substring, which are excluded by default.

Definition at line 1037 of file combined_quality_estimator_teacher.py.

experiment_number

experiment_number = b2luigi.IntParameter()

static

Experiment number of the conditions database, e.g.

defines simulation geometry

Definition at line 1028 of file combined_quality_estimator_teacher.py.

fast_bdt_option

fast_bdt_option = b2luigi.ListParameter(hashed=True, default=[200, 8, 3, 0.1])

static

Hyperparameter option of the FastBDT algorithm.

default are the FastBDT default values.

Definition at line 1039 of file combined_quality_estimator_teacher.py.

process_type

process_type = b2luigi.Parameter(default="BBBAR")

static

Define which kind of process shall be used.

Decide between simulating BBBAR or BHABHA, MUMU, YY, DDBAR, UUBAR, SSBAR, CCBAR, reconstructing DATA or already simulated files (USESIMBB/EE) or running on existing reconstructed files (USERECBB/EE)

Definition at line 1032 of file combined_quality_estimator_teacher.py.

---

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

• tracking/scripts/tracking/train/combined_quality_estimator_teacher.py