Inheritance 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
b2luigi	n_events_training = b2luigi.IntParameter()
	Number of events to generate for the training data set.

b2luigi	experiment_number = b2luigi.IntParameter()
	Experiment number of the conditions database, e.g.

b2luigi	process_type
	Define which kind of process shall be used.

b2luigi	training_target
	Feature/variable to use as truth label in the quality estimator MVA classifier.

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

b2luigi	fast_bdt_option
	Hyperparameter option of the FastBDT algorithm.

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 1163 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 1252 of file combined_quality_estimator_teacher.py.

    def data_collection_task(self) -> Basf2PathTask:
        """
        Property defining the specific ``DataCollectionTask`` to require.  Must
        implemented by the inheriting specific teacher task class.
        """
        raise NotImplementedError(
            "Teacher Task must define a data collection task to require "
        )
 

◆ 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 1216 of file combined_quality_estimator_teacher.py.

    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.
        """
        if fast_bdt_option is None:
            fast_bdt_option = self.fast_bdt_option
        if recotrack_option is None and hasattr(self, 'recotrack_option'):
            recotrack_option = self.recotrack_option
        else:
            recotrack_option = ''
        weightfile_details = create_fbdt_option_string(fast_bdt_option)
        weightfile_name = self.weightfile_identifier_basename + weightfile_details
        if recotrack_option != '':
            weightfile_name = weightfile_name + '_' + recotrack_option
        return weightfile_name + ".weights.xml"
 

◆ 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 1281 of file combined_quality_estimator_teacher.py.

    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.
        """
        yield self.add_to_output(self.get_weightfile_xml_identifier())
 

◆ 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 1288 of file combined_quality_estimator_teacher.py.

    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``.
        """
        if 'USEREC' in self.process_type:
            if 'USERECBB' in self.process_type:
                process = 'BBBAR'
            elif 'USERECEE' in self.process_type:
                process = 'BHABHA'
            records_files = ['datafiles/qe_records_N' + str(self.n_events_training) +
                             '_' + process + '_' + self.random_seed + '.root']
        else:
            if hasattr(self, 'recotrack_option'):
                records_files = self.get_input_file_names(
                    self.data_collection_task.get_records_file_name(
                        self.data_collection_task,
                        n_events=self.n_events_training,
                        random_seed=self.process_type + '_' + self.random_seed,
                        recotrack_option=self.recotrack_option))
            else:
                records_files = self.get_input_file_names(
                    self.data_collection_task.get_records_file_name(
                        self.data_collection_task,
                        n_events=self.n_events_training,
                        random_seed=self.process_type + '_' + self.random_seed))
 
        my_basf2_mva_teacher(
            records_files=records_files,
            tree_name=self.tree_name,
            weightfile_identifier=self.get_output_file_name(self.get_weightfile_xml_identifier()),
            target_variable=self.training_target,
            exclude_variables=self.exclude_variables,
            fast_bdt_option=self.fast_bdt_option,
        )
 
 

◆ 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 1243 of file combined_quality_estimator_teacher.py.

    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.
        """
        raise NotImplementedError("Teacher Task must define a static random seed")
 

◆ requires()

def requires ( self )

Generate list of luigi Tasks that this Task depends on.

Reimplemented in RecoTrackQETeacherTask.

Definition at line 1261 of file combined_quality_estimator_teacher.py.

    def requires(self):
        """
        Generate list of luigi Tasks that this Task depends on.
        """
        if 'USEREC' in self.process_type:
            if 'USERECBB' in self.process_type:
                process = 'BBBAR'
            elif 'USERECEE' in self.process_type:
                process = 'BHABHA'
            yield CheckExistingFile(
                filename='datafiles/qe_records_N' + str(self.n_events_training) + '_' + process + '_' + self.random_seed + '.root',
                )
        else:
            yield self.data_collection_task(
                num_processes=MasterTask.num_processes,
                n_events=self.n_events_training,
                experiment_number=self.experiment_number,
                random_seed=self.process_type + '_' + self.random_seed,
                )
 

◆ 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 1234 of file combined_quality_estimator_teacher.py.

    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.
        """
        raise NotImplementedError("Teacher Task must define a static tree_name")
 

◆ 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 1207 of file combined_quality_estimator_teacher.py.

    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.
        """
        raise NotImplementedError(
            "Teacher Task must define a static weightfile_identifier"
        )
 

Member Data Documentation

◆ exclude_variables

b2luigi exclude_variables

static

Initial value:

=  b2luigi.ListParameter(
        
    )

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 1194 of file combined_quality_estimator_teacher.py.

◆ experiment_number

b2luigi experiment_number = b2luigi.IntParameter()

static

Experiment number of the conditions database, e.g.

defines simulation geometry

Definition at line 1177 of file combined_quality_estimator_teacher.py.

◆ fast_bdt_option

b2luigi fast_bdt_option

static

Initial value:

=  b2luigi.ListParameter(
        
    )

Hyperparameter option of the FastBDT algorithm.

default are the FastBDT default values.

Definition at line 1200 of file combined_quality_estimator_teacher.py.

◆ n_events_training

b2luigi n_events_training = b2luigi.IntParameter()

static

Number of events to generate for the training data set.

Definition at line 1175 of file combined_quality_estimator_teacher.py.

◆ process_type

b2luigi process_type

static

Initial value:

=  b2luigi.Parameter(
        
    )

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 1181 of file combined_quality_estimator_teacher.py.

◆ training_target

b2luigi training_target

static

Initial value:

=  b2luigi.Parameter(
        
    )

Feature/variable to use as truth label in the quality estimator MVA classifier.

Definition at line 1187 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

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ data_collection_task()

◆ get_weightfile_xml_identifier()

◆ output()

◆ process()

◆ random_seed()

◆ requires()

◆ tree_name()

◆ weightfile_identifier_basename()

Member Data Documentation

◆ exclude_variables

◆ experiment_number

◆ fast_bdt_option

◆ n_events_training

◆ process_type

◆ training_target