Files
pytorch/torch/distributions/log_normal.py
Maggie Moss b13cd141b3 Add pyrefly suppressions (#164748)
Adds suppressions to pyrefly will typecheck clean: https://github.com/pytorch/pytorch/issues/163283

Test plan:
dmypy restart && python3 scripts/lintrunner.py -a
pyrefly check

step 1: delete lines in the pyrefly.toml file from the `project-excludes` field
step 2: run pyrefly check
step 3: add suppressions, clean up unused suppressions
before: https://gist.github.com/maggiemoss/4b3bf2037014e116bc00706a16aef199

after:

0 errors (4,263 ignored)

Pull Request resolved: https://github.com/pytorch/pytorch/pull/164748
Approved by: https://github.com/oulgen
2025-10-07 17:31:18 +00:00

77 lines
2.2 KiB
Python

# mypy: allow-untyped-defs
from typing import Optional, Union
from torch import Tensor
from torch.distributions import constraints
from torch.distributions.normal import Normal
from torch.distributions.transformed_distribution import TransformedDistribution
from torch.distributions.transforms import ExpTransform
__all__ = ["LogNormal"]
class LogNormal(TransformedDistribution):
r"""
Creates a log-normal distribution parameterized by
:attr:`loc` and :attr:`scale` where::
X ~ Normal(loc, scale)
Y = exp(X) ~ LogNormal(loc, scale)
Example::
>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> m = LogNormal(torch.tensor([0.0]), torch.tensor([1.0]))
>>> m.sample() # log-normal distributed with mean=0 and stddev=1
tensor([ 0.1046])
Args:
loc (float or Tensor): mean of log of distribution
scale (float or Tensor): standard deviation of log of the distribution
"""
arg_constraints = {"loc": constraints.real, "scale": constraints.positive}
# pyrefly: ignore # bad-override
support = constraints.positive
has_rsample = True
# pyrefly: ignore # bad-override
base_dist: Normal
def __init__(
self,
loc: Union[Tensor, float],
scale: Union[Tensor, float],
validate_args: Optional[bool] = None,
) -> None:
base_dist = Normal(loc, scale, validate_args=validate_args)
super().__init__(base_dist, ExpTransform(), validate_args=validate_args)
def expand(self, batch_shape, _instance=None):
new = self._get_checked_instance(LogNormal, _instance)
return super().expand(batch_shape, _instance=new)
@property
def loc(self) -> Tensor:
return self.base_dist.loc
@property
def scale(self) -> Tensor:
return self.base_dist.scale
@property
def mean(self) -> Tensor:
return (self.loc + self.scale.pow(2) / 2).exp()
@property
def mode(self) -> Tensor:
return (self.loc - self.scale.square()).exp()
@property
def variance(self) -> Tensor:
scale_sq = self.scale.pow(2)
return scale_sq.expm1() * (2 * self.loc + scale_sq).exp()
def entropy(self):
return self.base_dist.entropy() + self.loc