Metadata-Version: 2.1
Name: ISLP
Version: 0.3.16
Summary: Testing a fixed value of lambda
Home-page: http://github.org/jonathan.taylor/ISLP
Download-URL: 
Author: ISLP authors
Author-email: 
Maintainer: Jonathan Taylor
Maintainer-email: 
License: BSD license
Platform: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Requires: numpy (>=1.7.1)
Requires: scipy (>=0.9)
Requires: statsmodels (>=0.13)
Requires: pandas (>=0.20)
Requires: pandas (<=1.9)
Requires: sklearn (>=1.2)
Requires: lifelines
Requires: joblib
Requires: pygam
Requires-Dist: numpy (>=1.7.1)
Requires-Dist: scipy (>=0.9)
Requires-Dist: matplotlib (>=3.3.3)
Requires-Dist: pandas (>=0.20)
Requires-Dist: statsmodels (>=0.13)
Requires-Dist: scikit-learn (>=1.2)
Requires-Dist: numpy (>=0.0)
Requires-Dist: scipy (>=0.0)
Requires-Dist: jupyter (>=0.0)
Requires-Dist: pandas (>=0.0)
Requires-Dist: lxml (>=0.0)
Requires-Dist: scikit-learn (>=0.0)
Requires-Dist: joblib (>=0.0)
Requires-Dist: pygam (>=0.0)
Requires-Dist: lifelines (>=0.0)
Provides-Extra: doc
Requires-Dist: Sphinx (>=1.0) ; extra == 'doc'
Provides-Extra: test
Requires-Dist: nose (>=0.10.1) ; extra == 'test'

# ISLP

This package collects data sets and various helper functions
for ISLP.

## Install instructions

We generally recommend creating a [conda](https://anaconda.org) environment to isolate any code
from other dependencies. The `ISLP` package does not have unusual dependencies, but this is still
good practice. To create a conda environment in a Mac OS X or Linux environment run:

```{python}
conda create --name islp
```

To run python code in this environment, you must activate it:

```{python}
conda activate islp
```

### Mac OS X

Running in the desired environment, we use `pip` to install the `ISLP` package:

```{python}
pip install ISLP
```

### Windows

See the [python packaging instructions](https://packaging.python.org/en/latest/tutorials/installing-packages/#ensure-you-can-run-pip-from-the-command-line) for a simple way to run `pip` within
Jupyter or IPython.

Alternatively, within a python shell in the environment you want to install `ISLP`, the following commands should install `ISLP`:

```{python}
import os, sys
cmd = f'{sys.executable} -m pip install ISLP'
os.system(cmd)
```

### Torch requirements

The `ISLP` labs use `torch` and various related packages for the lab on deep learning. The requirements
can be found [here](torch_requirements.txt). Alternatively, you can install them directly using `pip`

```{python}
!pip install -r https://raw.githubusercontent.com/intro-stat-learning/ISLP/main/torch_requirements.txt
```

## Documentation

See the [read the docs page](https://islp.readthedocs.io/en/latest/models.html) for the latest documentation.



