sierra.core.pipeline.stage4.inter_exp_graph_generator

Classes for generating graphs across experiments in a batch.

• InterExpGraphGenerator: Generates graphs from Collated .csv files.

• LineGraphsGenerator: Generates linegraphs from Collated .csv files.

• HeatmapsGenerator: Generates heatmaps from Collated .csv files.

class sierra.core.pipeline.stage4.inter_exp_graph_generator.InterExpGraphGenerator(main_config: Dict[str, Any], cmdopts: Dict[str, Any], LN_targets: List[Dict[str, Any]], HM_targets: List[Dict[str, Any]])

Generates graphs from Collated .csv files.

Which graphs are generated can be controlled by YAML configuration files parsed in PipelineStage4.

This class can be extended/overriden using a Project hook. See SIERRA Hooks for details.

cmdopts

Dictionary of parsed cmdline attributes.

main_config

Parsed dictionary of main YAML configuration

LN_targets

A list of dictionaries, where each dictionary defines an inter-experiment linegraph to generate.

HM_targets

A list of dictionaries, where each dictionary defines an inter-experiment heatmap to generate.

logger

The handle to the logger for this class. If you extend this class, you should save/restore this variable in tandem with overriding it in order to get logging messages have unique logger names between this class and your derived class, in order to reduce confusion.

Inheritance

__call__(criteria: IConcreteBatchCriteria) → None

Generate graphs.

Performs the following steps:

# . LineGraphsGenerator

to generate linegraphs (univariate batch criteria only).

__dict__ = mappingproxy({'__module__': 'sierra.core.pipeline.stage4.inter_exp_graph_generator', '__doc__': 'Generates graphs from :term:`Collated .csv` files.\n\n    Which graphs are generated can be controlled by YAML configuration\n    files parsed in\n    :class:`~sierra.core.pipeline.stage4.pipeline_stage4.PipelineStage4`.\n\n\n    This class can be extended/overriden using a :term:`Project` hook. See\n    :ref:`ln-sierra-tutorials-project-hooks` for details.\n\n    Attributes:\n\n        cmdopts: Dictionary of parsed cmdline attributes.\n\n        main_config: Parsed dictionary of main YAML configuration\n\n        LN_targets: A list of dictionaries, where each dictionary defines an\n                    inter-experiment linegraph to generate.\n\n        HM_targets: A list of dictionaries, where each dictionary defines an\n                    inter-experiment heatmap to generate.\n\n        logger: The handle to the logger for this class. If you extend this\n               class, you should save/restore this variable in tandem with\n               overriding it in order to get logging messages have unique logger\n               names between this class and your derived class, in order to\n               reduce confusion.\n\n    ', '__init__': <function InterExpGraphGenerator.__init__>, '__call__': <function InterExpGraphGenerator.__call__>, '__dict__': <attribute '__dict__' of 'InterExpGraphGenerator' objects>, '__weakref__': <attribute '__weakref__' of 'InterExpGraphGenerator' objects>, '__annotations__': {}})

__doc__ = 'Generates graphs from :term:`Collated .csv` files.\n\n    Which graphs are generated can be controlled by YAML configuration\n    files parsed in\n    :class:`~sierra.core.pipeline.stage4.pipeline_stage4.PipelineStage4`.\n\n\n    This class can be extended/overriden using a :term:`Project` hook. See\n    :ref:`ln-sierra-tutorials-project-hooks` for details.\n\n    Attributes:\n\n        cmdopts: Dictionary of parsed cmdline attributes.\n\n        main_config: Parsed dictionary of main YAML configuration\n\n        LN_targets: A list of dictionaries, where each dictionary defines an\n                    inter-experiment linegraph to generate.\n\n        HM_targets: A list of dictionaries, where each dictionary defines an\n                    inter-experiment heatmap to generate.\n\n        logger: The handle to the logger for this class. If you extend this\n               class, you should save/restore this variable in tandem with\n               overriding it in order to get logging messages have unique logger\n               names between this class and your derived class, in order to\n               reduce confusion.\n\n    '

