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'd like to contribute, please follow CONTRIBUTING.md.

If you want a manual installation:

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. Legacy files requirements.txt and environment.yml are also maintained.

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

# Inside the package folder
pre-commit install

Contributing

Follow 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.

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.2.0.tar.gz (693.9 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.2.0-py3-none-any.whl (107.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vopy-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9c0366763c9d474c0dc20ae17789097df9c1ab9d62461e2cda00231b1004b665
MD5 ed4dcc7175e2c5660879d8dd0b12f5ea
BLAKE2b-256 42a109e1f5a268d421d0e4ee6526b9cdd3e0577a730adf8ea0374bbd321d7187

See more details on using hashes here.

Provenance

The following attestation bundles were made for vopy-0.2.0.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.2.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for vopy-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7307d4a45b206f6b7137b5cb019e8d4e75cf85234e383b74965cf04e5f434513
MD5 598da900d75353413b23447d22165891
BLAKE2b-256 9a64a6e178530d5c302bcb30d50eb9b8a7675b380b33ac4676a00741362f224f

See more details on using hashes here.

Provenance

The following attestation bundles were made for vopy-0.2.0-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