Merge pull request #5 from jungtaekkim/0.2.0

0.2.0

Author: jungtaekkim

.github/workflows/pytest.yml

@@ -7,24 +7,22 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - '3.6'
           - '3.7'
           - '3.8'
           - '3.9'
           - '3.10'
           - '3.11'
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
+      - name: Install this project and its dependencies
         run: |
-          python -m pip install --upgrade pip setuptools
-          pip install pytest
-          pip install scipy
+          pip install --upgrade pip
+          pip install .[dev]
+          pip list
       - name: Run pytest
         run: |
-          pip install .
           pytest

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2023 Jungtaek Kim
+Copyright (c) 2019-2024 Jungtaek Kim
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,9 @@
 <p align="center">
-<img src="https://github.com/jungtaekkim/bayeso/blob/main/docs/_static/assets/logo_bayeso_capitalized.svg" width="400" />
+<img src="https://raw.githubusercontent.com/jungtaekkim/bayeso/main/docs/_static/assets/logo_bayeso_capitalized.svg" width="400" />
 </p>
 
 # BayesO Benchmarks: Benchmark Functions for Bayesian Optimization
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7577331.svg)](https://doi.org/10.5281/zenodo.7577331)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7577330.svg)](https://doi.org/10.5281/zenodo.7577330)
 [![Build Status](https://github.com/jungtaekkim/bayeso-benchmarks/actions/workflows/pytest.yml/badge.svg)](https://github.com/jungtaekkim/bayeso-benchmarks/actions/workflows/pytest.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
@@ -21,42 +21,36 @@ You can choose one of three installation options.
 To install the released version in PyPI repository, command it.
 
 ```shell
-$ pip install bayeso-benchmarks
+pip install bayeso-benchmarks
 ```
 
 * Using source code (for developer installation)
 
-To install `bayeso-benchmarks` from source code, command
+To install `bayeso-benchmarks` from source code, command the following in the `bayeso-benchmarks` root.
 
 ```shell
-$ pip install .
+pip install .
 ```
-in the `bayeso-benchmarks` root.
 
 * Using source code (for editable development mode)
 
-To use editable development mode, command
+To use editable development mode, command the following in the `bayeso-benchmarks` root.
 
 ```shell
-$ pip install -r requirements.txt
-$ python setup.py develop
+pip install -e .
 ```
-in the `bayeso-benchmarks` root.
+
+If you want to install the packages required for development, you can simply add `[dev]`.
+For example, `pip install .[dev]` or `pip install -e .[dev]`.
 
 * Uninstallation
 
 If you would like to uninstall `bayeso-benchmarks`, command it.
 
 ```shell
-$ pip uninstall bayeso-benchmarks
+pip uninstall bayeso-benchmarks
 ```
 
-## Required Packages
-Mandatory pacakges are inlcuded in `requirements.txt`.
-The following `requirements` files include the package list, the purpose of which is described as follows.
-
-* `requirements-dev.txt`: It is for developing the `bayeso-benchmarks` package.
-
 ## Simple Example
 A simple example on Branin function is shown below.
 ```python
@@ -71,5 +65,17 @@ Y = obj_fun.output(X)
 Y_noise = obj_fun.output_gaussian_noise(X)
 ```
 
+## Citation
+```
+@misc{KimJ2023software,
+    author={Kim, Jungtaek},
+    title={{BayesO Benchmarks}: Benchmark Functions for {Bayesian} Optimization},
+    doi={10.5281/zenodo.7577330},
+    url={https://github.com/jungtaekkim/bayeso-benchmarks},
+    howpublished={\url{https://doi.org/10.5281/zenodo.7577330}},
+    year={2023}
+}
+```
+
 ## License
 [MIT License](LICENSE)

bayeso_benchmarks/__init__.py

@@ -1,10 +1,10 @@
 #
-# author: Jungtaek Kim ([email protected])
-# last updated: January 6, 2023
+# author: Jungtaek Kim ([email protected])
+# last updated: January 27, 2023
 #
 
 
-__version__ = '0.1.7'
+__version__ = '0.2.0'
 
 
 from bayeso_benchmarks.inf_dim_ackley import Ackley

bayeso_benchmarks/benchmark_base.py

@@ -1,5 +1,5 @@
 #
-# author: Jungtaek Kim ([email protected])
+# author: Jungtaek Kim ([email protected])
 # last updated: December 13, 2022
 #
 

bayeso_benchmarks/four_dim_colville.py

@@ -42,7 +42,4 @@ def __init__(self, seed=None):
         global_minimum = 0.0
         function = lambda bx: fun_target(bx, dim_bx)
 
-        try:
-            super().__init__(dim_bx, bounds, global_minimizers, global_minimum, function, seed=seed)
-        except:
-            super(Colville, self).__init__(dim_bx, bounds, global_minimizers, global_minimum, function, seed=seed)
+        super().__init__(dim_bx, bounds, global_minimizers, global_minimum, function, seed=seed)

bayeso_benchmarks/inf_dim_ackley.py

@@ -40,7 +40,4 @@ def __init__(self, dim_problem, seed=None):
 
         function = lambda bx: fun_target(bx, dim_problem)
 
-        try:
-            super().__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)
-        except:
-            super(Ackley, self).__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)
+        super().__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)

bayeso_benchmarks/inf_dim_cosines.py

@@ -33,7 +33,4 @@ def __init__(self, dim_problem, seed=None):
 
         function = lambda bx: fun_target(bx, dim_problem)
 
-        try:
-            super().__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)
-        except:
-            super(Cosines, self).__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)
+        super().__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)

bayeso_benchmarks/inf_dim_griewank.py

@@ -39,7 +39,4 @@ def __init__(self, dim_problem, seed=None):
 
         function = lambda bx: fun_target(bx, dim_problem)
 
-        try:
-            super().__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)
-        except:
-            super(Griewank, self).__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)
+        super().__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)

bayeso_benchmarks/inf_dim_levy.py

@@ -45,7 +45,4 @@ def __init__(self, dim_problem, seed=None):
 
         function = lambda bx: fun_target(bx, dim_problem)
 
-        try:
-            super().__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)
-        except:
-            super(Levy, self).__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)
+        super().__init__(dim_bx, bounds, global_minimizers, global_minimum, function, dim_problem=dim_problem, seed=seed)