Update interface.md #1982
Merged
Update interface.md #1982
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
update interface to remove link to really outdated commit of evaluator.py
johnwee1
requested review from
haileyschoelkopf and
lintangsutawika
as code owners
LSinev
reviewed
Jun 18, 2024
haileyschoelkopf
approved these changes
Jun 25, 2024
xksteven
pushed a commit
to xksteven/lm-evaluation-harness
that referenced
this pull request
Jun 26, 2024
* Update interface.md update interface to remove link to really outdated commit of evaluator.py * switch to relative referencing? * Update interface.md --------- Co-authored-by: Hailey Schoelkopf <[email protected]>
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.
Could be just a me thing, but I found it pretty confusing that the interface doc was linking to a really outdated version of the evaluator.py file. I was looking for references to the newer keywords like
--apply_chat_templateand--system_instructionthat were somehow not there.I understand the intent of the older commit probably was to quickly link to an example of
simple_evaluate()but it was hardly helpful for me in understanding the codebase, and I think its just better to have a link to the actual updated file instead of an outdated version.There is a way to link exactly to the function through this hacky way https://github.com/EleutherAI/lm-evaluation-harness/blob/main/lm_eval/evaluator.py#:~:text=simple_evaluate but it doesnt work on all browsers.
welcome any suggestions, and of course feel free to reject this pr. thanks.