Skip to main content

Client for the Polaris Hub.

Project description


✨ Polaris Hub | 📚 Client Doc


PyPI Conda PyPI - Downloads Conda PyPI - Python Version Code license GitHub Repo stars GitHub Repo stars

test release code-check doc

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.
  • Create and upload new datasets and benchmarks.

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.

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.

Download files

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

Source Distribution

polaris_lib-0.8.0.tar.gz (154.1 kB view details)

Uploaded Source

Built Distribution

polaris_lib-0.8.0-py3-none-any.whl (83.4 kB view details)

Uploaded Python 3

File details

Details for the file polaris_lib-0.8.0.tar.gz.

File metadata

  • Download URL: polaris_lib-0.8.0.tar.gz
  • Upload date:
  • Size: 154.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for polaris_lib-0.8.0.tar.gz
Algorithm Hash digest
SHA256 5b93e6becd17f40a32c0be1a512a806f1003e1c420e2d3c620ed1513a66963e8
MD5 79843f3c9e517ff0270e7befa83f4eb8
BLAKE2b-256 753f1c000c951897265841fbfff1e2624a6bc0ccc188afd4c59666b2e37bf0a9

See more details on using hashes here.

File details

Details for the file polaris_lib-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: polaris_lib-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 83.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for polaris_lib-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d55c878627b5b83016546d93d450d4aeb9d9af55e4daebb933d0558e27f8b9cd
MD5 97f4d3b637e759fa4d86a1d73fa1c92d
BLAKE2b-256 53d7504d48d2bacdd55900c47ee3cd118789e499793904b9fbfc86ca918e859a

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