Skip to content
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.

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

Some README and response_analysis cleanup #96

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ronakice
Copy link
Member

@ronakice ronakice commented Feb 7, 2024

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:

  • Have you followed the contributing guidelines?
  • Have you verified that there are no existing Pull Requests for the same update/change?
  • Have you updated any relevant documentation or added new tests where needed?

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Documentation content changes
  • Other...
    • Description:

@ronakice ronakice changed the title some README and response_analysis cleanup Some README and response_analysis cleanup 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would this be needed though? Don't we automatically have this on top of README.md from PyPI? Not sure if I understand.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants