Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Min kl weight only for pyro #1269

Merged
merged 2 commits into from
Nov 19, 2021
Merged

Min kl weight only for pyro #1269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d346cb
min kl weight only for pyro
justjhong Nov 19, 2021
d26ed43
new release note
justjhong Nov 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/release_notes/v0.14.5.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
New in 0.14.5
-------------

Bug fixes.

Changes
~~~~~~~
- Fix `kl_weight` floor for Pytorch-based models (`#1269`_).

Contributors
~~~~~~~~~~~~
- `@adamgayoso`_
- `@jjhong922`_
- `@watiss`_

.. _`@adamgayoso`: https://github.com/adamgayoso
.. _`@jjhong922`: https://github.com/jjhong922
.. _`@watiss`: https://github.com/watiss

.. _`#1269` : https://github.com/YosefLab/scvi-tools/pull/1269
6 changes: 5 additions & 1 deletion scvi/train/_trainingplans.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ def _compute_kl_weight(
step: int,
n_epochs_kl_warmup: Optional[int],
n_steps_kl_warmup: Optional[int],
min_weight: Optional[float] = None,
) -> float:
epoch_criterion = n_epochs_kl_warmup is not None
step_criterion = n_steps_kl_warmup is not None
Expand All @@ -28,7 +29,9 @@ def _compute_kl_weight(
kl_weight = min(1.0, step / n_steps_kl_warmup)
else:
kl_weight = 1.0
return max(kl_weight, 1e-3)
if min_weight is not None:
kl_weight = max(kl_weight, min_weight)
return kl_weight


class TrainingPlan(pl.LightningModule):
Expand Down Expand Up @@ -734,6 +737,7 @@ def kl_weight(self):
self.global_step,
self.n_epochs_kl_warmup,
self.n_steps_kl_warmup,
min_weight=1e-3,
)


Expand Down