Skip to content

Commit

Permalink
ENH ref to benchopt template
Browse files Browse the repository at this point in the history
  • Loading branch information
MatDag committed Oct 17, 2024
1 parent f333a7c commit c31f5cc
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Each solver derive from the [`benchopt.BaseSolver` class](https://benchopt.githu

2 - How to add a new problem?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In this benchmark, each problem is defined by a [Dataset class](https://benchopt.github.io/user_guide/generated/benchopt.BaseDataset.html) in the [datasets](datasets) folder.
In this benchmark, each problem is defined by a [Dataset class](https://benchopt.github.io/user_guide/generated/benchopt.BaseDataset.html) in the [datasets](datasets) folder. A [template](datasets/template_dataset.py) is provided.

Cite
----
Expand Down
6 changes: 6 additions & 0 deletions datasets/template_dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ class Dataset(BaseDataset):
"""Hyperparameter optimization with IJCNN1 dataset."""
# Name to select the dataset in the CLI and to display the results.
name = "ijcnn1"
"""How to add a new problem to the benchmark?
This template dataset is an adaptation of the dataset from the benchopt
template benchmark (https://github.com/benchopt/template_benchmark/) to
the bilevel setting.
"""

install_cmd = 'conda'
# List of packages needed to run the dataset. See the corresponding
Expand Down
2 changes: 1 addition & 1 deletion solvers/template_solver.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class Solver(BaseSolver):
# Name to select the solver in the CLI and to display the results.
name = 'jaxopt_GD'

"""How to add a new stochastic solver to the benchmark?
"""How to add a new solver to the benchmark?
This template solver is an adaptation of the solver from the benchopt
template benchmark (https://github.com/benchopt/template_benchmark/) to
Expand Down

0 comments on commit c31f5cc

Please sign in to comment.