optbench
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 1 committers (100.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (7.5%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: automl
- License: other
- Language: Python
- Default Branch: main
- Size: 58.6 KB
Statistics
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
OptBench
Optimization tasks: Synthetic functions: Ackley, Levy, Schwefel
Compatible with carps
Installation
```bash
Create conda env
conda create -n optbench python=3.12 -c conda-forge
Activate env
conda activate optbench
Clone repo
git clone git@github.com:automl/OptBench.git cd OptBench
Install
pip install -e . ```
Running an optimizer from carps
The command for running an optimizer, e.g., random search from carps on OptBench looks as follows:
bash
python -m carps.run 'hydra.searchpath=[pkg://optbench/configs]' +optimizer/randomsearch=config +task/OptBench=Ackley_2 seed=1
The breakdown of the command:
- 'hydra.searchpath=[pkg://optbench/configs]': Let hydra know where to find the configs of the OptBench package. For this, optbench needs to be installed. It is in general: pkg://PACKAGENAME/PATHINSIDEPACKAGETOCONFIGSFOLDER .
- +optimizer/randomsearch=config: select an optimizer from carps. Follows the config folder structure in carps. Beware, for other optimizers you need to install dependencies (check the repo).
- +task/OptBench=Ackley_2: Select a problem. Follows the configs folder structure in this package, starting from optbench/configs.
- seed=1: Set the seed to 1.
Of course, you can also specify the run dir etc. For more hydra overrides and parallelization, check their docs/tutorials.
Owner
- Name: AutoML-Freiburg-Hannover
- Login: automl
- Kind: organization
- Location: Freiburg and Hannover, Germany
- Website: www.automl.org
- Repositories: 186
- Profile: https://github.com/automl
Citation (CITATION.cff)
---
cff-version: 1.2.0
message: "This is the message displayed when viewing the citation on github"
title: "OptBench"
date-released: "<<date>>"
url: tba
# Replace automl here with your own github name if you need
repository-code: "https://github.com/automl/OptBench"
version: "0.1.0"
type: "template"
keywords:
- "template"
<<requires::license license: "BSD license" endrequires::license>>
authors:
- family-names: ""
given-names: ""
affiliation: "tba"
...
GitHub Events
Total
- Push event: 4
- Fork event: 1
Last Year
- Push event: 4
- Fork event: 1
Committers
Last synced: 8 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| benjamc | c****s@a****e | 23 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 8 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- ConfigSpace *
- carps *
- coverage *
- mypy *
- pre-commit *
- pytest *
- ruff *
- setuptools *
- tomli *
- typing_extensions *