.. _f-competition: module ``competition`` ====================== .. inheritance-diagram:: lightmlboard.competition Short summary +++++++++++++ module ``lightmlboard.competition`` Defines a competition. :githublink:`%|py|6` Classes +++++++ +-------------------------------------------------------------+-------------------------+ | class | truncated documentation | +=============================================================+=========================+ | :class:`Competition ` | Defines a competition. | +-------------------------------------------------------------+-------------------------+ Properties ++++++++++ +--------------------------------------------------------------+-----------------------------------------+ | property | truncated documentation | +==============================================================+=========================================+ | :meth:`metric ` | Returns the metrics in a single string. | +--------------------------------------------------------------+-----------------------------------------+ Static Methods ++++++++++++++ +----------------------------------------------------------------------+--------------------------------------------------------------+ | staticmethod | truncated documentation | +======================================================================+==============================================================+ | :meth:`to_records ` | Converts a list of competitions into a list of dictionaries. | +----------------------------------------------------------------------+--------------------------------------------------------------+ Methods +++++++ +--------------------------------------------------------------------------------+-----------------------------------------------------------------+ | method | truncated documentation | +================================================================================+=================================================================+ | :py:meth:`__init__ ` | | +--------------------------------------------------------------------------------+-----------------------------------------------------------------+ | :py:meth:`_load_values ` | Converts values into a list of list of values, one per metrics. | +--------------------------------------------------------------------------------+-----------------------------------------------------------------+ | :meth:`evaluate ` | Evaluates received values. | +--------------------------------------------------------------------------------+-----------------------------------------------------------------+ | :meth:`evaluate_metric ` | Evaluates a metric. | +--------------------------------------------------------------------------------+-----------------------------------------------------------------+ | :meth:`to_dict ` | Convert a competition into a dictionary. | +--------------------------------------------------------------------------------+-----------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: lightmlboard.competition :members: :special-members: __init__ :show-inheritance: