Skip to content

Commit

Permalink
Add install and contributing sections in README
Browse files Browse the repository at this point in the history
  • Loading branch information
lbluque committed Oct 2, 2023
1 parent ec70b6e commit 5c10e97
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,16 @@ Available regression models
- Adaptive versions of Lasso, Group Lasso, Overlap Group Lasso, Sparse Group Lasso & Ridged Group Lasso.
- Best Subset Selection, Ridged Best Subset, L0, L1L0 & L2L0 (all with optional grouping of parameters)

Installation
------------
**sparse-lm** is available on [PyPI](https://pypi.org/project/sparse-lm/), and can be installed via pip:

```bash
pip install sparse-lm
```

Additional information on installation can be found in the [here](https://cedergrouphub.github.io/sparse-lm/install.html).

Basic usage
-----------
If you already use **scikit-learn**, using **sparse-lm** will be very easy. Just use any
Expand All @@ -43,4 +53,12 @@ cvsearch.fit(X, y)
print(cvsearch.best_params_)
```

For more details on use and functionality see the [documentation](https://cedergrouphub.github.io/sparse-lm/).
For more details on use and functionality have a look at the
[examples](https://cedergrouphub.github.io/sparse-lm/auto_examples/index.html) and
[API](https://cedergrouphub.github.io/sparse-lm/api.html) sections of the documentation.

Contributing
------------

We welcome any contributions that you think may improve the package! Please have a look at the
[contribution guidelines](https://cedergrouphub.github.io/sparse-lm/contributing.html) in the documentation.

0 comments on commit 5c10e97

Please sign in to comment.