diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..95fc0f323451ad3275c600b3234dd5eb6be51771 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +[](https://www.idiap.ch/software/bob/docs/bob/bob.measure/master/sphinx/index.html) +[](https://gitlab.idiap.ch/bob/bob.measure/commits/master) +[](https://www.idiap.ch/software/bob/docs/bob/bob.measure/master/coverage/) +[](https://gitlab.idiap.ch/bob/bob.measure) + +# Experiment Evaluation Metrics for Bob + +This package is part of the signal-processing and machine learning toolbox +[Bob](https://www.idiap.ch/software/bob). It contains common routines for +assessing performance of machine learning experiments. + + +## Installation + +Complete Bob's [installation](https://www.idiap.ch/software/bob/install) +instructions. + +Then, to install this package, run: + +``` sh +conda install bob.measure +``` + +# Contact + +For questions or reporting issues to this software package, contact our +development [mailing list](https://www.idiap.ch/software/bob/discuss). + + +.. Place your references here: +.. _bob: https://www.idiap.ch/software/bob +.. _installation: https://www.idiap.ch/software/bob/install +.. _mailing list: https://www.idiap.ch/software/bob/discuss diff --git a/README.rst b/README.rst deleted file mode 100644 index 053d9494a446de55e04b6f477a858ea945b5866b..0000000000000000000000000000000000000000 --- a/README.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. vim: set fileencoding=utf-8 : -.. Thu 11 Aug 14:52:51 CEST 2016 - -.. image:: https://img.shields.io/badge/docs-latest-orange.svg - :target: https://www.idiap.ch/software/bob/docs/bob/bob.measure/master/sphinx/index.html -.. image:: https://gitlab.idiap.ch/bob/bob.measure/badges/master/pipeline.svg - :target: https://gitlab.idiap.ch/bob/bob.measure/commits/master -.. image:: https://gitlab.idiap.ch/bob/bob.measure/badges/master/coverage.svg - :target: https://www.idiap.ch/software/bob/docs/bob/bob.measure/master/coverage/ -.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg - :target: https://gitlab.idiap.ch/bob/bob.measure - - -======================================= - Experiment Evaluation Metrics for Bob -======================================= - -This package is part of the signal-processing and machine learning toolbox -Bob_. It contains common routines for assessing performance of machine learning -experiments. - - -Installation ------------- - -Complete Bob's `installation`_ instructions. Then, to install this package, -run:: - - $ conda install bob.measure - - -Contact -------- - -For questions or reporting issues to this software package, contact our -development `mailing list`_. - - -.. Place your references here: -.. _bob: https://www.idiap.ch/software/bob -.. _installation: https://www.idiap.ch/software/bob/install -.. _mailing list: https://www.idiap.ch/software/bob/discuss