Groups

class GroupClient(beaker: Beaker)

Methods for interacting with Beaker Groups. Accessed via the Beaker.group property.

Warning

Do not instantiate this class directly! The Beaker client will create one automatically which you can access through the corresponding property.

get(group_id: str) → Group

Examples:

>>> with Beaker.from_env() as beaker:
...     group = beaker.group.get(group_id)

Returns:

A BeakerGroup protobuf object.

Raises:

BeakerGroupNotFound – If the group doesn’t exist.

create(name: str, *, workspace: Workspace | None = None, description: str | None = None, experiment_ids: list[str] | None = None) → Group

Create a new group.

Returns:

The new BeakerGroup object.

update(group: Group, *, name: str | None = None, description: str | None = None, add_experiment_ids: list[str] | None = None, archived: bool | None = None) → Group

delete(*groups: Group)

export_metrics(group: Group) → str

list_task_metrics(group: Group) → Iterable[TaskMetrics]

list(*, org: Organization | None = None, workspace: Workspace | None = None, name_or_description: str | None = None, sort_order: BeakerSortOrder | None = None, sort_field: Literal['created', 'name', 'modified'] = 'name', limit: int | None = None) → Iterable[Group]

url(group: Group) → str