{"id":20841043,"url":"https://github.com/benchopt/template_benchmark","last_synced_at":"2025-05-08T22:05:10.204Z","repository":{"id":38191626,"uuid":"333760847","full_name":"benchopt/template_benchmark","owner":"benchopt","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-16T16:42:22.000Z","size":50,"stargazers_count":24,"open_issues_count":4,"forks_count":19,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-07-17T19:51:32.685Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/benchopt.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-28T13:03:35.000Z","updated_at":"2024-07-16T16:42:25.000Z","dependencies_parsed_at":"2023-01-21T14:04:42.898Z","dependency_job_id":"6ea281dd-2c0b-47ea-918a-5af7a1e0ee71","html_url":"https://github.com/benchopt/template_benchmark","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benchopt%2Ftemplate_benchmark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benchopt%2Ftemplate_benchmark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benchopt%2Ftemplate_benchmark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benchopt%2Ftemplate_benchmark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benchopt","download_url":"https://codeload.github.com/benchopt/template_benchmark/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225110449,"owners_count":17422431,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-18T01:18:37.469Z","updated_at":"2024-11-18T01:18:38.097Z","avatar_url":"https://github.com/benchopt.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Template for Benchopt Benchmark repositories\n=============================================\n|Build Template|\n\nThis repo should be used with the following steps:\n\n1. Hit the `Use this template` button on the top of `this page \u003chttps://github.com/benchopt/template_benchmark\u003e`_,\n2. Use the form to create a new github repository with your benchmark name,\n3. Clone the newly created repository on your computer,\n4. Run ``python clean_template.py`` script that will remove instruction relative to\n   the template in ``README.rst`` and update it with your repo and org name.\n5. Edit the problem description in the ``README.rst``.\n6. Update ``objective.py`` and the files in ``datasets`` and ``solvers`` to create the benchmark.\n\nMy Benchopt Benchmark\n=====================\n|Build Status| |Python 3.6+|\n\nBenchopt is a package to simplify and make more transparent and\nreproducible comparisons of optimization methods.\nThis benchmark is dedicated to solvers of **describe your problem**:\n\n\n$$\\\\min_{\\\\beta} f(X, \\\\beta),$$\n\nwhere $X$ is the matrix of data and $\\\\beta$ is the optimization variable.\n\nInstall\n--------\n\nThis benchmark can be run using the following commands:\n\n.. code-block::\n\n   $ pip install -U benchopt\n   $ git clone https://github.com/#ORG/#BENCHMARK_NAME\n   $ benchopt run #BENCHMARK_NAME\n\nApart from the problem, options can be passed to ``benchopt run``, to restrict the benchmarks to some solvers or datasets, e.g.:\n\n.. code-block::\n\n\t$ benchopt run #BENCHMARK_NAME -s solver1 -d dataset2 --max-runs 10 --n-repetitions 10\n\n\nUse ``benchopt run -h`` for more details about these options, or visit https://benchopt.github.io/api.html.\n\n.. |Build Template| image:: https://github.com/benchopt/template_benchmark/actions/workflows/main.yml/badge.svg\n   :target: https://github.com/benchopt/template_benchmark/actions\n.. |Build Status| image:: https://github.com/#ORG/#BENCHMARK_NAME/actoiworkflows/main.yml/badge.svg\n   :target: https://github.com/#ORG/#BENCHMARK_NAME/actions\n.. |Python 3.6+| image:: https://img.shields.io/badge/python-3.6%2B-blue\n   :target: https://www.python.org/downloads/release/python-360/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenchopt%2Ftemplate_benchmark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenchopt%2Ftemplate_benchmark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenchopt%2Ftemplate_benchmark/lists"}