Projects

Compare versions of your model, explore results in a scratch workspace, and export findings to a report to save notes and visualizations

A project is a central location where you visualize results, compare experiments, view and download artifacts, create an automation, and more.

Each project has a visibility setting that determines who can access it. For more information about who can access a project, see Project visibility.

Each project contains the following tabs:

• Overview: snapshot of your project
• Workspace: personal visualization sandbox
• Runs: A table that lists all the runs in your project
• Automations: Automations configured in your project
• Sweeps: automated exploration and optimization
• Reports: saved snapshots of notes, runs, and graphs
• Artifacts: Contains all runs and the artifacts associated with that run

Overview tab

• Project name: The name of the project. W&B creates a project for you when you initialize a run with the name you provide for the project field. You can change the name of the project at any time by selecting the Edit button in the upper right corner.
• Description: A description of the project.
• Project visibility: The visibility of the project. The visibility setting that determines who can access it. See Project visibility for more information.
• Last active: Timestamp of the last time data is logged to this project
• Owner: The entity that owns this project
• Contributors: The number of users that contribute to this project
• Total runs: The total number of runs in this project
• Total compute: we add up all the run times in your project to get this total
• Undelete runs: Click the dropdown menu and click “Undelete all runs” to recover deleted runs in your project.
• Delete project: click the dot menu in the right corner to delete a project

View a live example

To change a project’s privacy from the Overview tab:

1. In the W&B App, from any page in the project, click Overview in the left navigation.

2. At the top right, click Edit.

3. Choose a new value for Project visibility:

   • Team (default): Only your team can view and edit the project.

   • Restricted: Only invited members can access the project, and public access is turned off.

   • Open: Anyone can submit runs or create reports, but only your team can edit it. Appropriate only for classroom settings, public benchmark competitions, or other non-durable contexts.

   • Public: Anyone can view the project, but only your team can edit it.

     If your W&B admins have turned off Public visibility, you cannot choose it. Instead, you can share a view-only W&B Report, or contact your W&B organization’s admins for assistance.

4. Click Save.

If you update a project to a more strict privacy setting, you may need to re-invite individual users to restore their ability to access the project.

Workspace tab

A project’s workspace gives you a personal sandbox to compare experiments. Use projects to organize models that can be compared, working on the same problem with different architectures, hyperparameters, datasets, preprocessing etc.

Runs Sidebar: list of all the runs in your project.

• Dot menu: hover over a row in the sidebar to see the menu appear on the left side. Use this menu to rename a run, delete a run, or stop and active run.
• Visibility icon: click the eye to turn on and off runs on graphs
• Color: change the run color to another one of our presets or a custom color
• Search: search runs by name. This also filters visible runs in the plots.
• Filter: use the sidebar filter to narrow down the set of runs visible
• Group: select a config column to dynamically group your runs, for example by architecture. Grouping makes plots show up with a line along the mean value, and a shaded region for the variance of points on the graph.
• Sort: pick a value to sort your runs by, for example runs with the lowest loss or highest accuracy. Sorting will affect which runs show up on the graphs.
• Expand button: expand the sidebar into the full table
• Run count: the number in parentheses at the top is the total number of runs in the project. The number (N visualized) is the number of runs that have the eye turned on and are available to be visualized in each plot. In the example below, the graphs are only showing the first 10 of 183 runs. Edit a graph to increase the max number of runs visible.

If you pin, hide, or change the order of columns in the Runs tab, the Runs sidebar reflects these customizations.

Panels layout: use this scratch space to explore results, add and remove charts, and compare versions of your models based on different metrics

View a live example

Add a section of panels

Click the section dropdown menu and click “Add section” to create a new section for panels. You can rename sections, drag them to reorganize them, and expand and collapse sections.

Each section has options in the upper right corner:

• Add section: Add a section above or below from the dropdown menu, or click the button at the bottom of the page to add a new section.
• Rename section: Change the title for your section.
• Export section to report: Save this section of panels to a new report.
• Delete section: Remove the whole section and all the charts. This can be undone with the undo button at the bottom of the page in the workspace bar.
• Add panel: Click the plus button to add a panel to the section.

Move panels between sections

Drag and drop panels to reorder and organize into sections. You can also click the “Move” button in the upper right corner of a panel to select a section to move the panel to.

Resize panels

All panels maintain the same size, and there are pages of panels. You can resize the panels by clicking and dragging the lower right corner. Resize the section by clicking and dragging the lower right corner of the section.

Search for metrics

Use the search box in the workspace to filter down the panels. This search matches the panel titles, which are by default the name of the metrics visualized.

Runs tab

Use the Runs tab to filter, group, and sort your runs.

The proceeding tabs demonstrate some common actions you can take in the Runs tab.

Customize columns

The Runs tab shows details about runs in the project. It shows a large number of columns by default.

When you customize the Runs tab, the customization is also reflected in the Runs selector of the Workspace tab.

• To view all visible columns, scroll the page horizontally.
• To change the order of the columns, drag a column to the left or right.
• To pin a column, hover over the column name, click the action menu .... that appears, then click Pin column. Pinned columns appear near the left of the page, after the Name column. To unpin a pinned column, choose Unpin column.
• To hide a column, hover over the column name, click the action menu .... that appears, then click Hide column. To view all columns that are currently hidden, click Columns.
• To show, hide, pin, and unpin multiple columns at once, click Columns.
  • Click the name of a hidden column to unhide it.
  • Click the name of a visible column to hide it.
  • Click the pin icon next to a visible column to pin it.

