rail.projects.subsampler module

class rail.projects.subsampler.RailSubsampler(**kwargs)

Bases: Configurable, DynamicClass

Base class for subsampling ata

The main function in this class is: run(…)

This function will take the input files and make a single output file

Parameters:

kwargs (Any)

config_options: dict[str, StageParameter] = {}

run(input_files, output)

Subsample the data

Return type:

None

Parameters:

• input_files (list[str]) – Input files to subsamle

• output (str) – Path to the output file

sub_classes: dict[str, type[DynamicClass]] = {'RailSubsampler': <class 'rail.projects.subsampler.RailSubsampler'>, 'RandomSubsampler': <class 'rail.projects.subsampler.RandomSubsampler'>}

class rail.projects.subsampler.RandomSubsampler(**kwargs)

Bases: RailSubsampler

Pick a random subsample of the data

Parameters:

kwargs (Any)

config_options: dict[str, StageParameter] = {'name': Parameter(Subsampler Name, type: <class 'str'>, default: None [required]), 'num_objects': Parameter(Number of output objects, type: <class 'int'>, default: None [required]), 'seed': Parameter(Random number seed, type: <class 'int'>, default: 1234 [optional])}

run(input_files, output)

Subsample the data

Return type:

None

Parameters:

• input_files (list[str]) – Input files to subsamle

• output (str) – Path to the output file