RuleList

class niaarm.rule_list.RuleList(initlist=None)

Bases: UserList

A list of rules.

get(metric)

Get values of metric for each rule as a numpy array.

Parameters:: metric (str) – Metric.
Returns:: Array of metric for all rules.
Return type:: numpy.ndarray

max(metric)

Get max value of metric.

Parameters:: metric (str) – Metric.
Returns:: Max value of metric in rule list.
Return type:: float

mean(metric)

Get mean value of metric.

Parameters:: metric (str) – Metric.
Returns:: Mean value of metric in rule list.
Return type:: float

min(metric)

Get min value of metric.

Parameters:: metric (str) – Metric.
Returns:: Min value of metric in rule list.
Return type:: float

sort(by='fitness', reverse=True)

Sort rules by metric.

Parameters:

by (str) – Metric to sort rules by. Default: ‘fitness’.
reverse (bool) – Sort in descending order. Default: True.

std(metric)

Get standard deviation of metric.

Parameters:: metric (str) – Metric.
Returns:: Standard deviation of metric in rule list.
Return type:: float

to_csv(filename)

Export rules to csv.

Parameters:: filename (str) – File to save the rules to.