Automations tab

Automate downstream actions for versioning artifacts. To create an automation, define trigger events and resulting actions. Actions include executing a webhook or launching a W&B job. For more information, see Automations.

Reports tab

See all the snapshots of results in one place, and share findings with your team.

Sweeps tab

Start a new sweep from your project.

Artifacts tab

View all artifacts associated with a project, from training datasets and fine-tuned models to tables of metrics and media.

Overview panel

On the overview panel, you’ll find a variety of high-level information about the artifact, including its name and version, the hash digest used to detect changes and prevent duplication, the creation date, and any aliases. You can add or remove aliases here, take notes on both the version as well as the artifact as a whole.

Metadata panel

The metadata panel provides access to the artifact’s metadata, which is provided when the artifact is constructed. This metadata might include configuration arguments required to reconstruct the artifact, URLs where more information can be found, or metrics produced during the run which logged the artifact. Additionally, you can see the configuration for the run which produced the artifact as well as the history metrics at the time of logging the artifact.

Usage panel

The Usage panel provides a code snippet for downloading the artifact for use outside of the web app, for example on a local machine. This section also indicates and links to the run which output the artifact and any runs which use the artifact as an input.

Files panel

The files panel lists the files and folders associated with the artifact. W&B uploads certain files for a run automatically. For example, requirements.txt shows the versions of each library the run used, and wandb-metadata.json, and wandb-summary.json include information about the run. Other files may be uploaded, such as artifacts or media, depending on the run’s configuration. You can navigate through this file tree and view the contents directly in the W&B web app.

Tables associated with artifacts are particularly rich and interactive in this context. Learn more about using Tables with Artifacts here.

Lineage panel

The lineage panel provides a view of all of the artifacts associated with a project and the runs that connect them to each other. It shows run types as blocks and artifacts as circles, with arrows to indicate when a run of a given type consumes or produces an artifact of a given type. The type of the particular artifact selected in the left-hand column is highlighted.

Click the Explode toggle to view all of the individual artifact versions and the specific runs that connect them.

Action History Audit tab

The action history audit tab shows all of the alias actions and membership changes for a Collection so you can audit the entire evolution of the resource.

Versions tab

The versions tab shows all versions of the artifact as well as columns for each of the numeric values of the Run History at the time of logging the version. This allows you to compare performance and quickly identify versions of interest.

Create a project

You can create a project in the W&B App or programmatically by specifying a project in a call to wandb.init().

W&B App

In the W&B App, you can create a project from the Projects page or from a team’s landing page.

From the Projects page:

1. Click the global navigation icon in the upper left. The navigation sidebar opens.
2. In the Projects section of the navigation, click View all to open the project overview page.
3. Click Create new project.
4. Set Team to the name of the team that will own the project.
5. Specify a name for your project using the Name field.
6. Set Project visibility, which defaults to Team.
7. Optionally, provide a Description.
8. Click Create project.

From a team’s landing page:

1. Click the global navigation icon in the upper left. The navigation sidebar opens.
2. In the Teams section of the navigation, click the name of a team to open its landing page.
3. In the landing page, click Create new project.
4. Team is automatically set to the team that owns the landing page you were viewing. If necessary, change the team.
5. Specify a name for your project using the Name field.
6. Set Project visibility, which defaults to Team.
7. Optionally, provide a Description.
8. Click Create project.

Star a project

Add a star to a project to mark that project as important. Projects that you and your team mark as important with stars appear at the top of your organization’s homepage.

For example, the proceeding image shows two projects that are marked as important, the zoo_experiment and registry_demo. Both projects appear within the top of the organization’s homepage within the Starred projects section.

There are two ways to mark a project as important: within a project’s overview tab or within your team’s profile page.

Project overview

1. Navigate to your W&B project on the W&B App at https://wandb.ai/<team>/<project-name>.
2. Select the Overview tab from the project sidebar.
3. Choose the star icon in the upper right corner next to the Edit button.

Confirm that your project appears on the landing page of your organization by clicking on the organization name in the top left corner of the app.

Delete a project

You can delete your project by clicking the three dots on the right of the overview tab.

If the project is empty, you can delete it by clicking the dropdown menu in the top-right and selecting Delete project.

Add notes to a project

Add notes to your project either as a description overview or as a markdown panel within your workspace.

Add description overview to a project

Descriptions you add to your page appear in the Overview tab of your profile.

1. Navigate to your W&B project
2. Select the Overview tab from the project sidebar
3. Choose Edit in the upper right hand corner
4. Add your notes in the Description field
5. Select the Save button

Create reports to create descriptive notes comparing runs

You can also create a W&B Report to add plots and markdown side by side. Use different sections to show different runs, and tell a story about what you worked on.

Add notes to run workspace

1. Navigate to your W&B project
2. Select the Workspace tab from the project sidebar
3. Choose the Add panels button from the top right corner
4. Select the TEXT AND CODE dropdown from the modal that appears
5. Select Markdown
6. Add your notes in the markdown panel that appears in your workspace