Skip to content

Commit

Permalink
Update model-namespace-triplet.md
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel authored Oct 27, 2023
1 parent 45f24db commit fa128a3
Showing 1 changed file with 1 addition and 9 deletions.
10 changes: 1 addition & 9 deletions docs/appendix/glossary/model-namespace-triplet.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,7 @@ aka:

{{< glossary_tooltip term_id="model" text="Models" >}} are uniquely namespaced as colon-delimited-triplets in the form of `namespace:repo-name:name` for modular resources and `rdk:builtin:name` for built-in models.

We recommend using the name of the git repository of your modular resource as the middle segment.
The `repo-name` should describe the common functionality provided across the model or models of that module.

For example:

- The `rand:yahboom:arm` model uses the repository name [yahboom](https://github.com/viam-labs/yahboom).
It implements the `rdk:component:arm` API to support the yahboom dofbot arm.
- The `viam-labs:audioout:pygame` model uses the repository name [audioout](https://github.com/viam-labs/audioout)
It implements the custom API `viam-labs:service:audioout`.
For more information see [Naming your model](/modular-resources/key-concepts/#naming-your-model-namespacerepo-namename).

Built-in {{< glossary_tooltip term_id="rdk" text="rdk" >}} models use the triplet `rdk:builtin:name`.
For example:
Expand Down

0 comments on commit fa128a3

Please sign in to comment.