Skip to main content

poli, a library of discrete objective functions

Project description

poli 🧪, a library for discrete objective functions

poli base (dev, conda, python 3.9) Link to documentation

poli is a library of discrete objective functions for benchmarking optimization algorithms.

Black boxes

Black box References Tests
Toy continuous functions (e.g. Ackley, Hartmann...) (Al-Roomi 2015), (Surjanovic & Bingham 2013) poli base (dev, conda, python 3.9)
Ehrlich functions (Stanton et al. 2024) poli base (dev, conda, python 3.9)
PMO/GuacaMol benchmark (Brown et al. 2019), (Gao et al. 2022), (Huang et al. 2021) poli tdc (dev, conda, python 3.9)
Dockstring (García-Ortegón et al. 2022) poli dockstring (dev, conda, python 3.9)
RaSP (Blaabjerg et al. 2023) poli rasp (conda, py3.9)
FoldX stability and SASA (Schymkowitz et al. 2005) -

Features

  • 🔲 isolation of black box function calls inside conda environments. Don't worry about clashes w. black box requirements, poli will create the relevant conda environments for you.
  • 🗒️ logging each black box call using observers.
  • A numpy interface. Inputs are np.arrays of strings, outputs are np.arrays of floats.
  • SMILES and SELFIES support for small molecule manipulation.

Getting started

To install poli, we recommend creating a fresh conda environment

conda create -n poli-base python=3.9
conda activate poli-base
pip install git+https://github.com/MachineLearningLifeScience/poli.git@dev

To check if everything went well, you can run

$ python -c "from poli import create"

An example: dockstring

Open the minimal example in Colab

In this next example, we estimate the docking score of the example provided in dockstring:

import numpy as np
from poli import objective_factory

problem = objective_factory.create(
    name="dockstring",
    target_name="drd2"
)
f, x0 = problem.black_box, problem.x0
y0 = f(x0)

# x0: [['C' 'C' '1' '=' 'C' '(' 'C', ...]] (i.e. Risperidone's SMILES)
# y0: 11.9
print(x0, y0)

Cite us and other relevant work

If you use certain black boxes, we expect you to cite the relevant work. Check inside the documentation of each black box for the relevant references.

Where can I find the documentation?

The main documentation site is hosted as a GitHub page here: https://machinelearninglifescience.github.io/poli-docs/

Building the documentation locally

If you install the requirements-dev.txt via

pip install -r requirements-dev.txt

then you will have access to sphinx. You should be able to build the documentation by going to the docs folder and building it:

cd docs/
make html

Afterwards, you can enter the build folder and open index.html.

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

poli-base-1.0.1.tar.gz (4.5 MB view details)

Uploaded Source

Built Distribution

poli_base-1.0.1-py3-none-any.whl (4.6 MB view details)

Uploaded Python 3

File details

Details for the file poli-base-1.0.1.tar.gz.

File metadata

  • Download URL: poli-base-1.0.1.tar.gz
  • Upload date:
  • Size: 4.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for poli-base-1.0.1.tar.gz
Algorithm Hash digest
SHA256 fbd8dcd79a1b528a6026a1da3dca01569ec45439d93a596da88ce8570e795f2a
MD5 2aff536c3d3433f9d56e8b9d86238a78
BLAKE2b-256 9d1da6c1c322f2cbeac2f3e970e8924c6ac2d4b20048944381f04ef443787232

See more details on using hashes here.

File details

Details for the file poli_base-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: poli_base-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for poli_base-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1d87d531118c4b2d3eea7874e0f27a0707338dae46840004de61b3057fddb590
MD5 6655e6019000f410c0bca38b30530424
BLAKE2b-256 8b22c2317d755c780a24c8300e174d7ef5e17a4b8b2717c2951ff74242414416

See more details on using hashes here.

Supported by

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