diff --git a/LICENSE b/LICENSE.TXT similarity index 100% rename from LICENSE rename to LICENSE.TXT diff --git a/README.md b/README.md index 58ee18b8a..c713928a4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,21 @@ -# Codabench +![CodaBench logo](src/static/img/codabench_black.png) [![Circle CI](https://circleci.com/gh/codalab/codabench.svg?style=shield)](https://app.circleci.com/pipelines/github/codalab/codabench) -## Installation +## What is CodaLab? + +CodaBench is an open-source web-based platform that enables researchers, developers, and data scientists to collaborate, with the goal of advancing research fields where machine learning and advanced computation is used. CodaBench helps to solve many common problems in the arena of data-oriented research through its online community where people can share worksheets and participate in competitions and benchmarks. It can be seen as a version 2 of [CodaLab Competitions](https://github.com/codalab/codalab-competitions). + +To see CodaBench in action, visit [codabench.org](https://www.codabench.org/). + + +## Documentation + +- [CodaBench Wiki](https://github.com/codalab/codabench/wiki) + + +## Quick installation + +_To participate, or even organize your own benchmarks or competitions, **you don't need to install anything**, you just need to sign in an instance of the platform (e.g. [this one](https://www.codabench.org/)). +If you wish to configure your own instance of CodaBench platform, here are the instructions:_ ``` @@ -15,6 +30,34 @@ You can now login as username "admin" with password "admin" at http://localhost: If you ever need to reset the database, use the script `./reset_db.sh` + +## License + +Copyright (c) 2020-2022, Université Paris-Saclay. +This software is released under the Apache License 2.0 (the "License"); you may not use the software except in compliance with the License. + +The text of the Apache License 2.0 can be found online at: +http://www.opensource.org/licenses/apache2.0.php + + +## Cite CodaBench in your research + +``` +@article{codabench, + title = {Codabench: Flexible, easy-to-use, and reproducible meta-benchmark platform}, + author = {Zhen Xu and Sergio Escalera and Adrien Pavão and Magali Richard and + Wei-Wei Tu and Quanming Yao and Huan Zhao and Isabelle Guyon}, + journal = {Patterns}, + volume = {3}, + number = {7}, + pages = {100543}, + year = {2022}, + issn = {2666-3899}, + doi = {https://doi.org/10.1016/j.patter.2022.100543}, + url = {https://www.sciencedirect.com/science/article/pii/S2666389922001465} +} +``` + ## Running tests ``` @@ -177,3 +220,4 @@ You can execute commands against a role: ``` See available commands with `fab -l` + diff --git a/src/static/img/codabench_black.png b/src/static/img/codabench_black.png new file mode 100644 index 000000000..e44c1da13 Binary files /dev/null and b/src/static/img/codabench_black.png differ