-
Notifications
You must be signed in to change notification settings - Fork 32
Add benchmarks endpoint support #43
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
Conversation
@xiaohua-scale can you please send a PRD or something like a PRD over api-reviews@scaleapi.com before we get too far? |
As discussed in the email thread. We want to launch this API for self-serve customers first since we have a full-blown UI for self-serve customers to manage the benchmarks. |
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.
2 minor spelling things and a comment to address, but otherwise this looks good to me. Approved.
scaleapi/__init__.py
Outdated
**kwargs, | ||
) -> Benchmark: | ||
"""This method can only be used for Self-Serve projects. | ||
Supported Task Type: [ |
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.
spelling - task types
scaleapi/__init__.py
Outdated
Task type to be created | ||
i.e. `TaskType.ImageAnnotation` | ||
**kwargs: | ||
Passing in the applicable values into thefunction |
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.
Missing a space in thefunction
@xiaohua-scale @shaun-scale If we're not adding it to the API docs, should we also skip SDK Readme? Otherwise, it would be good to document it under Readme with an example, with disclaimers for Self-Serve customers. |
@xiaohua-scale Could you please add a new test case for the new |
I think we're good to add it to the SDK Readme - and candidly, I think I want this in our docs with the same disclaimer - people at least know about it then and have one consistent place to access our API. @xiaohua-scale how against adding this to our docs are you? |
I can add this to Scale doc and SDK readme and just make it clear that this is for self-serve only then. |
TODO: |
Summary
Support benchmark creation API for self-serve projects.
E2E Test:
Next
project
andexpected_response
, and one more optional param:initial_response
.