-
Notifications
You must be signed in to change notification settings - Fork 32
Registry: Edit "Link artifact to a collection" #1677
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.
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
base: main
Are you sure you want to change the base?
Conversation
Deploying docs with
|
Latest commit: |
dc7442c
|
Status: | ✅ Deploy successful! |
Preview URL: | https://a880d1ad.docodile.pages.dev |
Branch Preview URL: | https://add-artifact-link-example.docodile.pages.dev |
PR Preview: Changed content Base preview: https://add-artifact-link-example.docodile.pages.dev Modified
|
# Specify the path to the file on your local machine. | ||
artifact.add_file(local_path = "<local_path_to_artifact>") | ||
|
||
# Save the artifact |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit (non-blocking): Might be worth adding to this comment, that this save
action will initialize a run
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ibindlish Ahh noted. Follow up question:
Is is possible to link an artifact w/out creating a run (which is what Karan mentioned)? The Artifact.link()
method requires either wandb.init()
and/or Artifact.save()
. (At least, when I was testing it out) 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we add real details like this to a code block, maybe they should also be reflected in the narrative content in the page so they don't get lost.
--- | ||
|
||
Link artifact versions to a collection to make them available to other members in your organization. | ||
Link an artifact version to a collection to make it available to other members in your organization. Linking an artifact to a collection brings that artifact version from a private, project-level scope, to a shared organization level scope. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link an artifact version to a collection to make it available to other members in your organization. Linking an artifact to a collection brings that artifact version from a private, project-level scope, to a shared organization level scope. | |
Link an artifact version to a collection to make it available to other members in your organization. Linking an artifact to a collection brings that artifact version from a private project level scope, to a shared organization level scope. |
You can [link an artifact version to a collection]({{< relref "/guides/core/registry/link_version.md#link-an-artifact-version-to-a-collection" >}}) programmatically with the W&B Python SDK or interactively with the W&B App. | ||
|
||
In other words, linking an artifact to a registry collection brings that artifact version from a private, project-level scope, to a shared organization level scope. | ||
When you link an artifact version to a collection, W&B creates a linked version of that artifact in the collection. The linked version points to the source artifact version that is logged to a run within a project. You can view the linked version in the collection and the source version in the project where it was logged. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When you link an artifact version to a collection, W&B creates a linked version of that artifact in the collection. The linked version points to the source artifact version that is logged to a run within a project. You can view the linked version in the collection and the source version in the project where it was logged. | |
When you link an artifact version to a collection, W&B creates a linked version of that artifact in the collection. The linked version points to the source artifact version that is logged to a run within a project. You can view both the linked version in the collection and the source version in the project where it was logged. |
{{% /alert %}} | ||
|
||
## Link an artifact to a collection | ||
## Link an artifact to a collection |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Link an artifact to a collection | |
## Link an artifact to a collection |
# Specify the path to the file on your local machine. | ||
artifact.add_file(local_path = "<local_path_to_artifact>") | ||
|
||
# Save the artifact |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we add real details like this to a code block, maybe they should also be reflected in the narrative content in the page so they don't get lost.
|
||
|
||
View a linked artifact's metadata, version data, usage, lineage information and more in the Registry App. | ||
Once an artifact is linked, you can [view a linked artifact's metadata, version data, usage, lineage information]({{< relref "/guides/core/registry/link_version.md#view-linked-artifacts-in-a-registry" >}}) and more in the Registry App. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once an artifact is linked, you can [view a linked artifact's metadata, version data, usage, lineage information]({{< relref "/guides/core/registry/link_version.md#view-linked-artifacts-in-a-registry" >}}) and more in the Registry App. | |
You can [view a linked artifact's metadata, version data, usage, lineage information]({{< relref "/guides/core/registry/link_version.md#view-linked-artifacts-in-a-registry" >}}) and more in the Registry App. |
Nit, but I think the link text makes this clear.
Description
Started off as adding a simple link to the reference docs, ended up rewriting some the page itself.
https://wandb.atlassian.net/browse/DOCS-1414
Status
Ready for Eng review
📄 View preview links for changed pages