https://github.com/benchopt/template_benchmark_ml
https://github.com/benchopt/template_benchmark_ml
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/benchopt/template_benchmark_ml
- Owner: benchopt
- License: bsd-3-clause
- Created: 2024-04-17T13:51:51.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-15T08:18:03.000Z (5 months ago)
- Last Synced: 2026-01-15T14:55:16.167Z (5 months ago)
- Language: Python
- Size: 22.5 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
Template for Benchopt Benchmark repositories
=============================================
|Build Template|
This repo should be used with the following steps:
1. Hit the `Use this template` button on the top of `this page `_,
2. Use the form to create a new GitHub repository with your benchmark name,
3. Clone the newly created repository on your computer,
4. Run ``python clean_template.py`` script that will remove instructions relative to
the template in ``README.rst`` and update it with your repo and org name.
5. Edit the problem description in the ``README.rst``.
6. Update ``objective.py`` and the files in ``datasets`` and ``solvers`` to create the benchmark.
My Benchopt Benchmark
=====================
|Build Status| |Python 3.6+|
Benchopt is a package to simplify and make more transparent and
reproducible comparisons of ML methods on multiple datasets.
This benchmark is dedicated to methods for **describe your problem**.
Install
--------
This benchmark can be run using the following commands:
.. code-block::
$ pip install -U benchopt
$ git clone https://github.com/#ORG/#BENCHMARK_NAME
$ benchopt run #BENCHMARK_NAME
Apart from the problem, options can be passed to ``benchopt run``, to restrict the benchmarks to some solvers or datasets, e.g.:
.. code-block::
$ benchopt run #BENCHMARK_NAME -s solver1 -d dataset2 --max-runs 10 --n-repetitions 10
Use ``benchopt run -h`` for more details about these options, or visit https://benchopt.github.io/api.html.
.. |Build Template| image:: https://github.com/benchopt/template_benchmark_ml/workflows/Tests/badge.svg
:target: https://github.com/benchopt/template_benchmark_ml/actions
.. |Build Status| image:: https://github.com/#ORG/#BENCHMARK_NAME/workflows/Tests/badge.svg
:target: https://github.com/#ORG/#BENCHMARK_NAME/actions
.. |Python 3.6+| image:: https://img.shields.io/badge/python-3.6%2B-blue
:target: https://www.python.org/downloads/release/python-360/