| Latest Release |  |
 |
|
| Python Version |  |
| License |  |
| Downloads |  |
 |
|
| Citation |  |
Polaris establishes a novel, industry‑certified standard to foster the development of impactful methods in AI-based drug discovery.
This library is a Python client to interact with the Polaris Hub. It allows you to:
- Download Polaris datasets and benchmarks.
- Evaluate a custom method against a Polaris benchmark.
Quick API Tour
import polaris as po
# Load the benchmark from the Hub
benchmark = po.load_benchmark("polaris/hello-world-benchmark")
# Get the train and test data-loaders
train, test = benchmark.get_train_test_split()
# Use the training data to train your model
# Get the input as an array with 'train.inputs' and 'train.targets'
# Or simply iterate over the train object.
for x, y in train:
...
# Work your magic to accurately predict the test set
predictions = [0.0 for x in test]
# Evaluate your predictions
results = benchmark.evaluate(predictions)
# Submit your results
results.upload_to_hub(owner="dummy-user")
Documentation
Please refer to the documentation, which contains tutorials for getting started with polaris and detailed descriptions of the functions provided.
How to cite
Please cite Polaris if you use it in your research. A list of relevant publications:
- Preprint, Method Comparison Guidelines.
- Zenodo, Code Repository.
Installation
You can install polaris using conda/mamba/micromamba:
conda install -c conda-forge polaris
You can also use pip:
pip install polaris-lib
Development lifecycle
Setup dev environment
conda env create -n polaris -f env.yml
conda activate polaris
pip install --no-deps -e .
Other installation options
Alternatively, using [uv](https://github.com/astral-sh/uv):
```shell
uv venv -p 3.12 polaris
source .venv/polaris/bin/activate
uv pip compile pyproject.toml -o requirements.txt --all-extras
uv pip install -r requirements.txt
```
Tests
You can run tests locally with:
pytest
License
Under the Apache-2.0 license. See LICENSE.
2 maintainers
Release files for polaris-lib 0.13.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| polaris_lib-0.13.0.tar.gz | 308.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| polaris_lib-0.13.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 423.6 kB
Release files / polaris_lib-0.13.0.tar.gz
| Download URL | polaris_lib-0.13.0.tar.gz |
|---|---|
| Size | 308.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e39d5a2e5ca7870755b50a3995f0892ffcec4df63e69ea3cafa45fe853acaf5b
|
|
BLAKE2b-256 checksum How to use checksums |
bd505bd63b7eec6f8a301177b2b706bd9c37be1481320a64aa06f36247114d8a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / polaris_lib-0.13.0-py3-none-any.whl
| Download URL | polaris_lib-0.13.0-py3-none-any.whl |
|---|---|
| Size | 115.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c02b7fe1204fc40b8717f613d88f8f4e52faeae3b00025a39ee1c7c0564c0555
|
|
BLAKE2b-256 checksum How to use checksums |
6e1e3b9225fd2e5446cc7be4cfd2531353f9de76ae14b53cb8001854607b0fcd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
