Publish benchmark results¶
Benchopt allows you to publish your benchmark results to
the Benchopt Benchmarks website
with one command
publish command will send your results to GitHub by opening
a pull-request on the Benchopt results repository.
Once the pull-request is merged it will appear automatically online.
$ git clone https://github.com/benchopt/benchmark_logreg_l2 $ benchopt run ./benchmark_logreg_l2 $ benchopt publish ./benchmark_logreg_l2 -t <GITHUB_TOKEN>
You see that to publish you need to specify the value of
This GitHub access token contains 40 alphanumeric characters that allows GitHub
to identify you and use your account.
After getting your personal token as explained below the last
line will read something like:
$ benchopt publish ./benchmark_logreg_l2 -t 1gdgfej73i72if0852a685ejbhb1930ch496cda4
Your GitHub access token is a sensitive information. Keep it secret as it is as powerful as your GitHub password!
Let’s now look how to create your personal GitHub token.
Obtaining a GitHub token¶
and click on
generate new token.
Then create a token named
benchopt, ticking the repo box as shown below:
Then click on
generate token and copy this token of 40 characters in a
secure location. Note that the token can be stored in a config file for benchopt
benchopt config set github_token <TOKEN>. More info on config files can
be found in BenchOpt configuration.