TrainingRunMixin Class Reference

Inheritance diagram for TrainingRunMixin:

Collaboration diagram for TrainingRunMixin:

Public Member Functions
def	identifier (self)
def	sample_file_name (self)
def	create_argument_parser (self, **kwds)
def	postprocess (self)

Public Attributes
	task
	Process each event according to the user's desired task (train, eval, explore)
	output_file_name
	Set file name for the TBrowser to show if demanded.

Static Public Attributes
str	task = "train"
	Recording / training task selected.
None	variables = None
	Input variable for the training or the classification analysis.
None	groupby = None
	Input groupby the classification analysis.
None	auxiliaries = None
	Input auxiliaries the classification analysis.
str	truth = "truth"
	Truth variable name.

Detailed Description

Prepare and execute a basf2 job to train neural network, postprocess, and inspect

Definition at line 19 of file training.py.

Member Function Documentation

create_argument_parser()

def create_argument_parser	(		self,
		**	kwds
	)

Create argument parser

Reimplemented from BrowseTFileOnTerminateRunMixin.

Definition at line 50 of file training.py.

    def create_argument_parser(self, **kwds):
        """Create argument parser"""
        argument_parser = super().create_argument_parser(**kwds)
 
        argument_parser.add_argument(
            "--task",
            choices=NonstrictChoices(["train", "eval", "explore", ]),
            default=self.task,
            dest="task",
            help=("Select a prepared recording task")
        )
 
        return argument_parser
 

identifier()

def identifier

(

self

)

Database identifier of the filte being trained

Definition at line 38 of file training.py.

    def identifier(self):
        """Database identifier of the filte being trained"""
        return "trackfindingcdc_" + self.__class__.__name__[:-len("TrainingRun")]
 

postprocess()

def postprocess

(

self

)

Run the training as post-processing job

To run only the training run with --postprocess-only

Reimplemented from BrowseTFileOnTerminateRunMixin.

Definition at line 64 of file training.py.

    def postprocess(self):
        """Run the training as post-processing job
 
        To run only the training run with --postprocess-only
        """
        
        if self.task == "train":
            cmd = [
                "trackfindingcdc_teacher",
            ]
 
            if self.variables:
                cmd += ["--variables"]
                cmd += self.variables
 
            cmd += [
                "--identifier=" + self.identifier,
                "--truth=" + self.truth,
                self.sample_file_name,
            ]
            print("Running", cmd)
            subprocess.call(cmd)
 
            # Move training file to the right location
            if self.identifier.endswith(".xml"):
                tracking_data_dir_path = os.path.join(os.environ["BELLE2_LOCAL_DIR"], "tracking", "data")
                shutil.copy(self.identifier, tracking_data_dir_path)
 
        else:
            cmd = [
                "trackfindingcdc-classification-overview",
            ]
 
            if self.variables:
                cmd += ["-v"]
                cmd += self.variables
 
            if self.groupby is not None:
                cmd += ["-g"]
                if isinstance(self.groupby, str):
                    cmd += [self.groupby]
                else:
                    cmd += self.groupby
 
            if self.auxiliaries is not None:
                cmd += ["-a"]
                if isinstance(self.auxiliaries, str):
                    cmd += [self.auxiliaries]
                else:
                    cmd += self.auxiliaries
 
            cmd += [
                "--truth=" + self.truth,
                self.sample_file_name,
            ]
            print("Running", cmd)
            subprocess.call(cmd)
            
            self.output_file_name = self.sample_file_name[:-len(".root")] + ".overview.root"
 
        super().postprocess()

sample_file_name()

def sample_file_name

(

self

)

File name of the recorded sample to be trained on

Defaults to the class name minus the mandatory TrainingRun postfix

Definition at line 43 of file training.py.

    def sample_file_name(self):
        """File name of the recorded sample to be trained on
 
        Defaults to the class name minus the mandatory TrainingRun postfix
        """
        return self.__class__.__name__[:-len("TrainingRun")] + '_' + self.task + '.root'
 

Member Data Documentation

auxiliaries

None auxiliaries = None

static

Input auxiliaries the classification analysis.

Default use none

Definition at line 32 of file training.py.

groupby

None groupby = None

static

Input groupby the classification analysis.

Default use no groupby

Definition at line 29 of file training.py.

output_file_name

output_file_name

Set file name for the TBrowser to show if demanded.

Definition at line 122 of file training.py.

task [1/2]

str task = "train"

static

Recording / training task selected.

Definition at line 23 of file training.py.

task [2/2]

task

Process each event according to the user's desired task (train, eval, explore)

Definition at line 70 of file training.py.

truth

str truth = "truth"

static

Truth variable name.

Definition at line 35 of file training.py.

variables

None variables = None

static

Input variable for the training or the classification analysis.

Default use all variables

Definition at line 26 of file training.py.

---

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

• tracking/trackFindingCDC/scripts/trackfindingcdc/run/training.py