Some README and response_analysis cleanup #96
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
ronakice
changed the title
sahel-sh
reviewed
Feb 7, 2024
| @@ -9,9 +9,6 @@ | |||
|
|
|||
| We offer a suite of prompt decoders, albeit with a current focus on RankVicuna. Some of the code in this repository is borrowed from [RankGPT](https://github.com/sunnweiwei/RankGPT)! | |||
|
|
|||
| # Releases | |||
| current_version = 0.2.6 | |||
There was a problem hiding this comment.
Please add a section for the package installation and keep the version there
I use bumper to auto increase this every time I release a version
There was a problem hiding this comment.
Why would this be needed though? Don't we automatically have this on top of README.md from PyPI? Not sure if I understand.
There was a problem hiding this comment.
We do, but it is still nice to have this in the readme too, next to package installation or maybe under a release section to keep the log of release and features for each release or something like that.
| responses, num_passages = response_analyzer.read_saved_responses() | ||
| print("Normalized scores:") | ||
|
|
||
| print(response_analyzer.count_errors(responses, num_passages, args.verbose)) |
There was a problem hiding this comment.
I added an boolean to count_errors for normalization, that is false by default, pleasee add an extra arg for that
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.
Pull Request Checklist
Reference Issue
Please provide the reference to issue this PR is addressing (# followed by the issue number). If there is no associated issue, write "N/A".
ref: N/A
Checklist Items
Before submitting your pull request, please review these items:
PR Type
What kind of change does this PR introduce?