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.

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

Add documentation for Model Serving #93

Merged
merged 20 commits into from
May 13, 2022

Conversation

javierdlrm
Copy link
Collaborator

No description provided.

@javierdlrm javierdlrm requested a review from robzor92 May 4, 2022 16:22
Copy link

@jimdowling jimdowling left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I was mostly confused about model serving vs deployment vs model serving infrastructure. I think you were consistent, so you might want to ignore a few of the suggestions at the beginning of my review with changing model serving to deployments.

README.md Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/integrations/python.md Outdated Show resolved Hide resolved
docs/model-registry/quickstart.md Outdated Show resolved Hide resolved
docs/model-serving/quickstart.md Outdated Show resolved Hide resolved
docs/templates/model-serving/project.md Outdated Show resolved Hide resolved
docs/templates/model-serving/project.md Outdated Show resolved Hide resolved
docs/templates/model-serving/transformer.md Outdated Show resolved Hide resolved
docs/templates/model-serving/transformer.md Outdated Show resolved Hide resolved
python/hsml/inference_logger.py Show resolved Hide resolved
Copy link
Collaborator

@robzor92 robzor92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general there are a few broken links, especially in the model registry part which I think happened after the refactoring of the structure. Also the API reference is missing information about creation. We should follow a similar structure as https://docs.hopsworks.ai/hopsworks-api/2.6.0-SNAPSHOT/generated/api/jobs/ when it comes to creating an object like a deployment. So first a "Handle" section to get the ModelServing object, and then a "Creation" section for what operation is done to create a deployment. So model.deploy() or ms.create_deployment()

docs/index.md Show resolved Hide resolved
docs/integrations/python.md Outdated Show resolved Hide resolved
docs/integrations/python.md Outdated Show resolved Hide resolved
docs/integrations/python.md Show resolved Hide resolved
docs/integrations/setup.md Outdated Show resolved Hide resolved
docs/templates/model-serving/predictor_api.md Show resolved Hide resolved
docs/templates/model-serving/resources_api.md Show resolved Hide resolved
python/hsml/connection.py Outdated Show resolved Hide resolved
docs/templates/model-serving/predictor.md Outdated Show resolved Hide resolved
docs/templates/model-serving/predictor.md Outdated Show resolved Hide resolved
docs/templates/model-serving/predictor.md Outdated Show resolved Hide resolved
docs/templates/model-serving/predictor.md Outdated Show resolved Hide resolved
docs/templates/model-serving/predictor.md Outdated Show resolved Hide resolved
docs/templates/model-serving/predictor.md Outdated Show resolved Hide resolved
docs/templates/model-serving/predictor.md Outdated Show resolved Hide resolved
docs/templates/model-serving/predictor.md Outdated Show resolved Hide resolved
python/hsml/resources.py Outdated Show resolved Hide resolved
@javierdlrm javierdlrm requested a review from robzor92 May 12, 2022 10:09
javierdlrm and others added 20 commits May 13, 2022 10:58
Co-authored-by: Robin Andersson <robin.eric.andersson@gmail.com>
Co-authored-by: Robin Andersson <robin.eric.andersson@gmail.com>
Co-authored-by: Robin Andersson <robin.eric.andersson@gmail.com>
Co-authored-by: Robin Andersson <robin.eric.andersson@gmail.com>
Co-authored-by: Robin Andersson <robin.eric.andersson@gmail.com>
Co-authored-by: Robin Andersson <robin.eric.andersson@gmail.com>
Co-authored-by: Robin Andersson <robin.eric.andersson@gmail.com>
Co-authored-by: Robin Andersson <robin.eric.andersson@gmail.com>
Co-authored-by: Robin Andersson <robin.eric.andersson@gmail.com>
Co-authored-by: Robin Andersson <robin.eric.andersson@gmail.com>
@javierdlrm javierdlrm merged commit a492e49 into logicalclocks:main May 13, 2022
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.

None yet

3 participants