> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-mintlify-c7f6bef2.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Project management and collaboration tools for machine learning projects

# Reports overview

export const WandbReport = ({src, title, height = 640}) => {
  const isReportUrl = typeof src === 'string' && (/^https:\/\/wandb\.ai\/[^/]+\/[^/]+\/reports\/.*-{2,3}Vmlldz[A-Za-z0-9]+/).test(src);
  if (!src) {
    console.error('WandbReport: missing required `src` prop.');
    return null;
  }
  if (!isReportUrl) {
    console.warn(`WandbReport: src does not look like a W&B report URL: ${src}`);
  }
  const frameTitle = title || 'W&B report';
  if (!title) {
    console.warn('WandbReport: missing `title` prop; using a generic accessible name.');
  }
  const frameHeight = typeof height === 'number' && height > 0 ? height : 640;
  const frameSrc = isReportUrl ? `${src}${src.includes('?') ? '&' : '?'}jupyter=true` : src;
  return <figure className="wandb-report-embed not-prose" style={{
    margin: '1.5rem 0',
    border: '1px solid var(--color-stroke)',
    borderRadius: '12px',
    overflow: 'hidden',
    backgroundColor: 'var(--color-card-rest)'
  }}>
      {isReportUrl && <iframe src={frameSrc} title={frameTitle} loading="lazy" allow="fullscreen; clipboard-write" referrerPolicy="strict-origin-when-cross-origin" style={{
    display: 'block',
    width: '100%',
    height: `${frameHeight}px`,
    border: 0
  }} />}
      <figcaption style={{
    display: 'flex',
    justifyContent: 'flex-end',
    padding: '0.6rem 1rem',
    borderTop: isReportUrl ? '1px solid var(--color-stroke)' : 'none'
  }}>
        {}
        <a href={src} target="_blank" rel="noopener noreferrer" aria-label={`View report: ${frameTitle}`} style={{
    display: 'inline-flex',
    alignItems: 'center',
    padding: '8px 14px',
    border: '1px solid color-mix(in srgb, var(--color-stroke) 70%, transparent)',
    borderRadius: '12px',
    fontFamily: 'var(--font-sans)',
    fontSize: '14px',
    lineHeight: '20px',
    color: 'var(--color-text-secondary)',
    backgroundColor: 'color-mix(in srgb, var(--color-card-hover) 50%, transparent)',
    textDecoration: 'none'
  }}>
          View Report
        </a>
      </figcaption>
    </figure>;
};

export const TryProductLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" xmlns="http://www.w3.org/2000/svg">
      <line x1="4" y1="21" x2="4" y2="14"></line>
      <line x1="4" y1="10" x2="4" y2="3"></line>
      <line x1="12" y1="21" x2="12" y2="12"></line>
      <line x1="12" y1="8" x2="12" y2="3"></line>
      <line x1="20" y1="21" x2="20" y2="16"></line>
      <line x1="20" y1="12" x2="20" y2="3"></line>
      <circle cx="4" cy="12" r="2"></circle>
      <circle cx="12" cy="10" r="2"></circle>
      <circle cx="20" cy="14" r="2"></circle>
    </svg>
    Try in W&amp;B
  </a>;

