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

Updated doc_string for SineBivariateVonMises. #2961

Merged
merged 1 commit into from
Nov 5, 2021
Merged

Updated doc_string for SineBivariateVonMises. #2961

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions pyro/distributions/sine_bivariate_von_mises.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ class SineBivariateVonMises(TorchDistribution):

\frac{\rho}{\kappa_1\kappa_2} \rightarrow 1

because the distribution becomes increasingly bimodal.
because the distribution becomes increasingly bimodal. To avoid bimodality use the `weighted_correlation`
parameter with a skew away from one (e.g., Beta(1,3)). The `weighted_correlation` should be in [0,1].

.. note:: The correlation and weighted_correlation params are mutually exclusive.

Expand All @@ -64,7 +65,7 @@ class SineBivariateVonMises(TorchDistribution):
:param torch.Tensor psi_concentration: concentration of second angle
:param torch.Tensor correlation: correlation between the two angles
:param torch.Tensor weighted_correlation: set correlation to weigthed_corr * sqrt(phi_conc*psi_conc)
to avoid bimodality (see note).
to avoid bimodality (see note). The `weightd_correlation` should be in [0,1].
"""

arg_constraints = {
Expand Down