Skip to content
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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 8, 2024
Merged

fix(docs): Change V2 Inference Protocol to OIP #5297

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0327441
Update v2-protocol.md
paulb-seldon Feb 8, 2024
8a594bb
Add back endpoint categories for clarity
paulb-seldon Feb 8, 2024
7984dee
Grammar
paulb-seldon Feb 8, 2024
fd5c0ab
Add model inference under endpoints
paulb-seldon Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions doc/source/reference/apis/v2-protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# V2 Inference Protocol
# Open Inference Protocol

The V2 Inference Protocol is an industry-wide effort to provide an standardised
The Open Inference Protocol is an industry-wide effort to provide a standardized
protocol to communicate with different inference servers (e.g. MLServer,
Triton, etc.) and orchestrating frameworks (e.g. Seldon Core, KServe, etc.).
The spec of the V2 Inference Protocol defines both the endpoints and payload
The spec of the Open Inference Protocol defines both the endpoints and payload
schemas for REST and gRPC interfaces.

As part of the V2 Protocol definition, you can find dedicated endpoints for:
As part of the Open Inference Protocol definition, you can find dedicated endpoints to:

- 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
outputs, etc.).
Copy link
Contributor

@jesse-c jesse-c Feb 8, 2024 •
edited
Loading

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

Copy link
Contributor Author

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

Copy link
Contributor

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 😅

- Model repository endpoints, to load and unload models dynamically.
- Load and unload models dynamically.


## REST
Expand Down
Loading