Update our sampler documentation to reflect usage #1444
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattdangerw
force-pushed
the
sampler-doc-update
branch
from
f36b50c to
8be3bb2
Compare
SamanehSaadat
approved these changes
Feb 20, 2024
keras_nlp/samplers/greedy_sampler.py
Outdated
|
|
||
| # Pass by object to compile. | ||
| sampler = keras_nlp.samplers.GreedySampler() | ||
| causal_lm.compile(sampler=keras_nlp.samplers.GreedySampler()) |
There was a problem hiding this comment.
Should this be sampler=sampler like examples?
SamanehSaadat
approved these changes
Feb 20, 2024
We will update our samplers in the near future to push the backend specific compilation details out: keras-team#1425 Also in general, we want our documentation to reflect the main usage of our classes, which is using them with Seq2SeqLM and CausalLM classes. So with that in mind, this updates our sampler docs to show the practical usage of the sampling classes with our modeling classes. For the base class, we show the main use case of overriding the `get_next_token()` function.
mattdangerw
force-pushed
the
sampler-doc-update
branch
from
8be3bb2 to
80fcad9
Compare
abuelnasr0
pushed a commit
to abuelnasr0/keras-nlp
that referenced
this pull request
Apr 2, 2024
We will update our samplers in the near future to push the backend specific compilation details out: keras-team#1425 Also in general, we want our documentation to reflect the main usage of our classes, which is using them with Seq2SeqLM and CausalLM classes. So with that in mind, this updates our sampler docs to show the practical usage of the sampling classes with our modeling classes. For the base class, we show the main use case of overriding the `get_next_token()` function.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We will update our samplers in the near future to push the backend specific compilation details out: #1425
Also in general, we want our documentation to reflect the main usage of our classes, which is using them with Seq2SeqLM and CausalLM classes.
So with that in mind, this updates our sampler docs to show the practical usage of the sampling classes with our modeling classes. For the base class, we show the main use case of overriding the
get_next_token()function.