You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[DOCS-1690] Add docs for Restricted Viewer role
- Add to Registry permissions table
- Add to Registry section of Teams documentation
- Add to aliases documentation
- Document key differences from Viewer role
- Document cross-registry permissions behavior
- Clarify ownership vs Registry roles
- Add SDK compatibility requirements (version 0.19.9+
- Update permissions table to use Unicode checkmark and X characters
- Improve SDK method descriptions to specify 'viewing artifact metadata
only
<!-- preview-links-comment -->
📄 **[View preview links for changed
pages](#1565 (comment)
---------
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Copy file name to clipboardExpand all lines: content/en/guides/core/registry/aliases.md
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,12 @@ Create one or more custom aliases for a specific artifact versions based on your
31
31
- You might use aliases such as `dataset_version_v0`, `dataset_version_v1`, and `dataset_version_v2` to identify which dataset a model was trained on.
32
32
- You might use a `best_model` alias to keep track of the best performing artifact model version.
33
33
34
-
Any user with a [Member or Admin registry role]({{< relref "guides/core/registry/configure_registry/#registry-roles" >}}) on a registry can add or remove a custom alias from a linked artifact in that registry. If appropriate, use [protected aliases]({{< relref "aliases/#protected-aliases" >}}) to label and identify which artifact versions to protect from modification or deletion.
34
+
Any user with a [**Member** or **Admin** registry role]({{< relref "guides/core/registry/configure_registry/#registry-roles" >}}) on a registry can add or remove a custom alias from a linked artifact in that registry. Users with the [**Restricted Viewer** or **Viewer** roles]({{< relref "guides/core/registry/configure_registry/#registry-roles" >}}) cannot add or remove aliases.
35
+
36
+
{{% alert %}}
37
+
[Protected aliases]({{< relref "aliases/#protected-aliases" >}}) provide a way to label and identify which artifact versions to protect from modification or deletion.
38
+
{{% /alert %}}
39
+
35
40
36
41
You can create a custom alias with the W&B Registry or the Python SDK. Based on your use case, click on a tab below that best fits your needs.
37
42
@@ -84,7 +89,7 @@ run.link_artifact(
84
89
### Protected aliases
85
90
Use a [protected alias]({{< relref "aliases/#protected-aliases" >}}) to both label and identify artifact versions that should not be modified or deleted. For example, consider using a `production` protected alias to label and identify artifact versions that are in used in your organization's machine learning production pipeline.
86
91
87
-
[Registry admins]({{< relref "/guides/core/registry/configure_registry/#registry-roles" >}}) and [service accounts]({{< relref "/support/kb-articles/service_account_useful" >}}) with the Admin role can create protected aliases and add or remove protected aliases from an artifact version. Members and Viewers cannot unlink a protected version or delete a collection that contains a protected . See [Configure registry access]({{< relref "/guides/core/registry/configure_registry.md" >}}) for details.
92
+
[Registry admin]({{< relref "/guides/core/registry/configure_registry/#registry-roles" >}}) users and [service accounts]({{< relref "/support/kb-articles/service_account_useful" >}}) with the **Admin** role can create protected aliases and add or remove protected aliases from an artifact version. Users and service accounts with **Member**, **Viewer**, and **Restricted Viewer** roles cannot unlink a protected version or delete a collection that contains a protected alias. See [Configure registry access]({{< relref "/guides/core/registry/configure_registry.md" >}}) for details.
88
93
89
94
Common protected aliases include:
90
95
@@ -163,4 +168,4 @@ run.link_artifact(
163
168
164
169
1. First, you create an artifact object (`wandb.Artifact()`).
165
170
2. Next, you add two dataset PyTorch tensors to the artifact object with `wandb.Artifact.add_file()`.
166
-
3. Lastly, you link the artifact version to the `Model` collection in the `Zoo_Classifier_Models` registry with `link_artifact()`. You also add two custom aliases to the artifact version by passing `production-us` and `production-eu` as arguments to the `aliases` parameter.
171
+
3. Lastly, you link the artifact version to the `Model` collection in the `Zoo_Classifier_Models` registry with `link_artifact()`. You also add two custom aliases to the artifact version by passing `production-us` and `production-eu` as arguments to the `aliases` parameter.
0 commit comments