Metadata-Version: 2.4
Name: VOPy
Version: 0.2.0
Summary: A framework for black-box vector optimization
Author-email: "Y. Cahit Yıldırım" <cahit.yildirim@bilkent.edu.tr>
License: MIT License
        
        Copyright (c) 2023 CYBORG: Cognitive Systems, Bandits, and Optimization Research Group
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/Bilkent-CYBORG/VOPy
Project-URL: Documentation, https://vopy.readthedocs.io/en/latest/
Project-URL: Issues, https://github.com/Bilkent-CYBORG/VOPy/issues
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: botorch<0.12.0,>=0.10.0
Requires-Dist: cvxpy
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: matplotlib
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: usort; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: flake8-print; extra == "dev"
Provides-Extra: test
Requires-Dist: pre-commit; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-xdist; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: bandit; extra == "test"
Provides-Extra: examples
Requires-Dist: jupyter; extra == "examples"
Requires-Dist: optuna; extra == "examples"
Provides-Extra: docs
Requires-Dist: pydocstyle; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinx-notfound-page; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Dynamic: license-file

## VOPy: A Framework for Black-box Vector Optimization

[![Test Workflow](https://github.com/Bilkent-CYBORG/VOPy/actions/workflows/test.yml/badge.svg)](https://github.com/Bilkent-CYBORG/VOPy/blob/master/.github/workflows/test.yml)
[![Coverage Status](https://coveralls.io/repos/github/Bilkent-CYBORG/VOPy/badge.svg)](https://coveralls.io/github/Bilkent-CYBORG/VOPy)
[![Documentation Status](https://readthedocs.org/projects/vopy/badge/?version=latest)](https://vopy.readthedocs.io/en/latest/)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)

### What is VOPy?
VOPy is an open-source Python library built to address noisy black-box [vector optimization](https://en.wikipedia.org/wiki/Vector_optimization) problems, where the user preferences are encoded with a cone order.

<p align="center">
  <img src="docs/source/_static/vopy_deps.jpg" alt="Overview of the dependencies, core modules, and built-in algorithms of VOPy" width="600px">
</p>

### What to do with VOPy?
VOPy includes several pre-implemented algorithms, models, orders, and problems from the literature for black-box vector optimization, allowing users to select and utilize components based on their specific needs. Specifically, you can:
- Use existing black-box vector optimization methods for new problems
- Benchmark novel algorithms with the state-of-the-art
- Utilize a wide range of existing tools in black-box vector optimization

### How To Start?

Visit our [**website**](https://vopy.readthedocs.io/en/latest/) to see tutorials, examples and API references on how to use VOPy. We recommend starting out with the [**motivating example**](https://vopy.readthedocs.io/en/latest/examples/01_motivating_example.html).


### Setup

Installation using pip:
```bash
pip install vopy
```

#### Latest (Unstable) Version
To upgrade to the latest (unstable) version, run

```bash
pip install --upgrade git+https://github.com/Bilkent-CYBORG/VOPy.git
```

#### Manual installation (for development)

If you'd like to contribute, please follow [CONTRIBUTING.md](CONTRIBUTING.md).

If you want a manual installation:

```sh
git clone https://github.com/Bilkent-CYBORG/VOPy.git
cd VOPy
uv sync --all-extras  # Install all dependencies
# OR for specific dependency groups
# pip install -e ".[dev,test]"
```

For all dependencies, see [pyproject.toml](pyproject.toml). Legacy files [requirements.txt](requirements.txt) and [environment.yml](environment.yml) are also maintained.

Further, installing the pre-commit hooks are **highly** encouraged.

```sh
# Inside the package folder
pre-commit install
```

### Contributing

Follow [CONTRIBUTING.md](CONTRIBUTING.md).

### **Citing**

If you use VOPy, please cite the following paper:

```
@article{yildirim2024vopy,
  title={{VOPy}: A Framework for Black-box Vector Optimization},
  author={Yıldırım, Yaşar Cahit and Karagözlü, Efe Mert and Korkmaz, İlter Onat and Ararat, Çağın and Tekin, Cem},
  journal={arXiv preprint arXiv:2412.06604},
  year={2024}
}
```

### **License**

VOPy is under [MIT license](LICENSE).
