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.

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

Add API exports for samplers documented on keras.io #815

Merged
merged 1 commit into from
Mar 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion keras_nlp/samplers/beam_sampler.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
from absl import logging
from tensorflow import keras

from keras_nlp.api_export import keras_nlp_export
from keras_nlp.samplers.sampler import Sampler
from keras_nlp.samplers.sampler import base_sampler_args_docstring
from keras_nlp.samplers.sampler import call_args_docstring
Expand All @@ -26,7 +27,7 @@
@format_docstring(
base_sampler_args=base_sampler_args_docstring, call_args=call_args_docstring
)
@keras.utils.register_keras_serializable(package="keras_nlp")
@keras_nlp_export("keras_nlp.samplers.BeamSampler")
class BeamSampler(Sampler):
"""Beam Sampler class.

Expand Down
4 changes: 2 additions & 2 deletions keras_nlp/samplers/greedy_sampler.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"""Greedy Sampler."""

import tensorflow as tf
from tensorflow import keras

from keras_nlp.api_export import keras_nlp_export
from keras_nlp.samplers.sampler import Sampler
from keras_nlp.samplers.sampler import base_sampler_args_docstring
from keras_nlp.samplers.sampler import call_args_docstring
Expand All @@ -25,7 +25,7 @@
@format_docstring(
base_sampler_args=base_sampler_args_docstring, call_args=call_args_docstring
)
@keras.utils.register_keras_serializable(package="keras_nlp")
@keras_nlp_export("keras_nlp.samplers.GreedySampler")
class GreedySampler(Sampler):
"""Greedy sampler class.

Expand Down
3 changes: 2 additions & 1 deletion keras_nlp/samplers/sampler.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
from tensorflow import keras
from tensorflow.compiler.tf2xla.python.xla import dynamic_update_slice

from keras_nlp.api_export import keras_nlp_export
from keras_nlp.utils.python_utils import format_docstring

base_sampler_args_docstring = """
Expand Down Expand Up @@ -49,7 +50,7 @@
@format_docstring(
base_sampler_args=base_sampler_args_docstring, call_args=call_args_docstring
)
@keras.utils.register_keras_serializable(package="keras_nlp")
@keras_nlp_export("keras_nlp.samplers.Sampler")
class Sampler:
"""Base sampler class.

Expand Down
4 changes: 2 additions & 2 deletions keras_nlp/samplers/top_k_sampler.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"""Top-k Sampler."""

import tensorflow as tf
from tensorflow import keras

from keras_nlp.api_export import keras_nlp_export
from keras_nlp.samplers.sampler import Sampler
from keras_nlp.samplers.sampler import base_sampler_args_docstring
from keras_nlp.samplers.sampler import call_args_docstring
Expand All @@ -25,7 +25,7 @@
@format_docstring(
base_sampler_args=base_sampler_args_docstring, call_args=call_args_docstring
)
@keras.utils.register_keras_serializable(package="keras_nlp")
@keras_nlp_export("keras_nlp.samplers.TopKSampler")
class TopKSampler(Sampler):
"""Top-K Sampler class.

Expand Down
4 changes: 2 additions & 2 deletions keras_nlp/samplers/top_p_sampler.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"""Top-p Sampler."""

import tensorflow as tf
from tensorflow import keras

from keras_nlp.api_export import keras_nlp_export
from keras_nlp.samplers.sampler import Sampler
from keras_nlp.samplers.sampler import base_sampler_args_docstring
from keras_nlp.samplers.sampler import call_args_docstring
Expand All @@ -25,7 +25,7 @@
@format_docstring(
base_sampler_args=base_sampler_args_docstring, call_args=call_args_docstring
)
@keras.utils.register_keras_serializable(package="keras_nlp")
@keras_nlp_export("keras_nlp.samplers.TopPSampler")
class TopPSampler(Sampler):
"""Top-P Sampler class.

Expand Down