Skip to content

Add runtime deprecation warnings to one_hot and multinomial #865

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

Open
t-suraj21 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add runtime deprecation warnings to one_hot and multinomial #865

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
12 changes: 12 additions & 0 deletions haiku/_src/basic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
from collections.abc import Callable, Iterable, Sequence
import functools
from typing import Any
import warnings
from haiku._src import base
from haiku._src import initializers
from haiku._src import module
Expand Down Expand Up @@ -53,6 +54,12 @@ def one_hot(x, num_classes, dtype=jnp.float32):
The one-hot tensor. If indices' shape is [A, B, ...], shape is
[A, B, ... num_classes].
"""
warnings.warn(
"hk.one_hot is deprecated. Use jax.nn.one_hot(x, num_classes).astype(dtype) "
"instead.",
DeprecationWarning,
stacklevel=2
)
return jax.nn.one_hot(x, num_classes).astype(dtype)


Expand All @@ -69,6 +76,11 @@ def multinomial(rng, logits, num_samples):
Returns:
Chosen categories, of shape ``logits.shape[:-1] + (num_samples,)``.
"""
warnings.warn(
"hk.multinomial is deprecated. Use jax.random.categorical instead.",
DeprecationWarning,
stacklevel=2
)
if num_samples != 1:
shape = (num_samples,) + logits.shape[:-1]
else:
Expand Down