Skip to main content

class BetaReport

(service_api: 'ServiceApi',
attrs: 'dict',
entity: 'str | None' = None,
project: 'str | None' = None)

Description

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.

Args

  • service_api:
  • attrs:
  • entity:
  • project:

Properties

property spec

property sections

Get the panel sections (groups) from the report.

property id

property name

property display_name

property description

property user

property updated_at

property created_at

property url

Methods

method runs

self,
section: 'dict[str, Any]',
per_page: 'int' = 50,
only_selected: 'bool' = True
Get runs associated with a section of the report.
Arguments
  • section:
  • per_page:
  • only_selected:

method to_html

self,
height: 'int' = 1024,
hidden: 'bool' = False
Generate HTML containing an iframe displaying this report.
Arguments
  • height:
  • hidden: