Added a more clear explanation of PaperQA2 #361
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
jamesbraza
reviewed
Sep 11, 2024
README.md
Outdated
| ## What's New? | ||
| ## PaperQA2 vs PaperQA | ||
|
|
||
| We've been working on hard on engineering it for a while and tried to follow [SemVer](https://semver.org/), meaning we're on version 5. However, we wanted to remark on the fact though that we've exceeded human performance on [many important metrics](https://paper.wikicrow.ai). So we arbitrarily call versions after v5 PaperQA2 and versions before it as PaperQA1 to denote the significant change in performance. We recognize that we are challenged at naming and counting at FutureHouse, so we reserve the right at any time to arbitrarily change the name to PaperCrow. |
There was a problem hiding this comment.
tried to follow SemVer, meaning we're on version 5
Imo following SemVer doesn't mean we are necessarily on version 5. This part could use a reword
There was a problem hiding this comment.
@jamesbraza - agree and took another pass at this
|
Note to self: should also acknowledge tantivy in readme |
mskarlin
approved these changes
Sep 11, 2024
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.
Announcing
PaperCrowPaperQAv5PaperQA2CorePaperQA2!