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 an iterable collection 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.cursor

Returns the cursor position for pagination of file results.

property Reports.length

The number of reports in the project.

property Reports.more

Returns whether there are more files to fetch.

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.

WARNING: this API will likely change in a future release

Attributes:

• name (string): The name of the report.
• description (string): Report description.
• user (User): The user that created the report.
• spec (dict): The spec off the report.
• updated_at (string): timestamp of last update.

method BetaReport.__init__

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

property BetaReport.sections

Get the panel sections (groups) from the report.

property BetaReport.updated_at

Timestamp of last update

property BetaReport.url

URL of the report.

Contains the entity, project, display name, and id.

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.