__init__(main_config: Dict[str, Any], cmdopts: Dict[str, Any], LN_targets: List[Dict[str, Any]], HM_targets: List[Dict[str, Any]]) → None

__module__ = 'sierra.core.pipeline.stage4.inter_exp_graph_generator'

__weakref__

list of weak references to the object (if defined)

class sierra.core.pipeline.stage4.inter_exp_graph_generator.LineGraphsGenerator(cmdopts: Dict[str, Any], targets: List[Dict[str, Any]])

Generates linegraphs from Collated .csv files.

The graphs generated by this class respect the --exp-range cmdline option.

Inheritance

__dict__ = mappingproxy({'__module__': 'sierra.core.pipeline.stage4.inter_exp_graph_generator', '__doc__': 'Generates linegraphs from :term:`Collated .csv` files.\n\n    The graphs generated by this class respect the ``--exp-range`` cmdline\n    option.\n    ', '__init__': <function LineGraphsGenerator.__init__>, 'generate': <function LineGraphsGenerator.generate>, '_gen_summary_linegraph': <function LineGraphsGenerator._gen_summary_linegraph>, '_gen_stacked_linegraph': <function LineGraphsGenerator._gen_stacked_linegraph>, '__dict__': <attribute '__dict__' of 'LineGraphsGenerator' objects>, '__weakref__': <attribute '__weakref__' of 'LineGraphsGenerator' objects>, '__annotations__': {}})

__doc__ = 'Generates linegraphs from :term:`Collated .csv` files.\n\n    The graphs generated by this class respect the ``--exp-range`` cmdline\n    option.\n    '

__init__(cmdopts: Dict[str, Any], targets: List[Dict[str, Any]]) → None

__module__ = 'sierra.core.pipeline.stage4.inter_exp_graph_generator'

__weakref__

list of weak references to the object (if defined)

_gen_stacked_linegraph(graph: Dict[str, Any], criteria: IConcreteBatchCriteria, graph_root: Path) → None

_gen_summary_linegraph(graph: Dict[str, Any], criteria: IConcreteBatchCriteria, graph_root: Path) → None

generate(criteria: IConcreteBatchCriteria) → None

class sierra.core.pipeline.stage4.inter_exp_graph_generator.HeatmapsGenerator(cmdopts: Dict[str, Any], targets: List[Dict[str, Any]])

Generates heatmaps from Collated .csv files.

The graphs generated by this class respect the --exp-range cmdline option.

Inheritance

__dict__ = mappingproxy({'__module__': 'sierra.core.pipeline.stage4.inter_exp_graph_generator', '__doc__': 'Generates heatmaps from :term:`Collated .csv` files.\n\n    The graphs generated by this class respect the ``--exp-range`` cmdline\n    option.\n    ', '__init__': <function HeatmapsGenerator.__init__>, 'generate': <function HeatmapsGenerator.generate>, '_generate_hm': <function HeatmapsGenerator._generate_hm>, '__dict__': <attribute '__dict__' of 'HeatmapsGenerator' objects>, '__weakref__': <attribute '__weakref__' of 'HeatmapsGenerator' objects>, '__annotations__': {}})

__doc__ = 'Generates heatmaps from :term:`Collated .csv` files.\n\n    The graphs generated by this class respect the ``--exp-range`` cmdline\n    option.\n    '

__init__(cmdopts: Dict[str, Any], targets: List[Dict[str, Any]]) → None

__module__ = 'sierra.core.pipeline.stage4.inter_exp_graph_generator'

__weakref__

list of weak references to the object (if defined)

_generate_hm(graph: Dict[str, Any], criteria: IConcreteBatchCriteria, interval: int, ipath: Path) → None

generate(criteria: IConcreteBatchCriteria) → None