Adds new artifacts colab.

[katjacksonWB]

Adds a new Artifacts colab to replace the old, outdated one linked on the Artifacts landing page.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[github-actions]

Thanks for contributing to wandb/examples!
We appreciate your efforts in opening a PR for the examples repository. Our goal is to ensure a smooth and enjoyable experience for you 😎.

Guidelines

The examples repo is regularly tested against the ever-evolving ML stack. To facilitate our work, please adhere to the following guidelines:

• Notebook naming: You can use a combination of snake_case and CamelCase for your notebook name. Avoid using spaces (replace them with _) and special characters (&%$?). For example:

Cool_Keras_integration_example_with_weights_and_biases.ipynb 

is acceptable, but

Cool Keras Example with W&B.ipynb

is not. Avoid spaces and the & character. To refer to W&B, you can use: weights_and_biases or just wandb (it's our library, after all!)

• Managing dependencies within the notebook: You may need to set up dependencies to ensure that your code works. Please avoid the following practices:

  • Docker-related activities. If Docker installation is required, consider adding a full example with the corresponding Dockerfile to the wandb/examples/examples folder (where non-Colab examples reside).
  • Using pip install as the primary method to install packages. When calling pip in a cell, avoid performing other tasks. We automatically filter these types of cells, and executing other actions might break the automatic testing of the notebooks. For example,

  pip install -qU wandb transformers gpt4
  

  is acceptable, but

  pip install -qU wandb
  import wandb

  is not.

  • Installing packages from a GitHub branch. Although it's acceptable 😎 to directly obtain the latest bleeding-edge libraries from GitHub, did you know that you can install them like this:

  !pip install -q git+https://github.com/huggingface/transformers

  You don't need to clone, then cd into the repo and install it in editable mode.

  • Avoid referencing specific Colab directories. Google Colab has a /content directory where everything resides. Avoid explicitly referencing this directory because we test our notebooks with pure Jupyter (without Colab). Instead, use relative paths to make the notebook reproducible.

• The Jupyter notebook file .ipynb is nothing more than a JSON file with primarily two types of cells: markdown and code. There is also a bunch of other metadata specific to Google Colab. We have a set of tools to ensure proper notebook formatting. These tools can be found at wandb/nb_helpers.

Before merging, wait for a maintainer to clean and format the notebooks you're adding. You can tag @tcapelle.

Before marking the PR as ready for review, please run your notebook one more time. Restart the Colab and run all. We will provide you with links to open the Colabs below

The following colabs were changed
-colabs/wandb-artifacts/Artifact_fundamentals.ipynb

[noaleetz]

Hey @katjacksonWB - some feedback from reviewing the whole thing:

• I think it's important to cover how to version an artifact because if not the colab doesn't really show the utility of logging your stuff to an artifact. It can be a minimal example, like adding a few new images and showing that a new version is created
• the colab should also showcase how someone can navigate to the UI for the artifact logged and link to a public project that the user can look at the understand how the actions done in colab reflect in UI (the SDK prints out a URL so we should show user how to find this to get to the UI from their log_artifact command)

[noaleetz]

left a comment with some requested changes!

[noaleetz]

left another round of comments!

[tcapelle]

Ping me when ready for final review/merge

[tcapelle]

Why we don't show the classic:

# you can log using the one-liner:
wandb.log_artifact("file.csv", name="my_artifact", type="data")

# or
at = Artifact(name="my_artifact",  type="data")
at.add_file("file.csv")
# add_dir(...)
wandb.log_artifact(at)

• Shouldn't this live in wandb-artifacts?
• Please also replace the "old outdated one"

[noaleetz]

Why we don't show the classic:

# you can log using the one-liner:
wandb.log_artifact("file.csv", name="my_artifact", type="data")

# or
at = Artifact(name="my_artifact",  type="data")
at.add_file("file.csv")
# add_dir(...)
wandb.log_artifact(at)

• Shouldn't this live in wandb-artifacts?
• Please also replace the "old outdated one"

is referring to a specific line?

[noaleetz]

last request on lineage

[noaleetz]

can you make sure we include a screenshot of a more complex lineage for a user to explore, and also link the relevant project (probably the artifact workflow project)

[tcapelle]

yeap, I am missing some screenshots. Add those or from the docs or upload them as files in the same folder.

[rymc]

I think would be better here to init the run at the start of the code block.

[tcapelle]

• maybe split in 2 cells.
• csv_data instead of csvData.

[rymc]

hmm the wording of overwriting old versions may be confusing to users (line 228 and 236) as we don't really overwrite the old version, we create a new version instead. Overwriting to me implies it replaces the previous.

[rymc]

I would suggest moving the run.finish() to the end of the block as it is usually better practice (e.g., in this case, it would capture what is printed out)

[rymc]

I think the following wording here may be a little confusing to some users:

"run.log_artifact() when an Artifact is output to a run"

I think "to a run" should be "of a run"?

[tcapelle]

Why we don't show the classic:

# you can log using the one-liner:
wandb.log_artifact("file.csv", name="my_artifact", type="data")

# or
at = Artifact(name="my_artifact",  type="data")
at.add_file("file.csv")
# add_dir(...)
wandb.log_artifact(at)

• Shouldn't this live in wandb-artifacts?
• Please also replace the "old outdated one"

is referring to a specific line?

This plan and the code don't match:

You are doing 2+3+4 in one line.

[tcapelle]

I would also use this PR to remove/replace old stuff in wandb-artifacts (and put this file in there as a getting started)

[tcapelle]

split pip install from import wandb please

[tcapelle]

Just feel like we are not following with code this plan.

[tcapelle]

• maybe split in 2 cells.
• csv_data instead of csvData.

[tcapelle]

add blanck line before the comment for readability

[tcapelle]

yeap, I am missing some screenshots. Add those or from the docs or upload them as files in the same folder.

[noaleetz]

Hey @rymc - would you be up to revising the changes you proposed directly? Katherine is out on medical leave so I am trying to get some support with wrapping up her in-flight docs PR so we can get the new and improved Artifacts colab out. If it is easy enough to make those fixes directly that would be a huge help so I can focus on some of the other docs work.

[rymc]

Hey @noaleetz done. Addressed comments and confirmed working on Colab.

[noaleetz]

Hey @noaleetz done. Addressed comments and confirmed working on Colab.

Ryan you are awesome, thank you so so much. I will give the colab a final run myself, but we should be good to merge. @ngrayluna can I ask you to give your review and stamp as well?

[ngrayluna]

Blocker: Notebook needs to be executable

[ngrayluna]

Notebooks need to be executable...we'll want to use a real dataset before merging this in.

[rymc]

Ah, good point @ngrayluna. I've pushed a new version that makes the Colab notebook executable regardless of where it runs.

[ngrayluna]

PR for small nits: #548

[tcapelle]

can you make both wandbcode consistent?

[ngrayluna]

can you make both wandbcode consistent?

Not sure I follow?