doc: Add Python Client Examples #395

lgdeloss · 2023-06-09T18:50:46Z

Motivation

There is lack of documentation for how to interface with modelmesh-serving using python sdk

Modifications

Added documentation on how to interface with Python client sdk for modelmesh-serving
Added docs/samples/modelmesh_sdk_sample.ipynb

Result

Works on Add some python client examples to the docs #316

rafvasq

Few more updates. I think there'd be some confusion on the headers and flow of the sample if you read it like a new user. You can probably be a bit more descriptive like "Check InferenceService status after deploying" or " etc.

docs/samples/modelmesh_sdk_sample.ipynb

rafvasq

Thanks @lgdeloss, I think this is a good starting point for samples showing how to manipulate InferenceServices using the Python SDK.

ckadner

Thank you Luis (and Rafael). It's great to finally get a few Python SDK examples.

Should we rename the file to "python_sdk_examples.ipynb" since this entire repo is dedicated to "modelmesh".

I'm not sure if "samples" is the best name for the folder. Samples imply a user can take something and use it with/witout modifications, like a model, a YAML file, a script. This notebook is more like a "how to" guide or tutorial. If we plan more SDK examples in the future maybe the folder should be "sdk" or "python-sdk" or "notebooks" or "examples", if we think we will have more in the future.

I have a few more comments/suggestions.

docs/samples/modelmesh_sdk_sample.ipynb

docs/examples/python_sdk_examples.ipynb

ckadner

This is looking good! Just a few more nit-picks. In some places we could add a bit more text explanations to use this notebook to inform the user about what/why is happening / how ModelMesh/KServe works in the background.

docs/examples/python_sdk_examples.ipynb

ckadner

Thanks @lgdeloss

/lgtm

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

kserve-oss-bot · 2023-07-24T20:23:33Z

New changes are detected. LGTM label has been removed.

kserve-oss-bot · 2023-07-24T20:24:39Z

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by: ckadner, lgdeloss

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

#### Motivation - There is lack of documentation for how to interface with modelmesh-serving using python sdk #### Modifications - Added documentation on how to interface with Python client sdk for modelmesh-serving - Added `docs/samples/modelmesh_sdk_sample.ipynb` #### Result - Works on #316 Signed-off-by: Luis Delossantos <luisgd@ibm.com> (cherry picked from commit 5d71c59)

kserve-oss-bot requested review from ckadner and njhill June 9, 2023 18:50

lgdeloss force-pushed the python-docs branch from abf5441 to cfe0825 Compare June 9, 2023 18:51

lgdeloss changed the title ~~doc: Add Python Client Examples #375~~ doc: Add Python Client Examples Jun 9, 2023

rafvasq self-assigned this Jun 9, 2023

rafvasq self-requested a review June 9, 2023 19:04

rafvasq requested changes Jun 9, 2023

View reviewed changes

rafvasq requested changes Jul 6, 2023

View reviewed changes

docs/samples/modelmesh_sdk_sample.ipynb Outdated Show resolved Hide resolved

docs/samples/modelmesh_sdk_sample.ipynb Outdated Show resolved Hide resolved

lgdeloss force-pushed the python-docs branch from 47e0412 to 1cc9791 Compare July 10, 2023 12:18

rafvasq previously approved these changes Jul 11, 2023

View reviewed changes

rafvasq added this to the v0.11.0 milestone Jul 14, 2023

ckadner requested changes Jul 14, 2023

View reviewed changes

lgdeloss dismissed rafvasq’s stale review via 44fa8ad July 15, 2023 18:52

rafvasq requested changes Jul 19, 2023

View reviewed changes

rafvasq requested changes Jul 20, 2023

View reviewed changes

docs/examples/python_sdk_examples.ipynb Outdated Show resolved Hide resolved

docs/examples/python_sdk_examples.ipynb Outdated Show resolved Hide resolved

docs/examples/python_sdk_examples.ipynb Outdated Show resolved Hide resolved

rafvasq previously approved these changes Jul 20, 2023

View reviewed changes

rafvasq requested a review from ckadner July 20, 2023 16:46

ckadner requested changes Jul 20, 2023

View reviewed changes

docs/examples/python_sdk_examples.ipynb Outdated Show resolved Hide resolved

docs/examples/python_sdk_examples.ipynb Outdated Show resolved Hide resolved

docs/examples/python_sdk_examples.ipynb Show resolved Hide resolved

lgdeloss dismissed rafvasq’s stale review via 25042f2 July 20, 2023 20:00

rafvasq requested a review from ckadner July 24, 2023 16:48

ckadner approved these changes Jul 24, 2023

View reviewed changes

kserve-oss-bot assigned ckadner Jul 24, 2023

kserve-oss-bot added the lgtm label Jul 24, 2023

lgdeloss added 7 commits July 24, 2023 13:23

jupyter notebook for python scripts/docs

7520379

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

changes to notebook

ec6cff7

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

changes to notebook after run

edd3b40

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

changes to notebook after run again

9709abb

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

made changes to notebook

7ce119b

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

adding signoff

da76bec

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

changed from patch to replace

91b267e

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

lgdeloss added 9 commits July 24, 2023 13:23

changes to PR

a9d6116

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

changes to folder name

67ea1b2

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

changes to output view

7fb2168

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

added path to sklearn create

bd0134e

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

changes to headers

600d3e3

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

changes to notebook

5b3b39b

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

changes

d23e8fd

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

changes to notebook

cec3fca

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

changes to notebook

9da163d

Signed-off-by: Luis Delossantos <luisgd@ibm.com>

ckadner force-pushed the python-docs branch from 25042f2 to 9da163d Compare July 24, 2023 20:23

kserve-oss-bot removed the lgtm label Jul 24, 2023

ckadner added lgtm approved labels Jul 24, 2023

kserve-oss-bot merged commit 5d71c59 into kserve:main Jul 24, 2023
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: Add Python Client Examples #395

doc: Add Python Client Examples #395

lgdeloss commented Jun 9, 2023 •

edited

Loading

rafvasq left a comment

rafvasq left a comment

ckadner left a comment

ckadner left a comment •

edited

Loading

ckadner left a comment

kserve-oss-bot commented Jul 24, 2023

kserve-oss-bot commented Jul 24, 2023

doc: Add Python Client Examples #395

doc: Add Python Client Examples #395

Conversation

lgdeloss commented Jun 9, 2023 • edited Loading

Motivation

Modifications

Result

rafvasq left a comment

Choose a reason for hiding this comment

rafvasq left a comment

Choose a reason for hiding this comment

ckadner left a comment

Choose a reason for hiding this comment

ckadner left a comment • edited Loading

Choose a reason for hiding this comment

ckadner left a comment

Choose a reason for hiding this comment

kserve-oss-bot commented Jul 24, 2023

kserve-oss-bot commented Jul 24, 2023

lgdeloss commented Jun 9, 2023 •

edited

Loading

ckadner left a comment •

edited

Loading