module competition
¶
Short summary¶
module lightmlboard.competition
Defines a competition.
Classes¶
class |
truncated documentation |
---|---|
Defines a competition. |
Properties¶
property |
truncated documentation |
---|---|
Returns the metrics in a single string. |
Static Methods¶
staticmethod |
truncated documentation |
---|---|
Converts a list of competitions into a list of dictionaries. |
Methods¶
method |
truncated documentation |
---|---|
Converts values into a list of list of values, one per metrics. |
|
Evaluates received values. |
|
Evaluates a metric. |
|
Convert a competition into a dictionary. |
Documentation¶
Defines a competition.
- class lightmlboard.competition.Competition(cpt_id, link, name, description, metric, datafile=None, expected_values=None)¶
Bases:
object
Defines a competition.
- Parameters:
cpt_id – competition id
link – link to the page, something like
/competition
name – name of the competition
metric – metric or list of metrics, list of metrics to compute
description – description
datafile – data file
expected_values – expected values for each metric
- __init__(cpt_id, link, name, description, metric, datafile=None, expected_values=None)¶
- Parameters:
cpt_id – competition id
link – link to the page, something like
/competition
name – name of the competition
metric – metric or list of metrics, list of metrics to compute
description – description
datafile – data file
expected_values – expected values for each metric
- _load_values(values)¶
Converts values into a list of list of values, one per metrics.
- evaluate(values)¶
Evaluates received values.
- Parameters:
values – list of values
- Returns:
dictionary {metric: res}
- evaluate_metric(met, exp, val)¶
Evaluates a metric.
- Parameters:
met – metric
exp – expected value
val – values
- Returns:
result
- property metric¶
Returns the metrics in a single string.
- to_dict()¶
Convert a competition into a dictionary.
- static to_records(list_cpt)¶
Converts a list of competitions into a list of dictionaries.