reports

module wandb.apis.public

W&B Public API for Report objects.

This module provides classes for interacting with W&B reports and managing report-related data.

class Reports

Reports is a lazy iterator of BetaReport objects.

Args:

• client (wandb.apis.internal.Api): The API client instance to use.
• project (wandb.sdk.internal.Project): The project to fetch reports from.
• name (str, optional): The name of the report to filter by. If None, fetches all reports.
• entity (str, optional): The entity name for the project. Defaults to the project entity.
• per_page (int): Number of reports to fetch per page (default is 50).

method Reports.__init__

__init__(client, project, name=None, entity=None, per_page=50)

property Reports.length

method Reports.convert_objects

convert_objects()

Converts GraphQL edges to File objects.

method Reports.update_variables

update_variables()

Updates the GraphQL query variables for pagination.

class BetaReport

BetaReport is a class associated with reports created in W&B.

Provides access to report attributes (name, description, user, spec, timestamps) and methods for retrieving associated runs, sections, and for rendering the report as HTML.

Attributes:

• id (string): Unique identifier of the report.
• display_name (string): Human-readable display name of the report.
• name (string): The name of the report. Use display_name for a more user-friendly name.
• description (string): Description of the report.
• user (User): Dictionary containing user info (username, email) who created the report.
• spec (dict): The spec of the report.
• url (string): The URL of the report.
• updated_at (string): Timestamp of last update.
• created_at (string): Timestamp when the report was created.

method BetaReport.__init__

__init__(client, attrs, entity=None, project=None)

property BetaReport.created_at

property BetaReport.description

property BetaReport.display_name

property BetaReport.id

property BetaReport.name

property BetaReport.sections

Get the panel sections (groups) from the report.

property BetaReport.spec

property BetaReport.updated_at

property BetaReport.url

property BetaReport.user

method BetaReport.runs

runs(section, per_page=50, only_selected=True)

Get runs associated with a section of the report.

method BetaReport.to_html

to_html(height=1024, hidden=False)

Generate HTML containing an iframe displaying this report.