Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.

Commit

Permalink
Fix moving average args not rendering properly in docs (#5516)
Browse files Browse the repository at this point in the history
* Fix moving average args not rendering properly in docs

* Update changelog

Co-authored-by: Akshita Bhagia <akshita23bhagia@gmail.com>
  • Loading branch information
JohnGiorgi and AkshitaB authored Dec 17, 2021
1 parent 87ad006 commit 3552842
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed

- Fixed the implementation of `PairedPCABiasDirection` in `allennlp.fairness.bias_direction`, where the difference vectors should not be centered when performing the PCA.
- Fixed the docstring of `ExponentialMovingAverage`, which was causing its argument descriptions to render inccorrectly in the docs.

## [v2.7.0](https://github.com/allenai/allennlp/releases/tag/v2.7.0) - 2021-09-01

Expand Down
7 changes: 3 additions & 4 deletions allennlp/training/moving_average.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,9 @@ class ExponentialMovingAverage(MovingAverage):
# Parameters
parameters : `Iterable[Tuple[str, Parameter]]`, required
The parameters whose averages we'll be tracking.
In a typical AllenNLP configuration file, this argument does not get an entry under the
"moving_average", it gets passed in separately.
The parameters whose averages we'll be tracking. In a typical AllenNLP configuration
file, this argument does not get an entry under the "moving_average", it gets passed
in separately.
decay : `float`, optional (default = `0.9999`)
The decay rate that will be used if `num_updates` is not passed
(and that will be used as an upper bound if `num_updates` is passed).
Expand Down

0 comments on commit 3552842

Please sign in to comment.