Skip to content

DOCS-3924: Add instructions for changing model name #4313

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOCS-3924: Add instructions for changing model name #4313

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions docs/operate/get-started/other-hardware/manage-modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,9 +328,11 @@ Other registry items such as training scripts and ML models can be deleted in th
Deleting a version of a module requires the same org owner permissions as deleting the entire module, and similarly, you cannot delete a version if any machines are using it.
To delete just one version of a module:

1. Navigate to its page in the [**REGISTRY** section of the Viam app](https://app.viam.com/registry)
2. Click **Show previous versions** under the **Latest version** heading.
3. Hover on the architecture pill next to the version you'd like to delete and click the trash icon.
1. Navigate to its page in the [**REGISTRY** section of the Viam app](https://app.viam.com/registry).

1. Click **Show previous versions** under the **Latest version** heading.

1. Hover on the architecture pill next to the version you'd like to delete and click the trash icon.

You cannot upload a new file with the same version number as the deleted one.
To upload another version, you must increment the version number to a later version number.
Expand Down Expand Up @@ -368,8 +370,26 @@ To transfer ownership of a module from one organization to another:
1. Publish a new version of the module to the registry by following either set of update steps on this page.
This ensures that the model names in the module code match the registered model names in the registry.

1. Update the `model` field in the configuration of any machines that use the module to point to the new organization's namespace.
1. Update the `model` field in the configuration of any machines that use the module to use the new organization's namespace.

## Rename a module

If you need to change the name of a module, please reach out to the Viam team at [[email protected]](mailto:[email protected]).

{{% hiddencontent %}}

## Rename a model

If you need to change the name of a model that a module implements, do the following:

1. Update the `model` field in the `meta.json` file to the new model name.

1. Update the model name in the module code to match the new model name.

1. Run `viam module update` to push the changes to the registry.

1. Publish a new version of the module to the registry by following either set of update steps on this page.

1. Update the configuration of any machines that use the module to use the new model name.

{{% /hiddencontent %}}
Loading