Skip to content

Commit

Permalink
Adress a few remaining comments, add links to benchopt howtos in the …
Browse files Browse the repository at this point in the history
…README
  • Loading branch information
fcharras committed Oct 11, 2023
1 parent e897181 commit 36eae32
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,21 @@ of input data.

## Running the benchmarks

Please refer to benchopt documentation and tutorials that provide step-by-step guides
for running the benchmarks from a benchmark file tree, and refer to the documentation
of the dependencies of the solvers you're interested in running to gather prerequisite
installation instructions.
Please refer to [benchopt documentation and tutorials](https://benchopt.github.io/get_started.html)
that provide step-by-step guides for running the benchmarks from a benchmark file tree,
and refer to the documentation of the dependencies of the solvers you're interested in
running to gather prerequisite installation instructions.

Also, the [github workflow](https://github.com/soda-inria/sklearn-engine-benchmarks/tree/main/.github/workflows/test_cpu_benchmarks.yaml)
in this repository for testing benchmarks on CPU showcases an example of setup of an
environment along with relevant benchopt commands to start the benchmarks on a dataset
with custom, smaller dimensions.

## Contributing

Please refer to benchopt documentation and tutorials that provide step-by-step guides
if you'd like to add a new implementation for an already existing benchmark.
Please refer to [benchopt documentation and tutorials](https://benchopt.github.io/tutorials/add_solver.html)
that provide step-by-step guides if you'd like to add a new implementation for an
already existing benchmark.

A contribution should contain the following files:
- a benchopt solver in the `./solvers` folder
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[flake8]
# max line length for black
max-line-length = 88
target-version = ['py37']
target-version = ['py310']
# Default flake8 3.5 ignored flags
ignore=
E24, # check ignored by default in flake8. Meaning unclear.
Expand Down

0 comments on commit 36eae32

Please sign in to comment.