Skip to content

Commit 0c5f84a

Browse files
committed
Updates the readme to incorporate the new readme from poli
1 parent 3b2294c commit 0c5f84a

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

docs/poli-docs/index.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
# poli 🧪: a library of discrete objective functions
22

3-
This page contains documentation on how to use `poli`, a library of discrete objective functions in biology, cheminformatics, and more. This page also presents `poli-baselines`, a collection of optimizers of these discrete black box functions.
3+
[![Testing (conda, python 3.9)](https://github.com/MachineLearningLifeScience/poli/actions/workflows/python-tox-testing-including-conda.yml/badge.svg)](https://github.com/MachineLearningLifeScience/poli/actions/workflows/python-tox-testing-including-conda.yml) [![Test (conda, python 3.9)](https://github.com/MachineLearningLifeScience/poli-baselines/actions/workflows/python-tox-testing.yml/badge.svg)](https://github.com/MachineLearningLifeScience/poli-baselines/actions/workflows/python-tox-testing.yml)
44

5-
A core feature of `poli` is isolating calls to complicated objective functions which might, for example, depend on simulators, binaries, and highly specific package requirements.
6-
Our promise is: if you can run your objective function reliably in a `conda` environment, then you can register it and call it from other projects and environments without having to worry about re-installing all the dependencies.
5+
[poli](https://github.com/MachineLearningLifeScience/poli) is a library of discrete objective functions for benchmarking optimization algorithms. Examples include:
6+
- 🔬 **stability** of mutations from a wildtype protein (using [foldx](https://foldxsuite.crg.eu/) or [rasp](https://github.com/KULL-Centre/_2022_ML-ddG-Blaabjerg)).
7+
- 🧪 **docking scores** of ligands to proteins (using [dockstring](https://github.com/dockstring/dockstring), [pyscreener](https://github.com/coleygroup/pyscreener) and [pytdc](https://tdcommons.ai/functions/oracles/)).
8+
- 💊 **druglikeness** or **synthetic acccesibility** of small molecules (using [rdkit](https://github.com/rdkit/rdkit) and [pytdc](https://tdcommons.ai/functions/oracles/)).
9+
10+
Some of `poli`'s features:
11+
- 🔲 **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.
12+
- 🗒️ **logging** logic at the black box `__call__` level using observers.
13+
- A numpy interface. Inputs are `np.array`s of strings, outputs are `np.array`s of floats.
14+
- `SMILES` and `SELFIES` support for small molecule manipulation.
15+
16+
This documentation also discusses [`poli-baselines`](https://github.com/MachineLearningLifeScience/poli-baselines), a collection of optimizers of these discrete black box functions which is currently in alpha stage.
717

818
## Getting started
919

0 commit comments

Comments
 (0)