-
Notifications
You must be signed in to change notification settings - Fork 834
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
fix(docs): Change V2 Inference Protocol to OIP #5297
Conversation
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.
LGTM aside from the 1 comment.
- Health endpoints, to assess liveness and readiness of your model. | ||
- Inference endpoints, to interact with your model. | ||
- Metadata endpoints, to query your model metadata (e.g. expected inputs, expected | ||
- Assess liveness and readiness of your model. | ||
- Interact with your model. | ||
- Query your model metadata (e.g. expected inputs, expected |
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.
thought: I think these changes make them more vague as to what the endpoints are about. I'd keep the "sections" (Health, Inference, and Metadata).
KServe uses them as "sections" too, e.g. https://kserve.github.io/website/0.10/modelserving/data_plane/v2_protocol/#inference.
Perhaps instead it could be changed to be something like:
- Inference: Interact with your model
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.
Yea it was more of a grammar thing that bothered me initially, but have updated to add categories back in
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.
I thought it may have been the grammar! That comma was a bit ugly. Thank you for adding the sections back. My last comment on it would be that for an inference protocol, we now don't mention inference at all in the partial list of endpoints 😅
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.
LGTM
What this PR does / why we need it: Change reference from V2 Inference Protocol to OIP