diff --git a/docs/glossary.md b/docs/glossary.md index baf03c5..61955b1 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -73,6 +73,9 @@ self-supervised learning supervised learning : A machine learning training method in which a model is trained on a labeled dataset to make predictions on new data. +task +: A machine learning task that includes one or multiple implementations to perform a prediction or inference. For example: a `sample` task can have a `sample implementation` and a `list implementation`. All the implementations within a task will have a common protobuf definition for their request and response, ex: `SampleTaskRequest` and `SampleOutputType`. We generate inference service rcps per task, not per implementation. + token : A discrete unit of meaning or analysis in a text, such as a word or subword (part of a word). diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 0000000..c9d8530 --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1,17 @@ +--- +layout: default +title: Dev Quick Start Guide +nav_order: 7 +--- + +# Dev Quick Start Guide +{: .no_toc } + +This document describes how to quickly get a runtime server built with `sample_lib` library, train a model with gRPC and with that trained model, send an inference call to the server with either HTTP or gRPC call. + +## Pre-reqs +To set up development environment and tooling, the [Development Guide]({{ site.baseurl }}{% link docs/developing.md %}) page is a good place to start. + +## Start Guide + +See https://github.com/caikit/caikit/blob/main/examples/sample_lib/README.md for step by step details on how to get running with a `sample_lib` server and interacting with it. \ No newline at end of file