Skip to main content

A framework for black-box vector optimization

Project description

VOPy: A Framework for Black-box Vector Optimization

Test Workflow Coverage Status Documentation Status License

What is VOPy?

VOPy is an open-source Python library built to address noisy black-box vector optimization problems, where the user preferences are encoded with a cone order.

Overview of the dependencies, core modules, and built-in algorithms of VOPy

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 to see tutorials, examples and API references on how to use VOPy. We recommend starting out with the motivating example.

Setup

Installation using pip:

pip install vopy

Latest (Unstable) Version

To upgrade to the latest (unstable) version, run

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

Manual installation (for development)

If you are contributing a pull request, it is best to perform a manual installation:

git clone https://github.com/Bilkent-CYBORG/VOPy.git
cd VOPy
mamba env create --name vopy --file environment.yml  # To setup a proper development environment
pip install -e .

For all development requirements, see requirements.txt or environment.yml.

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

# Inside the package folder
pre-commit install

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vopy-0.1.4.tar.gz (692.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vopy-0.1.4-py3-none-any.whl (107.5 kB view details)

Uploaded Python 3

File details

Details for the file vopy-0.1.4.tar.gz.

File metadata

  • Download URL: vopy-0.1.4.tar.gz
  • Upload date:
  • Size: 692.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vopy-0.1.4.tar.gz
Algorithm Hash digest
SHA256 62a13963c29d2a8beaa008352547a622e8266986af127b6718137d964b95bdf4
MD5 ad8d9b97360849980ad2546c79c52d87
BLAKE2b-256 2e556b22254f24c67b285e6a7592a996a57e0554ac61eb6795c20f31c76f2237

See more details on using hashes here.

Provenance

The following attestation bundles were made for vopy-0.1.4.tar.gz:

Publisher: deploy.yml on Bilkent-CYBORG/VOPy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vopy-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: vopy-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 107.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vopy-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c9229245c32ac896290bbaf6efeb3436218854d9f9a0bc6af269a51a76291dd5
MD5 6af4bb6e23074bea0628945409a1e55e
BLAKE2b-256 916b1ea2c11c672be53be757d4723288b1eb3e1c58e98d72de6c087de9c11046

See more details on using hashes here.

Provenance

The following attestation bundles were made for vopy-0.1.4-py3-none-any.whl:

Publisher: deploy.yml on Bilkent-CYBORG/VOPy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page