> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-docs-weave-byob-note.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 워크스페이스

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub 소스 코드
  </a>;

<GitHubLink url="https://github.com/wandb/wandb-workspaces/blob/main/wandb_workspaces/workspaces/internal.py" />

<Note>
  W\&B Report and Workspace API는 Public Preview 상태입니다.
</Note>

프로그래밍 방식으로 W\&B Workspace API를 사용하기 위한 Python 라이브러리입니다.

```python theme={null}
# 임포트 방법
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()
```

## <kbd>class</kbd> `RunSettings`

runset에 있는 run의 설정입니다(왼쪽 사이드바).

**속성:**

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

***

## <kbd>class</kbd> `RunsetSettings`

Workspace에서 runset(run이 표시되는 왼쪽 바)에 대한 설정입니다.

**속성:**

* `query` (str):  runset을 필터링하는 쿼리입니다(정규식 표현식일 수 있으며, 다음 매개변수 참조).
* `regex_query` (bool):  위의 `query`가 정규식 표현식인지 여부를 제어합니다. 기본값은 `False`입니다.
* `filters` (Union\[str, LList\[expr.FilterExpr]]):  runset에 적용할 필터 목록 또는 문자열 표현식입니다.
  * 목록인 경우: 필터는 AND로 결합됩니다. 필터 생성에 대한 자세한 내용은 FilterExpr를 참조하세요.
  * 문자열인 경우: Python 스타일 표현식을 사용합니다. 예: "Config('lr') = 0.001 and State = 'finished'"
* `Supports operators`:  `=`, `==`, `!=`, `<`, `>`, `<=`, `>=`, `in`, `not in`
* `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"]

**예시:**

```python theme={null}
    # 문자열 필터 사용 (신규)
    RunsetSettings(
        filters="Config('learning_rate') = 0.001 and State = 'finished'",
        pinned_columns=["summary:accuracy", "summary:loss"],
    )

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

***

### <kbd>메서드</kbd> `convert_filterexpr_list_to_string`

```python theme={null}
convert_filterexpr_list_to_string()
```

FilterExpr 목록을 문자열 표현식(통합 내부 형식)으로 변환합니다.

***

### <kbd>방법</kbd> `validate_and_setup_columns`

```python theme={null}
validate_and_setup_columns()
```

run:displayName이 있는지 확인한 다음 내부 열 필드를 설정합니다.

***

## <kbd>class</kbd> `Section`

Workspace의 섹션을 나타냅니다.

**속성:**

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

***

## <kbd>class</kbd> `SectionLayoutSettings`

섹션용 패널 레이아웃 설정으로, 일반적으로 W\&B App Workspace UI에서 섹션의 오른쪽 상단에 표시됩니다.

**속성:**

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

***

## <kbd>class</kbd> `SectionPanelSettings`

섹션의 패널 설정입니다. 섹션용 `WorkspaceSettings`와 비슷합니다.

여기에 적용한 설정은 더 세분화된 Panel 설정에 의해 다음 우선순위에 따라 재정의될 수 있습니다: Section \< Panel.

**속성:**

* `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):  모든 패널에 적용되는 스무딩 가중치입니다.

***

## <kbd>class</kbd> `Workspace`

섹션, 설정, run set용 설정을 포함하는 W\&B 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를 생성할 때만 설정할 수 있으며, 이후에는 수정할 수 없습니다.

***

### <kbd>속성</kbd> auto\_generate\_panels

***

### <kbd>속성</kbd> url

W\&B App의 Workspace URL입니다.

***

### <kbd>클래스 메서드</kbd> `from_url`

```python theme={null}
from_url(url: str)
```

URL에서 워크스페이스를 조회합니다.

***

### <kbd>방법</kbd> `save`

```python theme={null}
save()
```

현재 워크스페이스를 W\&B에 저장합니다.

**반환값:**

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

***

### <kbd>방법</kbd> `save_as_new_view`

```python theme={null}
save_as_new_view()
```

현재 Workspace를 W\&B에 새 뷰로 저장합니다.

**반환값:**

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

***

## <kbd>class</kbd> `WorkspaceSettings`

워크스페이스에 대한 설정으로, 일반적으로 UI에서 워크스페이스 상단에 표시됩니다.

이 객체에는 x-axis, smoothing, 이상치, 패널, 툴팁, run, 패널 쿼리 바에 대한 설정이 포함됩니다.

여기에 적용한 설정은 다음 우선순위에 따라 더 세분화된 Section 및 Panel 설정으로 재정의될 수 있습니다: Workspace \< Section \< Panel

**속성:**

* `x_axis` (str):  x-axis metric name 설정입니다.
* `x_min` (Optional\[float]):  x-axis의 최솟값입니다.
* `x_max` (Optional\[float]):  x-axis의 최댓값입니다.
* `smoothing_type` (Literal\['exponentialTimeWeighted', 'exponential', 'gaussian', 'average', 'none']):  모든 패널에 적용되는 smoothing 유형입니다.
* `smoothing_weight` (int):  모든 패널에 적용되는 smoothing 가중치입니다.
* `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):  패널 검색 결과를 자동으로 확장할지 여부입니다。