Metadata-Version: 2.1
Name: ISLP
Version: 0.3.19
Summary: Library for ISLP labs
Home-page: http://github.org/intro-stat-learning/ISLP
Download-URL: 
Author: ISLP authors
Author-email: Jonathan Taylor <jonathan.taylor@stanford.edu>, Trevor Hastie <hastie@stanford.edu>
Maintainer: Jonathan Taylor
Maintainer-email: Jonathan Taylor <jonathan.taylor@stanford.edu>
Project-URL: Homepage, https://github.com/intro-stat-learning/ISLP
Project-URL: Bug Reports, https://github.com/intro-stat-learning/ISLP/issues
Project-URL: Funding, https://donate.pypi.org
Project-URL: Say Thanks!, http://saythanks.io/to/example
Project-URL: Source, https://github.com/pypa/sampleproject/
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: torch
Requires: torchmetrics
Requires: pytorch_lightning
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: doc
Provides-Extra: test

# ISLP

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

## Install instructions

### Mac OS X / Linux

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
```

### Windows

On windows, create a `Python` environment called `islp` in the Anaconda app. This can be done by selecting `Environments` on the left hand side of the app's screen. After creating the environment, open a terminal within that environment by clicking on the "Play" button.


## Installing `ISLP`

Having completed the steps above, we use `pip` to install the `ISLP` package:

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

### Torch requirements

The `ISLP` labs use `torch` and various related packages for the lab on deep learning. The requirements
are included in the requirements for `ISLP` with the exception of those needed
for the labs which are included in the [requirements for the labs](https://github.com/intro-stat-learning/ISLP_labs/blob/main/requirements.txt). 

## Jupyter

### Mac OS X

If JupyterLab is not already installed, run the following after having activated your `islp` environment:

```{python}
pip install jupyterlab
```

### Windows

Either use the same `pip` command above or install JupyterLab from the `Home` tab. Ensure that the environment
is your `islp` environment. This information appears near the top left in the Anaconda `Home` page.


## Documentation

See the [docs](https://intro-stat-learning.github.io/ISLP/labs.html) for the latest documentation.



