Skip to content

Commit 3762627

Browse files
authored
DOC - update documentation (#242)
1 parent 472c2a3 commit 3762627

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

CITATION.bib

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
@inproceedings{skglm,
2+
title = {Beyond L1: Faster and better sparse models with skglm},
3+
author = {Q. Bertrand and Q. Klopfenstein and P.-A. Bannier and G. Gidel and M. Massias},
4+
booktitle = {NeurIPS},
5+
year = {2022},
6+
}

doc/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
import os
1616
import sys
1717
import warnings
18+
from datetime import date
1819

1920
import sphinx_gallery # noqa
2021
import sphinx_bootstrap_theme # noqa
@@ -95,7 +96,7 @@
9596

9697
# General information about the project.
9798
project = u'skglm'
98-
copyright = u'2022, skglm developers'
99+
copyright = f'2022-{date.today().year}, skglm developers'
99100
author = u'skglm developers'
100101

101102
# The version info for the project you're documenting, acts as replacement for

doc/index.rst

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
=========
77
``skglm``
88
=========
9-
*— A fast and modular scikit-learn replacement for sparse GLMs —*
9+
*— A fast and modular scikit-learn replacement for regularized GLMs —*
1010

1111
--------
1212

1313

14-
``skglm`` is a Python package that offers **fast estimators** for sparse Generalized Linear Models (GLMs)
14+
``skglm`` is a Python package that offers **fast estimators** for regularized Generalized Linear Models (GLMs)
1515
that are **100% compatible with** ``scikit-learn``. It is **highly flexible** and supports a wide range of GLMs.
1616
You get to choose from ``skglm``'s already-made estimators or **customize your own** by combining the available datafits and penalties.
1717

@@ -21,7 +21,7 @@ Get a hands-on glimpse on ``skglm`` through the :ref:`Getting started page <gett
2121
Why ``skglm``?
2222
--------------
2323

24-
``skglm`` is specifically conceived to solve sparse GLMs.
24+
``skglm`` is specifically conceived to solve regularized GLMs.
2525
It supports many missing models in ``scikit-learn`` and ensures high performance.
2626

2727
There are several reasons to opt for ``skglm`` among which:
@@ -57,10 +57,6 @@ It is also available on conda-forge and can be installed using, for instance:
5757
With ``skglm`` being installed, Get the first steps with the package via the :ref:`Getting started section <getting_started>`.
5858
Other advanced topics and uses-cases are covered in :ref:`Tutorials <tutorials>`.
5959

60-
.. note::
61-
62-
- Currently, ``skglm`` is unavailable on Conda but will be released very soon...
63-
6460

6561
Cite
6662
----
@@ -77,6 +73,7 @@ You are free to use it and if you do so, please cite
7773
and G. Gidel and M. Massias},
7874
booktitle = {NeurIPS},
7975
year = {2022},
76+
}
8077
8178
8279
.. it is mandatory to keep the toctree here although it doesn't show up in the page
@@ -93,4 +90,3 @@ You are free to use it and if you do so, please cite
9390
api.rst
9491
contribute.rst
9592
changes/whats_new.rst
96-

0 commit comments

Comments
 (0)