diff --git a/docs/services/ml/deploy/_index.md b/docs/services/ml/deploy/_index.md deleted file mode 100644 index 0f68502803..0000000000 --- a/docs/services/ml/deploy/_index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Deploy an ML Model with the ML Model Service" -linkTitle: "ML Model Service" -weight: 60 -type: "docs" -tags: ["data management", "ml", "model training"] -aliases: - - /manage/data/deploy-model/ - - /services/ml/ - - /ml/deploy/ -description: "Deploy machine learning models to a machine and use the vision service to detect or classify images or to create point clouds of identified objects." -modulescript: true -hide_children: true -icon: true -no_list: true -images: ["/services/icons/ml.svg"] -date: "2024-09-03" -# updated: "" # When the content was last entirely checked -# SME: Aaron Casas ---- - -The Machine Learning (ML) model service allows you to deploy machine learning models to your machine. -You can deploy: - -- a model you [trained](/how-tos/train-deploy-ml/) -- a model from [the registry](https://app.viam.com/registry) that another user has shared publicly -- a model trained outside the Viam platform that you have uploaded to the [**MODELS** tab](https://app.viam.com/data/models) in the **DATA** section of the Viam app -- a model trained outside the Viam platform that's already available on your machine - -After deploying your model, you need to configure an additional service to use the deployed model. -For example, you can configure an [`mlmodel` vision service](/services/vision/) to visualize the predictions your model makes. - -## Available ML model service models - -You must deploy an ML model service to use machine learning models on your machines. -Once you have deployed the ML model service, you can select an [ML model](#machine-learning-models-from-registry). - -{{}} - -{{< alert title="Add support for other models" color="tip" >}} -If none of the existing models of the ML model service fit your use case, you can create a {{< glossary_tooltip term_id="modular-resource" text="modular resource" >}} to add support for it. - -ML models must be designed in particular shapes to work with the `mlmodel` [classification](/services/vision/mlmodel/) or [detection](/services/vision/mlmodel/) model of Viam's [vision service](/services/vision/). -Follow [these instructions](/registry/advanced/mlmodel-design/) to design your modular ML model service with models that work with vision. -{{< /alert >}} - -{{< alert title="Note" color="note" >}} -For some models of the ML model service, like the [Triton ML model service](https://github.com/viamrobotics/viam-mlmodelservice-triton/tree/main/) for Jetson boards, you can configure the service to use either the available CPU or a dedicated GPU. -{{< /alert >}} - -## Machine learning models from registry - -You can search the machine learning models that are available to deploy on this service from the registry here: - -{{}} - -## API - -The [ML model service API](/appendix/apis/services/ml/) supports the following methods: - -{{< readfile "/static/include/services/apis/generated/mlmodel-table.md" >}} - -## Next steps - -The ML model service only runs your model on the machine. -To use the inferences from the model, you must use an additional service such as a [vision service](/services/vision/): - -{{< cards >}} - -{{% manualcard link="/services/vision/mlmodel/" title="Create a visual detector or classifier" noimage="True" %}} - -Use your model deployed with the ML model service by adding a vision service that can provide detections or classifications depending on your ML model. - -{{% /manualcard %}} -{{% card link="/how-tos/train-deploy-ml/" noimage="True" %}} -{{% card link="/how-tos/detect-people/" customTitle="Detect people" noimage="true" %}} - -{{< /cards >}} diff --git a/docs/services/ml/tflite_cpu.md b/docs/services/ml/tflite_cpu.md index cf7a401e02..3b8bf1241d 100644 --- a/docs/services/ml/tflite_cpu.md +++ b/docs/services/ml/tflite_cpu.md @@ -20,7 +20,7 @@ It is supported on any CPU and Linux, Raspbian, MacOS and Android machines. To work with the `tflite_cpu` ML model service, an ML model is comprised of a .tflite model file which defines the model, and optionally a .txt labels file which provides the text labels for your model. With the `tflite_cpu` ML model service, you can deploy: -- [a model from the registry](https://app.viam.com/registry) +- a [model from the registry](https://app.viam.com/registry) - a [model](/registry/ml-models/) trained outside the Viam platform that you have uploaded - a model available on your machine diff --git a/layouts/_default/list.typesense.json b/layouts/_default/list.typesense.json index fac98532e6..633ab46404 100644 --- a/layouts/_default/list.typesense.json +++ b/layouts/_default/list.typesense.json @@ -157,18 +157,14 @@ {{- end -}} {{- end -}} {{- if eq .Section "services" -}} - {{ $services_with_resources := slice "Generic Service" "ML Model Service" "Computer Vision" }} + {{ $services_with_resources := slice "Generic Service" "ML Model" "Computer Vision" }} {{- if and (in $services_with_resources .Parent.LinkTitle) (and (not .Draft) (not .Params.no_service)) -}} {{- if .Params.canonical -}} {{- $.Scratch.Set "permalink" (printf "%s" .Params.canonical) -}} {{- $.Scratch.Set "relpermalink" (printf "%s" .Params.canonical) -}} {{- else -}} {{- $.Scratch.Set "permalink" .Permalink -}} - {{- if eq .Parent.LinkTitle "ML Model Service" -}} - {{- $.Scratch.Set "relpermalink" (printf "../../..%s" .RelPermalink) -}} - {{- else -}} - {{- $.Scratch.Set "relpermalink" (printf "../..%s" .RelPermalink) -}} - {{- end -}} + {{- $.Scratch.Set "relpermalink" (printf "../..%s" .RelPermalink) -}} {{- end -}} {{- $.Scratch.Set "id" (printf "builtin:rdk:service:%s:%s" (strings.Replace (strings.ToLower .Parent.LinkTitle) " " "_" ) (strings.ToLower .LinkTitle) ) -}}