Skip to content

Commit

Permalink
[DOC] Add link to arXiv submission
Browse files Browse the repository at this point in the history
  • Loading branch information
f-dangel committed Dec 12, 2023
1 parent 5b72ce8 commit a23d368
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This package contains the official PyTorch implementation of our
**memory-efficient and numerically stable KFAC** variant, termed SINGD
([paper](TODO Insert arXiv link)).
([paper](http://arxiv.org/abs/2312.05705)).

The main feature is a `torch.optim.Optimizer` which works like most PyTorch optimizers and is compatible with:

Expand Down
4 changes: 2 additions & 2 deletions docs/examples/example_05_structures.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
# [`structures`](https://readthedocs.org/projects/singd/api/). The first entry
# specifies the structure of $\mathbf{K}$ and its momentum
# $\mathbf{m}_\mathbf{K}$, while the second entry specifies the structure of
# $\mathbf{C}$ and its momentum $\mathbf{m}_\mathbf{C}$ (see the [paper](TODO
# Insert link to arXiv submission) for details). It is even possible to specify
# $\mathbf{C}$ and its momentum $\mathbf{m}_\mathbf{C}$ (see the
# [paper](http://arxiv.org/abs/2312.05705) for details). It is even possible to specify
# structures on a per-layer basis (see
# [this](https://singd.readthedocs.io/en/latest/generated/gallery/example_03_param_groups/)
# example).
Expand Down
6 changes: 3 additions & 3 deletions singd/optim/optimizer.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
class SINGD(Optimizer):
"""Structured inverse-free natural gradient descent.
The algorithm is introduced in [this paper](TODO Insert arXiv link) and
The algorithm is introduced in [this paper](http://arxiv.org/abs/2312.05705) and
extends the inverse-free KFAC algorithm from [Lin et al. (ICML
2023)](https://arxiv.org/abs/2302.09738) with structured pre-conditioner
matrices.
Expand Down Expand Up @@ -104,8 +104,8 @@ def __init__(
): # noqa: D301
"""Structured inverse-free natural gradient descent optimizer.
Uses the empirical Fisher. See the [paper](TODO Insert arXiv link) for the
notation.
Uses the empirical Fisher. See the [paper](http://arxiv.org/abs/2312.05705) for
the notation.
Args:
model: The neural network whose parameters (or a subset thereof) will be
Expand Down

0 comments on commit a23d368

Please sign in to comment.