Skip to main content

Multiple-target machine learning

Project description

Himalaya: Multiple-target linear models

Himalaya implements machine learning linear models in Python, focusing on computational efficiency for large numbers of targets.

Github Python License

Use himalaya if you need a library that:

  • estimates linear models on large numbers of targets,

  • runs on CPU and GPU hardware,

  • provides estimators compatible with scikit-learn’s API.

Himalaya is stable (with particular care for backward compatibility) and open for public use (give it a star!).

Example

import numpy as np
n_samples, n_features, n_targets = 10, 5, 4
np.random.seed(0)
X = np.random.randn(n_samples, n_features)
Y = np.random.randn(n_samples, n_targets)

from himalaya.ridge import RidgeCV
model = RidgeCV(alphas=[1, 10, 100])
model.fit(X, Y)
print(model.best_alphas_)  # [ 10. 100.  10. 100.]
  • The model RidgeCV uses the same API as scikit-learn estimators, with methods such as fit, predict, score, etc.

  • The model is able to efficiently fit a large number of targets (routinely used with 100k targets).

  • The model selects the best hyperparameter alpha for each target independently.

Check more examples of use of himalaya in the gallery of examples.

Models

Himalaya implements the following models:

  • Ridge

  • RidgeCV

  • GroupRidgeCV

  • KernelRidge

  • KernelRidgeCV

  • WeightedKernelRidge

  • MultipleKernelRidgeCV

  • SparseGroupLassoCV

Himalaya backends

Himalaya can be used seamlessly with different backends. The available backends are numpy (default), cupy, and pytorch. To change the backend (e.g. to cupy), call:

from himalaya.backend import set_backend
backend = set_backend("cupy")

and give cupy arrays inputs to the himalaya solvers. For convenience, estimators implementing scikit-learn’s API can cast arrays to the correct input type.

GPU acceleration

To run himalaya on a graphics processing unit (GPU), you can use both cupy or pytorch backends.

To use the cupy backend, call:

from himalaya.backend import set_backend
backend = set_backend("cupy")

data = backend.asarray(data)

To use the pytorch backend, call:

from himalaya.backend import set_backend
backend = set_backend("torch_cuda")
# "torch" uses pytorch on CPU, "torch_cuda" uses pytorch on GPU

data = backend.asarray(data)

Installation

Dependencies

Himalaya requires:

  • Python 3

  • Numpy

  • Scikit-learn

  • PyTorch (optional GPU backend) (1.9+ preferred)

  • Cupy (optional GPU backend)

  • Matplotlib (optional, for visualization only)

  • Pytest (optional, for testing only)

Standard installation

You may install the latest version of himalaya using the package manager pip, which will automatically download himalaya from the Python Package Index (PyPI):

pip install himalaya

Installation from source

To install himalaya from the latest source (main branch), you may call:

pip install git+https://github.com/gallantlab/himalaya.git

Developers can also install himalaya in editable mode via:

git clone https://github.com/gallantlab/himalaya
cd himalaya
pip install --editable .

Cite this package

If you use himalaya in your work, please cite our (future) publication:

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

himalaya-0.3.2.tar.gz (99.3 kB view details)

Uploaded Source

Built Distribution

himalaya-0.3.2-py3-none-any.whl (77.7 kB view details)

Uploaded Python 3

File details

Details for the file himalaya-0.3.2.tar.gz.

File metadata

  • Download URL: himalaya-0.3.2.tar.gz
  • Upload date:
  • Size: 99.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.1 pkginfo/1.5.0.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.3

File hashes

Hashes for himalaya-0.3.2.tar.gz
Algorithm Hash digest
SHA256 a59826bc5d162701fb7c017dbc36a63ab9fe17b7baed62105ce9ac06c88792a4
MD5 d97dce488c3231ff2ec95039bc64cef8
BLAKE2b-256 0d3a3d35d4e80c9b07f632fd52cae406cecc5370ed4d7c8ad2408a1cca344bb9

See more details on using hashes here.

File details

Details for the file himalaya-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: himalaya-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 77.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.1 pkginfo/1.5.0.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.3

File hashes

Hashes for himalaya-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 39844122ca2264023112082ad1093991f4ce713d4e925f3ddad55104090ae1d8
MD5 07e0fa588b4442a084a29c6fe6b2ab4f
BLAKE2b-256 b5b55dae838cad3972fce5be57707a3ba8898ffc0ab10a3db74b3645e8ebc81c

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