Skip to content

Update docstrings for relocated sampler arg #964

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
merged 2 commits into from
Apr 6, 2023
Merged

Update docstrings for relocated sampler arg #964

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb2c1d0
Update docstrings to relocated `sampler` arg
jbischof Apr 6, 2023
d65b55f
format
jbischof Apr 6, 2023
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
8 changes: 3 additions & 5 deletions keras_nlp/models/gpt2/gpt2_causal_lm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ class GPT2CausalLM(Task):
gpt2_lm.generate("I want to say", max_length=30)

gpt2_lm.compile(sampler=keras_nlp.samplers.BeamSampler(num_beams=2))
gpt2_lm.generate("I want to say", max_length=30, sampler=sampler)
gpt2_lm.generate("I want to say", max_length=30)
```

Map raw string to languages model logit predictions.
Expand Down Expand Up @@ -331,15 +331,13 @@ def generate(

This method generates text based on given `prompt`. Generation will
continue until `max_length` is met, and all tokens generated after
`end_token` will be truncated. The sampling approach used can be
controlled via the sampler argument.
`end_token` will be truncated. The sampling strategy can be set in
the `compile` method.

Args:
prompt: a string, string Tensor or string RaggedTensor. The prompt
text for generation.
max_length: int. The max length of generated sequence.
sampler: a string or `keras_nlp.samplers.Sampler` instance. The
sampler to be used for text generation.
"""
if self.preprocessor is None:
raise ValueError(
Expand Down