Add dev quick start guide #16
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Angel Luu <[email protected]>
Signed-off-by: Angel Luu <[email protected]>
docs/quickstart.md
Outdated
|
|
||
| ## Build and start a runtime server with sample_lib | ||
|
|
||
| Run the `start_runtime_with_sample_lib` python script: |
Contributor
There was a problem hiding this comment.
Is it worth duplicating the information that we have in the Caikit examples README? If we want to add more information, I feel we should add it to that readme instead of duplicating it here? That would make this doc pretty small though
Contributor
There was a problem hiding this comment.
Otherwise with the API changes that are incoming, we'll have to make changes to 2 places 😢
docs/quickstart.md
Outdated
|
|
||
| ### To use the REST Server for inference | ||
|
|
||
| - In a browser of choice, visit `http://localhost:8080/docs/`. All the available inference rpcs are listed. Expand on the correct task for the model you trained. In this example, we are using `api/v1/{model_id}/task/sample`. |
Contributor
There was a problem hiding this comment.
@anhuong had a question about why we use the /task/sample API to make inference calls after we train a Sample Module. I guess it's worth mentioning that somewhere
Contributor
There was a problem hiding this comment.
We need to assume a user doesn't have much idea what a Module is
Signed-off-by: Angel Luu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a quick start on how to stand up a runtime server with
sample_liband how to send some basic train and inference requests