Skip to content

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

Merged
merged 9 commits into from
Aug 18, 2021
Merged

Conversation

xiaohua-scale
Copy link
Contributor

@xiaohua-scale xiaohua-scale commented Jul 9, 2021

Summary

Support benchmark creation API for self-serve projects.

E2E Test:

API request UI on selfserve

Next

  • Update the self-serve API demo to demonstrate the usage: https://colab.research.google.com/drive/1XZjbVtA2oGOdMp0-v0E80ujMB8tbeh7x?usp=sharing
  • I'm not going to update the public API doc on scale.com just yet since this is for self-serve projects only at this point. Customers should refer to the API demo for the usage.
  • Essentially this API is very similar to the task creation API, except that we have 2 more required params: project and expected_response, and one more optional param: initial_response.

@shaun-scale
Copy link
Contributor

@xiaohua-scale can you please send a PRD or something like a PRD over api-reviews@scaleapi.com before we get too far?

@xiaohua-scale xiaohua-scale marked this pull request as ready for review July 13, 2021 07:15
@xiaohua-scale
Copy link
Contributor Author

xiaohua-scale commented Jul 13, 2021

@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.

Screen Shot 2021-07-13 at 12 21 45 AM

Screen Shot 2021-07-13 at 12 21 54 AM

Screen Shot 2021-07-13 at 12 22 02 AM

Copy link
Contributor

@shaun-scale shaun-scale left a 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.

**kwargs,
) -> Benchmark:
"""This method can only be used for Self-Serve projects.
Supported Task Type: [
Copy link
Contributor

Choose a reason for hiding this comment

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

spelling - task types

Task type to be created
i.e. `TaskType.ImageAnnotation`
**kwargs:
Passing in the applicable values into thefunction
Copy link
Contributor

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

@fatihkurtoglu
Copy link
Contributor

@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.

@fatihkurtoglu
Copy link
Contributor

@xiaohua-scale Could you please add a new test case for the new create_benchmark method under tests/test_client.py?

@shaun-scale
Copy link
Contributor

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.

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?

@xiaohua-scale
Copy link
Contributor Author

xiaohua-scale commented Jul 13, 2021

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.

@xiaohua-scale
Copy link
Contributor Author

TODO: benchmark endpoint is going to be renamed. Will update the PR later.

@xiaohua-scale xiaohua-scale merged commit 3748514 into master Aug 18, 2021
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.

4 participants