Skip to content

Commit 1a5ddc8

Browse files
authored
MNT move citation up in readme (#284)
1 parent 7f714c2 commit 1a5ddc8

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
<img src="doc/_static/images/logo.svg" alt="skglm logo" width="34%" align="center"/>
44

5+
56
## A fast ⚡ and modular ⚒️ scikit-learn replacement for sparse GLMs
67

78
![build](https://github.com/scikit-learn-contrib/skglm/workflows/pytest/badge.svg)
@@ -19,6 +20,24 @@ You get to choose from ``skglm``'s already-made estimators or **customize your o
1920

2021
Excited to have a tour on ``skglm`` [documentation](https://contrib.scikit-learn.org/skglm/)?
2122

23+
# Cite
24+
25+
``skglm`` is the result of perseverant research. It is licensed under [BSD 3-Clause](https://github.com/scikit-learn-contrib/skglm/blob/main/LICENSE). You are free to use it and if you do so, please cite
26+
27+
```bibtex
28+
@inproceedings{skglm,
29+
title = {Beyond L1: Faster and better sparse models with skglm},
30+
author = {Q. Bertrand and Q. Klopfenstein and P.-A. Bannier and G. Gidel and M. Massias},
31+
booktitle = {NeurIPS},
32+
year = {2022},
33+
}
34+
35+
@article{moufad2023skglm,
36+
title={skglm: improving scikit-learn for regularized Generalized Linear Models},
37+
author={Moufad, Badr and Bannier, Pierre-Antoine and Bertrand, Quentin and Klopfenstein, Quentin and Massias, Mathurin},
38+
year={2023}
39+
}
40+
```
2241

2342
# Why ``skglm``?
2443

@@ -108,18 +127,7 @@ You can also take our tutorial to learn how to create your own datafit and penal
108127
- **pull request**: you may have fixed a bug, added a features, or even fixed a small typo in the documentation, ... you can submit a [pull request](https://github.com/scikit-learn-contrib/skglm/pulls) and we will reach out to you asap.
109128

110129

111-
# Cite
112130

113-
``skglm`` is the result of perseverant research. It is licensed under [BSD 3-Clause](https://github.com/scikit-learn-contrib/skglm/blob/main/LICENSE). You are free to use it and if you do so, please cite
114-
115-
```bibtex
116-
@inproceedings{skglm,
117-
title = {Beyond L1: Faster and better sparse models with skglm},
118-
author = {Q. Bertrand and Q. Klopfenstein and P.-A. Bannier and G. Gidel and M. Massias},
119-
booktitle = {NeurIPS},
120-
year = {2022},
121-
}
122-
```
123131

124132

125133
# Useful links

0 commit comments

Comments
 (0)