Update Mirostat sampler function parameters #15885
Open
+3
−3
Conversation
This file contains hidden or 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
corrected parameters description in docs
There was a problem hiding this comment.
Pull Request Overview
This PR corrects the parameter documentation for Mirostat sampler functions in the header file. The changes align the documentation comments with the actual function signatures.
Key changes:
- Updated Mirostat 1.0 parameter documentation to match function signature
- Updated Mirostat 2.0 parameter documentation to match function signature
- Removed outdated parameter descriptions and added missing ones
|
|
||
| /// @details Mirostat 2.0 algorithm described in the paper https://arxiv.org/abs/2007.14966. Uses tokens instead of words. | ||
| /// @param seed The sampler seed | ||
| /// @param candidates A vector of `llama_token_data` containing the candidate tokens, their probabilities (p), and log-odds (logit) for the current position in the generated text. |
There was a problem hiding this comment.
The @param candidates documentation doesn't match the function signature for llama_sampler_init_mirostat_v2. Looking at the function signature on lines 1206-1208, there is no 'candidates' parameter. This documentation line should be removed.
Suggested change
| /// @param candidates A vector of `llama_token_data` containing the candidate tokens, their probabilities (p), and log-odds (logit) for the current position in the generated text. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
corrected parameters description in docs
To the best of my understanding of the parameters.