Skip to content

Commit 21fcbfe

Browse files
committed
add README
1 parent 91d2cac commit 21fcbfe

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
skglm
2+
========
3+
4+
``skglm`` is a library that provide better sparse generalized linear model for scikit-learn.
5+
Its main features are:
6+
7+
- **speed**: problems with millions of features can be solved in seconds. Default solvers rely on efficient coordinate descent with numba just in time compilation.
8+
- **flexibility**: virtually any combination of datafit and penalty can be implemented in a few lines of code.
9+
- **sklearn API**: all estimators are drop-in replacements for scikit-learn.
10+
- **scope**: support for many missing models in scikit-learn - weighted Lasso, arbitrary group penalties, non convex sparse penalties, etc.
11+
12+
13+
Cite
14+
----
15+
16+
If you use this code, please cite
17+
18+
.. code-block:: none
19+
20+
@online{skglm,
21+
title={Beyond L1: Faster and Better Sparse Models with skglm},
22+
author={Q. Bertrand and Q. Klopfenstein and P.-A. Bannier and G. Gidel and M. Massias},
23+
year={2022},
24+
url={https://arxiv.org/abs/2204.07826}
25+
}
26+
27+
28+
29+
Installing the development version
30+
----------------------------------
31+
First clone the repository available at https://github.com/mathurinm/skglm::
32+
33+
$ git clone https://github.com/mathurinm/skglm.git
34+
$ cd skglm/
35+
36+
Then, install the package with::
37+
38+
$ pip install -e .
39+
40+
To check if everything worked fine, you can do::
41+
42+
$ python -c 'import skglm'
43+
44+
and it should not give any error message.

0 commit comments

Comments
 (0)