Skip to main content

Multiple-target machine learning

Project description

Himalaya: Multiple-target linear models

Github Python License Build Codecov Downloads

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

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.

More examples

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

Tutorials using himalaya for fMRI

Himalaya was designed primarily for functional magnetic resonance imaging (fMRI) encoding models. In depth tutorials about using himalaya for fMRI encoding models can be found at gallantlab/voxelwise_tutorials.

Models

Himalaya implements the following models:

  • Ridge, RidgeCV

  • KernelRidge, KernelRidgeCV

  • GroupRidgeCV, MultipleKernelRidgeCV, WeightedKernelRidge

  • SparseGroupLassoCV

See the model descriptions in the documentation website.

Himalaya backends

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

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

and give torch 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 either the cupy or the torch_cuda backend:

from himalaya.backend import set_backend
backend = set_backend("cupy")  # or "torch_cuda"

data = backend.asarray(data)

Installation

Dependencies

  • Python 3

  • Numpy

  • Scikit-learn

Optional (GPU backends):

  • PyTorch (1.9+ preferred)

  • Cupy

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 give it a star and cite our 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.4.0.tar.gz (69.6 kB view details)

Uploaded Source

Built Distribution

himalaya-0.4.0-py3-none-any.whl (82.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: himalaya-0.4.0.tar.gz
  • Upload date:
  • Size: 69.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for himalaya-0.4.0.tar.gz
Algorithm Hash digest
SHA256 1d72370a0abbf8c26d267a92647dbba5f91df02c92b0f677502a4e334d35d0c6
MD5 0fd6d69947c75f6de65aee412113c409
BLAKE2b-256 0c944580e405f5497c5cc52a11ae260566c2dca98ef3436ec50bbe9fdcb240f7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: himalaya-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 82.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for himalaya-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 70a5e667e15b50cc3ae81df1a3a48f650b924d4bcd0e77a37c5c8412e7589892
MD5 8eeba9a4cecb2eec4efdeb26f21ab644
BLAKE2b-256 9649fb5f8a8761d7215eb52fc4036564115697d16135bd18960548046f9ea02c

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