Skip to content

Commit 1e58597

Browse files
authored
Update bibtex for Lanczos paper and mention LstSq paper in readme (#257)
* Update bibtex for Lanczos paper and mention LstSq paper in readme * Preserve previous bibtex keys
1 parent 1cdffbf commit 1e58597

4 files changed

Lines changed: 27 additions & 9 deletions

File tree

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,25 @@ We would appreciate it if you cited the paper as follows:
107107

108108
```bibtex
109109
@article{kraemer2024gradients,
110-
title={Gradients of functions of large matrices},
111-
author={Kr\"amer, Nicholas and Moreno-Mu\~noz, Pablo and Roy, Hrittik and Hauberg, S{\o}ren},
112-
journal={arXiv preprint arXiv:2405.17277},
113-
year={2024}
110+
title={Gradients of functions of large matrices},
111+
author={Kr{\"a}mer, Nicholas and Moreno-Mu{\~n}oz, Pablo and Roy, Hrittik and Hauberg, S{\o}ren},
112+
journal={Advances in Neural Information Processing Systems},
113+
volume={37},
114+
pages={49484--49518},
115+
year={2024}
116+
}
117+
```
118+
119+
If you are using Matfree's differentiable LSMR implementation, then you
120+
are using the algorithm from [this paper](https://arxiv.org/abs/2510.19634).
121+
We would appreciate it if you cited the paper as follows:
122+
123+
```bibtex
124+
@article{roy2025matrix,
125+
title={Matrix-Free Least Squares Solvers: Values, Gradients, and What to Do With Them},
126+
author={Roy, Hrittik and Hauberg, S{\\o}ren and Kr{\"a}mer, Nicholas},
127+
journal={arXiv preprint arXiv:2510.19634},
128+
year={2025}
114129
}
115130
```
116131

matfree/decomp.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,10 @@ def tridiag_sym(
5656
```bibtex
5757
@article{kraemer2024gradients,
5858
title={Gradients of functions of large matrices},
59-
author={Kr\"amer, Nicholas and Moreno-Mu\~noz, Pablo and
60-
Roy, Hrittik and Hauberg, S{\o}ren},
61-
journal={arXiv preprint arXiv:2405.17277},
59+
author={Kr{\"a}mer, Nicholas and Moreno-Mu{\~n}oz, Pablo and Roy, Hrittik and Hauberg, S{\o}ren},
60+
journal={Advances in Neural Information Processing Systems},
61+
volume={37},
62+
pages={49484--49518},
6263
year={2024}
6364
}
6465
```

matfree/lstsq.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ def lsmr(
3333
Setting `custom_vjp` to `True` implies using the low-memory
3434
gradients of matrix-free least squares,
3535
according to what has been proposed by Roy et al. (2025).
36+
[Here](https://arxiv.org/abs/2510.19634) is a link to the preprint.
3637
These gradients are exact, so there is little reason not to use them.
3738
If you use this configuration, please consider
3839
citing Roy et al. (2025; bibtex below).
3940
4041
??? note "BibTex for Roy et al. (2025)"
4142
```bibtex
4243
@article{roy2025matrix,
43-
title={Matrix-Free Least Squares Solvers:
44-
Values, Gradients, and What to Do With Them},
44+
title={Matrix-Free Least Squares Solvers: Values, Gradients, and What to Do With Them},
4545
author={Roy, Hrittik and Hauberg, S{\\o}ren and Kr{\"a}mer, Nicholas},
4646
journal={arXiv preprint arXiv:2510.19634},
4747
year={2025}

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,8 @@ ignore = [
117117
"D213",
118118
# zip(..., strict=True/False) is not supported on Python < 3.10
119119
"B905",
120+
# Disable line-too-long because it is handled by formatter (and we allow docstrings to contain long lines)
121+
"E501",
120122
]
121123

122124
[tool.ruff.format]

0 commit comments

Comments
 (0)