module competition

Inheritance diagram of lightmlboard.competition

Short summary

module lightmlboard.competition

Defines a competition.

source on GitHub

Classes

class

truncated documentation

Competition

Defines a competition.

Properties

property

truncated documentation

metric

Returns the metrics in a single string.

Static Methods

staticmethod

truncated documentation

to_records

Converts a list of competitions into a list of dictionaries.

Methods

method

truncated documentation

__init__

_load_values

Converts values into a list of list of values, one per metrics.

evaluate

Evaluates received values.

evaluate_metric

Evaluates a metric.

to_dict

Convert a competition into a dictionary.

Documentation

Defines a competition.

source on GitHub

class lightmlboard.competition.Competition(cpt_id, link, name, description, metric, datafile=None, expected_values=None)[source]

Bases: object

Defines a competition.

source on GitHub

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

source on GitHub

__init__(cpt_id, link, name, description, metric, datafile=None, expected_values=None)[source]
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

source on GitHub

_load_values(values)[source]

Converts values into a list of list of values, one per metrics.

source on GitHub

evaluate(values)[source]

Evaluates received values.

Parameters

values – list of values

Returns

dictionary {metric: res}

source on GitHub

evaluate_metric(met, exp, val)[source]

Evaluates a metric.

Parameters
  • met – metric

  • exp – expected value

  • val – values

Returns

result

source on GitHub

metric

Returns the metrics in a single string.

source on GitHub

to_dict()[source]

Convert a competition into a dictionary.

source on GitHub

static to_records(list_cpt)[source]

Converts a list of competitions into a list of dictionaries.

source on GitHub