titerra.variables.batch_criteria

Extensions to SIERRA batch criteria classes for the TITAN project.

class titerra.variables.batch_criteria.IConcreteBatchCriteria[source]

‘Final’ interface for user-visible batch criteria.

Inheritance

digraph inheritanceb846467a7a { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "IConcreteBatchCriteria" [URL="#titerra.variables.batch_criteria.IConcreteBatchCriteria",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="'Final' interface for user-visible batch criteria."]; "Interface" -> "IConcreteBatchCriteria" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Interface" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; }
__doc__ = "\n    'Final' interface for user-visible batch criteria.\n    "
__module__ = 'sierra.core.variables.batch_criteria'
graph_xlabel(cmdopts: Dict[str, Any]) → str[source]

Get the X-label for a graph.

Returns

The X-label that should be used for the graphs of various performance measures across batch criteria.

graph_xticklabels(cmdopts: Dict[str, Any], exp_names: Optional[List[str]] = None) → List[str][source]

Calculate X axis tick labels for graph generation.

Parameters

  • cmdopts – Dictionary of parsed command line options.

  • exp_names – If not None, then these directories will be used to calculate the labels, rather than the results of gen_exp_names().

graph_xticks(cmdopts: Dict[str, Any], exp_names: Optional[List[str]] = None) → List[float][source]

Calculate X axis ticks for graph generation.

Parameters

  • cmdopts – Dictionary of parsed command line options.

  • exp_names – If not None, then this list of directories will be used to calculate the ticks, rather than the results of gen_exp_names().

class titerra.variables.batch_criteria.IPMQueryableBatchCriteria[source]

Mixin interface for batch criteria which can be queried during stage 4 to generate performance measures.

Inheritance

digraph inheritance7290c498e3 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "IPMQueryableBatchCriteria" [URL="#titerra.variables.batch_criteria.IPMQueryableBatchCriteria",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mixin interface for batch criteria which can be queried during stage"]; "Interface" -> "IPMQueryableBatchCriteria" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Interface" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; }
__doc__ = 'Mixin interface for batch criteria which can be queried during stage\n    4 to generate performance measures.\n    '
__module__ = 'titerra.variables.batch_criteria'
pm_query(pm: str) → bool[source]
Parameters

pm – A possible performance measure to generate from the results of the batch experiment defined by this object.

Returns

True if the specified pm should be generated for the current object, and False otherwise.

class titerra.variables.batch_criteria.BivarBatchCriteria(*args, **kwargs)[source]

Combination of the definition of two separate batch criteria.

Inheritance

digraph inheritancef230d0e703 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BatchCriteria" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Defines experiments via lists of sets of changes to make to an XML file."]; "BivarBatchCriteria" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Combination of the definition of two separate batch criteria."]; "BatchCriteria" -> "BivarBatchCriteria" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BivarBatchCriteria" [URL="#titerra.variables.batch_criteria.BivarBatchCriteria",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Combination of the definition of two separate batch criteria."]; "BivarBatchCriteria" -> "BivarBatchCriteria" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
__doc__ = '\n    Combination of the definition of two separate batch criteria.\n    '
__init__(*args, **kwargs) → None[source]
__module__ = 'titerra.variables.batch_criteria'
pm_query(pm: str) → bool[source]