Skip to content

docs: clarify custom predictor protocol settings - #709

Open
euisuh wants to merge 2 commits into
kserve:mainfrom
euisuh:docs/custom-model-protocol-3009
Open

docs: clarify custom predictor protocol settings#709
euisuh wants to merge 2 commits into
kserve:mainfrom
euisuh:docs/custom-model-protocol-3009

Conversation

@euisuh

@euisuh euisuh commented Jul 24, 2026

Copy link
Copy Markdown

Addresses kserve/kserve#3009

Proposed Changes

  • Clarify that custom Python ModelServer registers both REST v1 and REST v2 routes.
  • Document that request paths and handler payload types determine whether custom predictors use v1 or v2.
  • Clarify that --predictor_protocol and deprecated --protocol are for transformer-to-predictor calls, not for selecting exposed custom predictor routes.
  • Remove the misleading PROTOCOL environment variable guidance from the custom predictor docs.

Validation

  • git diff --check passed.
  • Verified the documented claims against KServe source:
    • RESTServer registers both v1 and v2 endpoints.
    • --protocol is a deprecated alias for --predictor_protocol.
    • v2 REST inference is registered at /v2/models/{model_name}/infer.
  • Checked the updated document text and confirmed the old PROTOCOL bullet is absent.

Notes:

  • npm run typecheck currently fails on existing src/components/QuickInstallCommand.tsx React typing errors unrelated to this Markdown change.
  • npm run build currently fails in the local environment on Mermaid dependency resolution (@mermaid-js/parser), also unrelated to this Markdown change.

AI assistance was used to prepare this documentation change; I reviewed the changed lines and verified them against the KServe source.

@netlify

netlify Bot commented Jul 24, 2026

Copy link
Copy Markdown

Deploy Preview for elastic-nobel-0aef7a ready!

Name Link
🔨 Latest commit 94666ae
🔍 Latest deploy log https://app.netlify.com/projects/elastic-nobel-0aef7a/deploys/6a62bc92e17cc70008a07d0e
😎 Deploy Preview https://deploy-preview-709--elastic-nobel-0aef7a.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Explain how REST v1/v2 routes are selected for custom predictors and clarify that predictor protocol args are for transformer-to-predictor calls.

Co-authored-by: Hermes Agent <noreply@nousresearch.com>
Signed-off-by: euisuh <euisuh.jeong@gmail.com>
@euisuh
euisuh force-pushed the docs/custom-model-protocol-3009 branch from 45b4023 to a34e89c Compare July 24, 2026 01:05
Avoid overstating the scope of predictor protocol arguments while keeping the route-selection clarification.

Co-authored-by: Hermes Agent <noreply@nousresearch.com>
Signed-off-by: euisuh <euisuh.jeong@gmail.com>
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.

1 participant