Skip to content

Commit

Permalink
add model ready
Browse files Browse the repository at this point in the history
Signed-off-by: agriffith50 <[email protected]>
  • Loading branch information
alexagriffith committed Jan 10, 2023
1 parent 4727256 commit eaa24bf
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/modelserving/data_plane/data_plane.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ KServe supports two versions of its data plane, V1 and V2. V1 protocol offers a
| Server Readiness | GET | v2/health/ready |
| Server Liveness | GET | v2/health/live |
| Server Metadata | GET | v2 |
<!-- TODO: uncomment when implemented | Model Readiness| GET | v2/models/\<model_name\>[/versions/<model_version>]/ready | -->
| Model Readiness| GET | v2/models/\<model_name\>[/versions/<model_version>]/ready |

** path contents in `[]` are optional

Expand Down
11 changes: 7 additions & 4 deletions docs/modelserving/data_plane/v2_protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ See also: The HTTP/REST endpoints are defined in [rest_predict_v2.yaml](https://
| Server Ready | GET | v2/health/ready | | [$ready_server_response](#server-ready-response-json-object) |
| Server Live | GET | v2/health/live | | [$live_server_response](#server-live-response-json-objet)|
| Server Metadata | GET | v2 | | [$metadata_server_response](#server-metadata-response-json-object) |
<!-- TODO: uncomment when implemented | Model Ready| GET | | | -->
| Model Ready| GET | v2/models/\<model_name\>[/versions/<model_version>]/ready | | [$ready_model_response](#model-ready-response-json-object) |

** path contents in `[]` are optional

Expand Down Expand Up @@ -58,15 +58,18 @@ Kubernetes documentation.

### **Payload Contents**

<!-- TODO: uncomment when implemented ### **Model Ready**
### **Model Ready**

The model ready endpoint returns the readiness probe response for the server along with the name of the model.

$ready_server_response =
#### Model Ready Response JSON Object


$ready_model_response =
{
"name" : $string,
"ready": $bool
} -->
}


### Server Ready
Expand Down

0 comments on commit eaa24bf

Please sign in to comment.