export const ColabLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="colab-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M14.25.18l.9.2.73.26.59.3.45.32.34.34.25.34.16.33.1.3.04.26.02.2-.01.13V8.5l-.05.63-.13.55-.21.46-.26.38-.3.31-.33.25-.35.19-.35.14-.33.1-.3.07-.26.04-.21.02H8.77l-.69.05-.59.14-.5.22-.41.27-.33.32-.27.35-.2.36-.15.37-.1.35-.07.32-.04.27-.02.21v3.06H3.17l-.21-.03-.28-.07-.32-.12-.35-.18-.36-.26-.36-.36-.35-.46-.32-.59-.28-.73-.21-.88-.14-1.05-.05-1.23.06-1.22.16-1.04.24-.87.32-.71.36-.57.4-.44.42-.33.42-.24.4-.16.36-.1.32-.05.24-.01h.16l.06.01h8.16v-.83H6.18l-.01-2.75-.02-.37.05-.34.11-.31.17-.28.25-.26.31-.23.38-.2.44-.18.51-.15.58-.12.64-.1.71-.06.77-.04.84-.02 1.27.05zm-6.3 1.98l-.23.33-.08.41.08.41.23.34.33.22.41.09.41-.09.33-.22.23-.34.08-.41-.08-.41-.23-.33-.33-.22-.41-.09-.41.09zm13.09 3.95l.28.06.32.12.35.18.36.27.36.35.35.47.32.59.28.73.21.88.14 1.04.05 1.23-.06 1.23-.16 1.04-.24.86-.32.71-.36.57-.4.45-.42.33-.42.24-.4.16-.36.09-.32.05-.24.02-.16-.01h-8.22v.82h5.84l.01 2.76.02.36-.05.34-.11.31-.17.29-.25.25-.31.24-.38.2-.44.17-.51.15-.58.13-.64.09-.71.07-.77.04-.84.01-1.27-.04-1.07-.14-.9-.2-.73-.25-.59-.3-.45-.33-.34-.34-.25-.34-.16-.33-.1-.3-.04-.25-.02-.2.01-.13v-5.34l.05-.64.13-.54.21-.46.26-.38.3-.32.33-.24.35-.2.35-.14.33-.1.3-.06.26-.04.21-.02.13-.01h5.84l.69-.05.59-.14.5-.21.41-.28.33-.32.27-.35.2-.36.15-.36.1-.35.07-.32.04-.28.02-.21V6.07h2.09l.14.01.21.03zm-6.47 14.25l-.23.33-.08.41.08.41.23.33.33.23.41.08.41-.08.33-.23.23-.33.08-.41-.08-.41-.23-.33-.33-.23-.41-.08-.41.08z" />
    </svg>
    Try in Colab
  </a>;

<CardGroup cols={4}>
  <ColabLink url="https://colab.research.google.com/github/wandb/examples/blob/master/colabs/intro/Report_API_Quickstart.ipynb" />

  <TryProductLink url="https://wandb.ai/stacey/deep-drive/reports/The-View-from-the-Driver-s-Seat--Vmlldzo1MTg5NQ?utm_source=fully_connected&utm_medium=blog&utm_campaign=view+from+the+drivers+seat" />
</CardGroup>

Use W\&B Reports to:

* Organize Runs.
* Embed and automate visualizations.
* Describe your findings.
* Share updates with collaborators, either as a LaTeX zip file or a PDF.

The report below was created from metrics logged to W\&B over the course of training. Scroll within it to explore the benchmark runs, panels, and commentary, or [open the full report](https://wandb.ai/stacey/saferlife/reports/SafeLife-Benchmark-Experiments--Vmlldzo0NjE4MzM) in the W\&B app.

<WandbReport src="https://wandb.ai/stacey/saferlife/reports/SafeLife-Benchmark-Experiments--Vmlldzo0NjE4MzM" title="SafeLife benchmark experiments report" height={720} />

## How it works

Create a collaborative report with a few clicks.

1. Navigate to your W\&B project workspace in the W\&B App.
2. Click the **Create report** button in the upper right corner of your workspace.

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-mintlify-c7f6bef2/V80gqEhkbiGoLwZU/images/reports/create_a_report_button.png?fit=max&auto=format&n=V80gqEhkbiGoLwZU&q=85&s=9f7760a9c531982b12a846888eb56e70" alt="Create report button" max-width="90%" width="2510" height="462" data-path="images/reports/create_a_report_button.png" />
</Frame>

3. A modal titled **Create Report** will appear. Select the charts and panels you want to add to your report. (You can add or remove charts and panels later).
4. Click **Create report**.
5. Edit the report to your desired state.
6. Click **Publish to project**.
7. Click the **Share** button to share your report with collaborators.

See the [Create a report](/models/reports/create-a-report/) page for more information on how to create reports interactively and programmatically with the W\&B Python SDK.

## How to get started

Depending on your use case, explore the following resources to get started with W\&B Reports:

* Check out our [video demonstration](https://www.youtube.com/watch?v=2xeJIv_K_eI) to get an overview of W\&B Reports.
* Explore the [Reports gallery](/models/reports/reports-gallery/) for examples of live reports.
* Try the [Programmatic Workspaces](https://colab.research.google.com/github/wandb/wandb-workspaces/blob/Update-wandb-workspaces-tuturial/Workspace_tutorial.ipynb) notebook to learn how to create and customize your workspace.
* Read curated Reports in [W\&B Fully Connected](https://wandb.me/fc).

## Recommended practices and tips

For best practices and tips for Experiments and logging, see [Best Practices: Reports](https://wandb.ai/wandb/pytorch-lightning-e2e/reports/W-B-Best-Practices-Guide--VmlldzozNTU1ODY1#reports).
