Plot package#

Submodules#

Categorical plot module#

class ablator.analysis.plot.cat_plot.Categorical(*args, **kwargs)[source]#

Bases: Plot

__init__(*args, **kwargs) → None[source]#

class ablator.analysis.plot.cat_plot.ViolinPlot(*args, **kwargs)[source]#

Bases: Categorical

__init__(*args, **kwargs) → None[source]#

Plot analysis module#

class ablator.analysis.plot.main.PlotAnalysis(results: DataFrame, categorical_attributes: list[str], numerical_attributes: list[str], optim_metrics: dict[str, ablator.main.configs.Optim], save_dir: str | None = None, cache=False)[source]#

Bases: Analysis

Class for analyzing plotting

Numerical plot module module#

class ablator.analysis.plot.num_plot.LinearPlot(metric: Series, attributes: Series, metric_obj_fn: Optim, y_axis: str | None = None, x_axis: str | None = None, x_ticks: ndarray | None = None, ax: Axes | None = None)[source]#: Bases: Numerical

class ablator.analysis.plot.num_plot.Numerical(metric: Series, attributes: Series, metric_obj_fn: Optim, y_axis: str | None = None, x_axis: str | None = None, x_ticks: ndarray | None = None, ax: Axes | None = None)[source]#: Bases: Plot

Plotting utilities module#

ablator.analysis.plot.utils.parse_name_remap(defaults: list[str] | None = None, name_map: dict[str, str] | None = None) → dict[str, str][source]#

Returns a dictionary mapping input attribute names to output attribute names, with optional remapping based on name_map.

Parameters:

defaultslist of str or None, optional: The default attribute names to use as keys in the output dictionary. If None, the output dictionary will be based on name_map only.
name_mapdict of str to str or None, optional: A dictionary mapping input attribute names to output attribute names. If None, the output dictionary will be based on defaults only.

Returns:

dict of str to str: A dictionary mapping input attribute names to output attribute names.

Raises:

NotImplementedError: If defaults and name_map are both None.

Examples

>>> defaults = ["attr1", "attr2", "attr3"]
>>> name_map = {"attr2": "new_attr2", "attr4": "attr4_renamed"}
>>> name_remap = parse_name_remap(defaults, name_map)
>>> assert name_remap == {"attr1": "attr1", "attr2": "new_attr2", "attr3": "attr3"}
>>> name_remap = parse_name_remap(defaults)
>>> assert name_remap == {"attr1": "attr1", "attr2": "attr2", "attr3": "attr3"}
>>> name_remap = parse_name_remap(name_map=name_map)
>>> assert name_remap == {"attr2": "new_attr2", "attr4": "attr4_renamed"}

Module contents#

class ablator.analysis.plot.Plot(metric: Series, attributes: Series, metric_obj_fn: Optim, y_axis: str | None = None, x_axis: str | None = None, x_ticks: ndarray | None = None, ax: Axes | None = None)[source]#

Bases: ABC

__init__(metric: Series, attributes: Series, metric_obj_fn: Optim, y_axis: str | None = None, x_axis: str | None = None, x_ticks: ndarray | None = None, ax: Axes | None = None) → None[source]#

Plot package

Contents