워크스페이스

# 임포트 방법
import wandb_workspaces.workspaces as ws
import wandb_workspaces.reports.v2 as wr

# 워크스페이스 생성 예시
ws.Workspace(
     name="Example W&B Workspace",
     entity="entity", # 워크스페이스를 소유하는 entity
     project="project", # 워크스페이스와 연결된 프로젝트
     sections=[
         ws.Section(
             name="Validation Metrics",
             panels=[
                 wr.LinePlot(x="Step", y=["val_loss"]),
                 wr.BarPlot(metrics=["val_accuracy"]),
                 wr.ScalarChart(metric="f1_score", groupby_aggfunc="mean"),
             ],
             is_open=True,
         ),
     ],
)
workspace.save()

​

class RunSettings

• color (str): UI에서 run의 색상입니다. 16진수(#ff0000), CSS 색상(red), 또는 rgb(rgb(255, 0, 0))를 사용할 수 있습니다.
• disabled (bool): run이 비활성화되었는지 여부입니다(UI에서 눈이 감긴 상태). 기본값은 False입니다.

​

class RunsetSettings

• query (str): runset을 필터링하는 쿼리입니다(정규식 표현식일 수 있으며, 다음 매개변수 참조).
• regex_query (bool): 위의 query가 정규식 표현식인지 여부를 제어합니다. 기본값은 False입니다.
• filters (Union[str, LList[FilterExpr], Or, And]): runset용 필터입니다.
  • FilterExpr 목록인 경우: 필터는 AND로 결합됩니다.
  • 문자열인 경우: Python 스타일 표현식입니다. 예: “Config(‘lr’) = 0.001 and State = ‘finished’”
• Supports operators: =, ==, !=, <, >, <=, >=, in, not in, and, or
  • Or/And 결합자인 경우: OR 로직과 중첩 그룹을 사용할 수 있습니다. 예: Or(And(Config(“lr”) == 0.01, Metric(“State”) == “finished”), Config(“lr”) == 0.1)
• groupby (LList[expr.MetricType]): runset에서 그룹화할 메트릭 목록입니다. Metric, Summary, Config, Tags, 또는 KeysInfo로 설정합니다.
• order (LList[expr.Ordering]): runset에 적용할 메트릭과 정렬 순서의 목록입니다.
• run_settings (Dict[str, RunSettings]): run 설정의 딕셔너리로, 키는 run의 ID이고 값은 RunSettings 객체입니다.
• pinned_columns (LList[str]): 고정할 열 이름 목록입니다.
• Column names use format: “run:displayName”, “summary:metric”, “config:param”.
• run: displayName이 없으면 자동으로 추가됩니다.
• Example: [“summary:accuracy”, “summary:loss”]
• baseline_run (Optional[str]): 기준 run의 W&B run slug입니다(wandb.Run.id의 값, 예: "1mbku38n" — run URL의 마지막 경로 세그먼트이기도 함). 델타 열과 비교 스타일링에 사용됩니다. 설정하면 W&B 앱의 동작에 맞춰 기준 run이 pinned_runs에 자동으로 추가됩니다. Workspace 자체 프로젝트의 run을 참조해야 하며, 프로젝트 간 pin은 아직 이 SDK에서 지원되지 않습니다(UI에서 해당하는 기능은 W&B 앱의 “Add cross-project runs” drawer를 참조하세요).
• pinned_runs (LList[str]): run 선택기에 계속 표시하고 plot에 대해 항상 가져올 W&B run slug의 순서 있는 목록입니다. GraphQL ID가 아니라 slug 문자열(wandb.Run.id)을 전달하세요. W&B 앱에서는 이를 20개 항목으로 제한합니다.

    # 문자열 필터 사용 (신규)
    RunsetSettings(
         filters="Config('learning_rate') = 0.001 and State = 'finished'",
         pinned_columns=["summary:accuracy", "summary:loss"],
         baseline_run="1mbku38n",  # wandb.Run.id (URL의 슬러그)
         pinned_runs=["1mbku38n", "2u1g3j1c"],
    )

    # FilterExpr 목록 사용 (기존 방식)
    RunsetSettings(
         filters=[expr.Config("learning_rate") == 0.001],
         pinned_columns=["summary:accuracy", "summary:loss"],
    )

​

방법 convert_filterexpr_list_to_string

convert_filterexpr_list_to_string()

​

방법 ensure_baseline_pinned

ensure_baseline_pinned()

​

방법 validate_and_setup_columns

validate_and_setup_columns()

​

class Section

• name (str): 섹션의 이름/제목입니다.
• panels (LList[PanelTypes]): 섹션에 있는 패널의 정렬된 목록입니다. 기본적으로 첫 번째는 왼쪽 위에, 마지막은 오른쪽 아래에 위치합니다.
• is_open (bool): 섹션이 열려 있는지 닫혀 있는지를 나타냅니다. 기본값은 닫힘입니다.
• pinned (bool): 섹션이 고정되어 있는지 여부입니다. 고정된 섹션은 Workspace 상단에 표시됩니다. 기본값은 False입니다.
• layout_settings (SectionLayoutSettings): 섹션의 패널 레이아웃 설정입니다.
• panel_settings: Section에 대한 WorkspaceSettings와 유사하게, 섹션의 모든 패널에 적용되는 패널 수준 설정입니다.

​

class SectionLayoutSettings

• columns (int): 레이아웃의 열 수입니다. 기본값은 3입니다.
• rows (int): 레이아웃의 행 수입니다. 기본값은 2입니다.

​

class SectionPanelSettings

• x_axis (str): x축 metric 이름 설정입니다. 기본값은 “Step”입니다.
• x_min Optional[float]: x축의 최솟값입니다.
• x_max Optional[float]: x축의 최댓값입니다.
• smoothing_type (Literal[‘exponentialTimeWeighted’, ‘exponential’, ‘gaussian’, ‘average’, ‘none’]): 모든 패널에 적용되는 스무딩 유형입니다.
• smoothing_weight (int): 모든 패널에 적용되는 스무딩 가중치입니다.

​

class Workspace

• entity (str): 이 Workspace가 저장될 entity입니다(일반적으로 사용자 또는 팀 이름).
• project (str): 이 Workspace가 저장될 프로젝트입니다.
• name: Workspace의 이름입니다.
• sections (LList[Section]): Workspace에 있는 섹션의 순서 있는 목록입니다. 첫 번째 섹션이 Workspace 맨 위에 표시됩니다.
• settings (WorkspaceSettings): Workspace의 설정으로, 일반적으로 UI에서 Workspace 상단에 표시됩니다.
• runset_settings (RunsetSettings): Workspace의 runset 설정입니다(run이 표시되는 왼쪽 막대).
• auto_generate_panels (bool): 이 프로젝트에 로깅된 모든 키에 대해 패널을 자동 생성할지 여부입니다. 사용 가능한 모든 데이터가 기본으로 시각화되도록 하려면 이 설정을 권장합니다. 이 값은 Workspace를 생성할 때만 설정할 수 있으며, 이후에는 수정할 수 없습니다.

​

속성 auto_generate_panels

​

속성 url

​

클래스 메서드 from_url

from_url(url: str)

​

방법 save

save()

• Workspace: 저장된 내부 name 및 ID가 적용된 업데이트된 워크스페이스입니다.

​

방법 save_as_new_view

save_as_new_view()

• Workspace: 저장된 내부 이름과 ID가 포함된 업데이트된 Workspace입니다.

​

class WorkspaceSettings

• x_axis (str): x축 metric name 설정입니다.
• x_min (Optional[float]): x축의 최솟값입니다.
• x_max (Optional[float]): x축의 최댓값입니다.
• smoothing_type (Literal[‘exponentialTimeWeighted’, ‘exponential’, ‘gaussian’, ‘average’, ‘none’]): 모든 패널에 적용되는 스무딩 유형입니다.
• smoothing_weight (int): 모든 패널에 적용되는 스무딩 가중치입니다.
• ignore_outliers (bool): 모든 패널에서 이상치를 무시합니다.
• sort_panels_alphabetically (bool): 모든 Section의 패널을 알파벳순으로 정렬합니다.
• group_by_prefix (Literal[“first”, “last”]): 첫 번째 또는 마지막 prefix를 기준으로 패널을 그룹화합니다(first 또는 last). 기본값은 last입니다.
• remove_legends_from_panels (bool): 모든 패널에서 범례를 제거합니다.
• tooltip_number_of_runs (Literal[“default”, “all”, “none”]): 툴팁에 표시할 run 수입니다.
• tooltip_color_run_names (bool): 툴팁에서 run name을 runset에 맞춰 색상으로 표시할지(True), 표시하지 않을지(False)를 나타냅니다. 기본값은 True입니다.
• max_runs (int): 패널별로 표시할 최대 run 수입니다(runset의 처음 10개 run이 표시됨).
• point_visualization_method (Literal[“line”, “point”, “line_point”]): 포인트의 시각화 방법입니다.
• panel_search_query (str): 패널 검색 바의 쿼리입니다(regex 표현식일 수 있음).
• auto_expand_panel_search_results (bool): 패널 검색 결과를 자동으로 확장할지 여부입니다。