Skip to content
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

Adds a clarification around artifact types. #677

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
6 changes: 6 additions & 0 deletions docs/guides/artifacts/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ artifact.save()
# Logs the artifact version "my_data" as a dataset with data from dataset.h5
```

The `type` of the artifact affects how it appears in the W&B platform. Leaving this parameter blank results in an artifact being`unspecified`.
katjacksonWB marked this conversation as resolved.
Show resolved Hide resolved

[](../../../static/images/artifacts/artifacts_dropdown.png)

Each label of the dropdown represents a different `tyoe` parameter value. In the preceding code snippet, the artifact's `type` is `dataset`.
johndmulhausen marked this conversation as resolved.
Show resolved Hide resolved

:::tip
See the [track external files](./track-external-files.md) page for information on how to add references to files or directories stored in external object storage, like an Amazon S3 bucket.
:::
Expand Down
katjacksonWB marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2024-05-22 at 9 50 49 PM

I think it could be helpful to explicitly connect the image with the code snippet and show the relationship in a diagram. I attached a sketch I made, maybe it's worth getting a more official version with Raven's help?

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading