rail.projects.subsample_factory module

class rail.projects.subsample_factory.RailSubsample(**kwargs)

Bases: Configurable

Paramters for a simple data subsample

This is just defined as a random number seed and a number of objects

Parameters:

kwargs (Any)

config_options: dict[str, StageParameter] = {'name': Parameter(Subsample name, type: <class 'str'>, default: None [required]), 'num_objects': Parameter(Number of objects to pick, type: <class 'int'>, default: None [required]), 'seed': Parameter(Random numbers seed, type: <class 'int'>, default: None [required])}

yaml_tag: str = 'Subsample'

class rail.projects.subsample_factory.RailSubsampleFactory

Bases: RailFactoryMixin

Factory class to make subsamples

Expected usage is that user will define a yaml file with the various datasets that they wish to use with the following example syntax:

Subsamples:
  - Subsample:
    name: test_100k
    seed: 1234
    num_objects: 100000

classmethod add_subsample(subsample)

Return type:

None

Parameters:

subsample (RailSubsample)

client_classes: list[type[Configurable]] = [<class 'rail.projects.subsample_factory.RailSubsample'>]

classmethod get_subsample(name)

Get a subsample by it’s assigned name

Return type:

RailSubsample

Parameters:

name (str) – Name of the subsample to return

Returns:

subsample in question

Return type:

RailSubsample

classmethod get_subsample_names()

Return the names of the subsamples

Return type:

list[str]

classmethod get_subsamples()

Return the dict of all the subsamples

Return type:

dict[str, RailSubsample]

property subsamples: dict[str, RailSubsample]

Return the dictionary of subsample templates

yaml_tag: str = 'Subsamples'