https://github.com/deepcharles/benchopt_test
https://github.com/deepcharles/benchopt_test
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/deepcharles/benchopt_test
- Owner: deepcharles
- Created: 2023-02-15T17:05:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-15T17:05:13.000Z (over 3 years ago)
- Last Synced: 2025-01-30T08:31:02.742Z (over 1 year ago)
- Language: Python
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
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 instruction 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 the comparisons of optimization algorithms.
This benchmark is dedicated to solver of **describe your problem**:
$$\\min_{w} f(X, w)$$
where $n$ (or ``n_samples``) stands for the number of samples, $p$ (or ``n_features``) stands for the number of features and
$$X \\in \\mathbb{R}^{n \\times p} \\ , \\quad w \\in \\mathbb{R}^p$$
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/workflows/Tests/badge.svg
:target: https://github.com/benchopt/template_benchmark/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/