Skip to content

docs: Add TRITONBACKEND_ModelInstanceReady documentation #117

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

Merged
pskiran1 merged 1 commit into from
Dec 21, 2025
Merged

docs: Add TRITONBACKEND_ModelInstanceReady documentation #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,12 @@ a given model instance and to manage the user-defined state associated
with the model (for more information see [backend
lifecycles](#backend-lifecycles)).

A backend can optionally implement TRITONBACKEND_ModelInstanceReady. This
function is called by the Triton server's ready endpoint to check whether
a model instance is ready to handle requests. The function returns
`nullptr` (indicating success) if the instance is ready, or a
`TRITONSERVER_Error` if the instance is not ready.

The backend must take into account threading concerns when
implementing TRITONBACKEND_ModelInstanceInitialize,
TRITONBACKEND_ModelInstanceFinalize and
Expand Down
Loading