Skip to main content

Implémentation Python de Dual-sPLS basée sur Alsouki et al. (2023)

Project description

Dual-sPLS: Full theory and reimplementation from R to Python

The goal of this repository is to reimplement the paper Dual-sPLS: a family of Dual Sparse Partial Least Squares regressions for feature selection and prediction with tunable sparsity... from R to Python. It can be used both as a learning tool to understand the theory behind the algorithm and as a standalone installable library.

Usage

To start using the repository, you can clone it:

git clone https://github.com/malerbe/Dual-sPLS.git

and then install it using pip:

cd ./Dual-sPLS
pip install -e . 

It is suggested to use the notebook notebooks/predict_simulated.ipynb as a "documentation" to understand how to use different features implemented in the library. Reading the docstrings and the commentaries in the code will allow a better understanding of what the arguments correspond to.

The library also allows the user to generate synthetic data as presented in the paper. To see how to use the generation function, see: notebooks/simulate.ipynb

Learning Path

If your goal is to fully grasp the mechanics behind the algorithms, it is recommended to follow the explanation notebooks in this specific order:

  • Fundamentals: docs/PLS.ipynb

  • Introducing Sparsity: docs/sPLS.ipynb

  • The Dual Approach: docs/Dual_sPLS.ipynb

It is then possible to fully understand the first production implementation src/dual_spls/lasso.py easily as it only uses code already explained and implemented the last docs/Dual_sPLS.ipynb notebook.

Sources and original repository

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

dual_spls-0.0.1.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dual_spls-0.0.1-py3-none-any.whl (25.1 kB view details)

Uploaded Python 3

File details

Details for the file dual_spls-0.0.1.tar.gz.

File metadata

  • Download URL: dual_spls-0.0.1.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for dual_spls-0.0.1.tar.gz
Algorithm Hash digest
SHA256 c9900676af8d9353fa831b58ce34b9e14856619d80dd9d691d17ba27f3dcf16d
MD5 9cefe7906e2eb92885cdcd191fd018c8
BLAKE2b-256 50d3f3cc836939ea461059372f833903ceab37a69288ac3918901a2844bac2b9

See more details on using hashes here.

File details

Details for the file dual_spls-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: dual_spls-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 25.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for dual_spls-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b9e548d30ce841b67deeba27baa4462e25f73f684f689def9e1c0616b9086dfa
MD5 de67cbbd4f43f283e00e1a2b0b219ef7
BLAKE2b-256 daad241551a58ce1956ffac88ddcd2cee12349ad4959d735845588edf27589ad

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page