Skip to content

[Typing][B-28] Add type annotations for python/paddle/distribution/uniform.py #65660

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

Merged
SigureMo merged 4 commits into from
Jul 4, 2024
Merged

[Typing][B-28] Add type annotations for python/paddle/distribution/uniform.py #65660

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5210ad4
update typing
NKNaN Jul 3, 2024
cbff1df
update
NKNaN Jul 3, 2024
aa25584
Update python/paddle/distribution/uniform.py
NKNaN Jul 3, 2024
868ca0c
update class attr
NKNaN Jul 3, 2024
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
36 changes: 30 additions & 6 deletions python/paddle/distribution/uniform.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,12 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations

from typing import TYPE_CHECKING, Sequence

import numpy as np
import numpy.typing as npt

import paddle
from paddle import _C_ops
Expand All @@ -22,6 +26,9 @@
from paddle.framework import in_dynamic_mode
from paddle.tensor import random

if TYPE_CHECKING:
from paddle import Tensor


class Uniform(distribution.Distribution):
r"""Uniform distribution with `low` and `high` parameters.
Expand Down Expand Up @@ -99,8 +106,25 @@ class Uniform(distribution.Distribution):
Tensor(shape=[1], dtype=float32, place=Place(cpu), stop_gradient=True,
[0.50000000])
"""

@SigureMo SigureMo Jul 3, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

是否有公开的类属性可以标注下呢？

@NKNaN NKNaN Jul 3, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

就像 paddle.distribution.Beta 那样给 Uniform 的类属性加个 low 和 high 吗？

@SigureMo SigureMo Jul 3, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

嗯嗯～


def __init__(self, low, high, name=None):
low: Tensor
high: Tensor

def __init__(
self,
low: (
float
| Sequence[float]
| npt.NDArray[np.float32 | np.float64]
| Tensor
),
high: (
float
| Sequence[float]
| npt.NDArray[np.float32 | np.float64]
| Tensor
),
name: str | None = None,
) -> None:
if not in_dynamic_mode():
check_type(
low,
Expand Down Expand Up @@ -165,7 +189,7 @@ def __init__(self, low, high, name=None):

super().__init__(self.low.shape)

def sample(self, shape, seed=0):
def sample(self, shape: list[int], seed: int = 0) -> Tensor:
"""Generate samples of the specified shape.

Args:
Expand Down Expand Up @@ -218,7 +242,7 @@ def sample(self, shape, seed=0):
else:
return output

def log_prob(self, value):
def log_prob(self, value: Tensor) -> Tensor:
"""Log probability density/mass function.

Args:
Expand Down Expand Up @@ -247,7 +271,7 @@ def log_prob(self, value):
paddle.log(lb * ub), paddle.log(self.high - self.low), name=name
)

def probs(self, value):
def probs(self, value: Tensor) -> Tensor:
"""Probability density/mass function.

Args:
Expand All @@ -272,7 +296,7 @@ def probs(self, value):
ub = paddle.cast(ub_bool, dtype=value.dtype)
return paddle.divide((lb * ub), (self.high - self.low), name=name)

def entropy(self):
def entropy(self) -> Tensor:
r"""Shannon entropy in nats.

The entropy is
Expand Down