.. _f-competitions:

module ``ml.competitions``
==========================







Short summary
+++++++++++++

module ``ensae_teaching_cs.ml.competitions``

Compute metrics in for a competition


:githublink:`%|py|5`






Functions
+++++++++

+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                    | truncated documentation                                                                                                                                                                                        |
+=============================================================================================+================================================================================================================================================================================================================+
| :func:`AUC <ensae_teaching_cs.ml.competitions.AUC>`                                         | Computes the `AUC <https://en.wikipedia.org/wiki/Area_under_the_curve_(pharmacokinetics)>`_.                                                                                                                   |
+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`main_codalab_wrapper <ensae_teaching_cs.ml.competitions.main_codalab_wrapper>`       | Adapts the template available at `evaluate.py <https://github.com/Tivix/competition-examples/blob/master/hello_world/competition/scoring_program/evaluate.py>`_ ...                                            |
+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`private_codalab_wrapper <ensae_teaching_cs.ml.competitions.private_codalab_wrapper>` | Wraps the function following the guidelines `User_Building a Scoring Program for a Competition <https://github.com/codalab/codalab-competitions/wiki/User_Building-a-Scoring-Program-for-a-Competition>`_. ... |
+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: ensae_teaching_cs.ml.competitions
    :members:
    :special-members: __init__
    :show-inheritance: