Inheritance diagram for QEWeightsLocalDBCreatorTask:

Public Member Functions
def	requires (self)

def	output (self)

def	process (self)

def	on_failure (self, exception)

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	cdc_training_target = b2luigi.Parameter()
	Feature/variable to use as truth label for the CDC track quality estimator.

b2luigi	fast_bdt_option
	Hyperparameter option of the FastBDT algorithm.

Protected Member Functions
def	_clean (self)

Detailed Description

Collect weightfile identifiers from different teacher tasks and merge them
into a local database for testing.

Definition at line 2372 of file combined_quality_estimator_teacher.py.

Member Function Documentation

◆ _clean()

def _clean ( self )

protected

Remove local database and tar archives in output directory

Definition at line 2469 of file combined_quality_estimator_teacher.py.

    def _clean(self):
        """
        Remove local database and tar archives in output directory
        """
        localdb_archive_path = Path(self.get_output_file_name("localdb.tar"))
        localdb_path = localdb_archive_path.parent / "localdb"
 
        if localdb_path.exists():
            print(f"Deleting localdb\n{localdb_path}\nwith contents\n ",
                  "\n  ".join(f.name for f in localdb_path.iterdir()))
            shutil.rmtree(localdb_path, ignore_errors=False)  # recursively delete localdb
 
        if localdb_archive_path.is_file():
            print(f"Deleting {localdb_archive_path}")
            os.remove(localdb_archive_path)
 

◆ on_failure()

def on_failure	(	self,
		exception
	)

Cleanup: Remove local database to prevent existing outputs when task did not finish successfully

Definition at line 2485 of file combined_quality_estimator_teacher.py.

    def on_failure(self, exception):
        """
        Cleanup: Remove local database to prevent existing outputs when task did not finish successfully
        """
        self._clean()
        # Run existing on_failure from parent class
        super().on_failure(exception)
 
 

◆ output()

def output ( self )

Local database

Definition at line 2426 of file combined_quality_estimator_teacher.py.

    def output(self):
        """
        Local database
        """
        yield self.add_to_output("localdb.tar")
 

◆ process()

def process ( self )

Create local database

Definition at line 2432 of file combined_quality_estimator_teacher.py.

    def process(self):
        """
        Create local database
        """
        current_path = Path.cwd()
        localdb_archive_path = Path(self.get_output_file_name("localdb.tar")).absolute()
        output_dir = localdb_archive_path.parent
 
        # remove existing local databases in output directories
        self._clean()
        # "Upload" the weightfiles of all 3 teacher tasks into the same localdb
        for task in (VXDQETeacherTask, CDCQETeacherTask, RecoTrackQETeacherTask):
            # Extract xml identifier input file name before switching working directories, as it returns relative paths
            weightfile_xml_identifier_path = os.path.abspath(self.get_input_file_names(
                task.get_weightfile_xml_identifier(task, fast_bdt_option=self.fast_bdt_option))[0])
            # As localdb is created in working directory, chdir into desired output path
            try:
                os.chdir(output_dir)
                # Same as basf2_mva_upload on the command line, creates localdb directory in current working dir
                basf2_mva.upload(
                    weightfile_xml_identifier_path,
                    task.weightfile_identifier_basename,
                    self.experiment_number, 0,
                    self.experiment_number, -1,
                )
            finally:  # Switch back to working directory of b2luigi, even if upload failed
                os.chdir(current_path)
 
        # Pack localdb into tar archive, so that we can have on single output file instead
        shutil.make_archive(
            base_name=localdb_archive_path.as_posix().split('.')[0],
            format="tar",
            root_dir=output_dir,
            base_dir="localdb",
            verbose=True,
        )
 

◆ requires()

def requires ( self )

Required teacher tasks

Definition at line 2398 of file combined_quality_estimator_teacher.py.

    def requires(self):
        """
        Required teacher tasks
        """
        yield VXDQETeacherTask(
            n_events_training=self.n_events_training,
            process_type=self.process_type,
            experiment_number=self.experiment_number,
            exclude_variables=MasterTask.exclude_variables_vxd,
            fast_bdt_option=self.fast_bdt_option,
        )
        yield CDCQETeacherTask(
            n_events_training=self.n_events_training,
            process_type=self.process_type,
            experiment_number=self.experiment_number,
            training_target=self.cdc_training_target,
            exclude_variables=MasterTask.exclude_variables_cdc,
            fast_bdt_option=self.fast_bdt_option,
        )
        yield RecoTrackQETeacherTask(
            n_events_training=self.n_events_training,
            process_type=self.process_type,
            experiment_number=self.experiment_number,
            cdc_training_target=self.cdc_training_target,
            exclude_variables=MasterTask.exclude_variables_rec,
            fast_bdt_option=self.fast_bdt_option,
        )
 

Member Data Documentation

◆ cdc_training_target

b2luigi cdc_training_target = b2luigi.Parameter()

static

Feature/variable to use as truth label for the CDC track quality estimator.

Definition at line 2390 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 2380 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 2392 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 2378 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 2384 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

Protected Member Functions

Detailed Description

Member Function Documentation

◆ _clean()

◆ on_failure()

◆ output()

◆ process()

◆ requires()

Member Data Documentation

◆ cdc_training_target

◆ experiment_number

◆ fast_bdt_option

◆ n_events_training

◆ process_type