-
Notifications
You must be signed in to change notification settings - Fork 8
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
feat: Support result upload for XL benchmarks #225
Merged
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
jstlaurent
added
the
feature
Annotates any PR that adds new features; Used in the release process
label
Nov 30, 2024
jstlaurent
requested review from
Andrewq11,
kunkunzhu,
mercuryseries and
zhu0619
November 30, 2024 02:44
cwognum
approved these changes
Dec 1, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @jstlaurent! 🙏
jstlaurent
force-pushed
the
feat/xl-results
branch
from
December 3, 2024 02:08
4134544
to
0cc2494
Compare
mercuryseries
approved these changes
Dec 4, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, @jstlaurent! Thanks.
jstlaurent
force-pushed
the
feat/xl-results
branch
from
December 4, 2024 20:32
0cc2494
to
9bcfaf5
Compare
Co-authored-by: Honoré Hounwanou <mercuryseries@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
enhancement
New feature or request
feature
Annotates any PR that adds new features; Used in the release process
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.
Changelogs
upload_results
client method to us the new V2 API endpoint in the HubLinked issues
Checklist:
Add tests to cover the fixed bug(s) or the newly introduced feature(s) (if appropriate).Update the API documentation if a new function is added, or an existing one is deleted.feature
,fix
,chore
,documentation
ortest
(or ask a maintainer to do it for you).This PR updates the client to use the new V2 API endpoint for results. This will enable uploading supports for the upcoming V2 Benchmarks. Due to the nature of the result model in the client, which holds
their related benchmark identitifer but not an object reference, the same endpoint must accomodate both V1 and V2 benchmarks.
I also took the opportunity to tighten the typing in some Pydantic models. We had initially typed our models liberally, to show what could be accepted as inputs. While this still holds, the reality is that
our models normalized these input values to one representation. The updated model typing represents that normalized representation.
The new V2 result endpoint also now returns a Content-Location response header, which will provide the URL of the result on the
Hub. To leverage this, I exposed the full response object to the calling functions, instead of only the JSON body.