Skip to main content
W&B Report and Workspace API는 공개 프리뷰 단계입니다.
W&B Reports API를 프로그래밍 방식으로 사용하기 위한 Python 라이브러리입니다.

클래스 BarPlot

2D 막대 플롯을 표시하는 패널 객체입니다. 속성:
  • title (Optional[str]): 플롯 상단에 표시되는 텍스트입니다.
  • metrics (LList[MetricType]): orientation Literal[“v”, “h”]: 막대 플롯의 방향입니다. 세로(“v”) 또는 가로(“h”)로 설정하세요. 기본값은 가로(“h”)입니다.
  • range_x (Tuple[float | None, float | None]): X축 범위를 지정하는 튜플입니다.
  • title_x (Optional[str]): X축의 레이블입니다.
  • title_y (Optional[str]): Y축의 레이블입니다.
  • groupby (Optional[str]): 보고서가 정보를 가져오는 W&B 프로젝트에 로깅된 메트릭을 기준으로 run을 그룹화합니다.
  • groupby_aggfunc (Optional[GroupAgg]): 지정한 함수로 run을 집계합니다. 옵션은 “mean”, “min”, “max”, “median”, “sum”, “samples” 또는 None입니다.
  • groupby_rangefunc (Optional[GroupArea]): 범위를 기준으로 run을 그룹화합니다. 옵션은 “minmax”, “stddev”, “stderr”, “none”, “samples” 또는 None입니다.
  • max_runs_to_show (Optional[int]): 플롯에 표시할 최대 run 수입니다.
  • max_bars_to_show (Optional[int]): 막대 플롯에 표시할 최대 막대 수입니다.
  • custom_expressions (Optional[LList[str]]): 막대 플롯에 사용할 맞춤형 표현식 목록입니다.
  • legend_template (Optional[str]): 범례 템플릿입니다.
  • font_size ( Optional[FontSize]): 선형 플롯의 글꼴 크기입니다. 옵션은 “small”, “medium”, “large”, “auto” 또는 None입니다.
  • line_titles (Optional[dict]): 선의 제목입니다. 키는 선 이름이고 값은 제목입니다.
  • line_colors (Optional[dict]): 선의 색상입니다. 키는 선 이름이고 값은 색상입니다.
  • aggregate (Optional[bool]): True로 설정하면 데이터를 집계합니다.

클래스 BlockQuote

인용된 텍스트 블록입니다. 속성:
  • text (str): 인용 블록의 텍스트입니다.

클래스 CalloutBlock

강조 텍스트 블록입니다. 속성:
  • text (str): 강조 텍스트입니다.

클래스 CheckedList

체크박스가 있는 항목 목록입니다. CheckedList 안에 하나 이상의 CheckedListItem을 추가하세요. 속성:
  • items (LList[CheckedListItem]): 하나 이상의 CheckedListItem 객체 목록입니다.

클래스 CheckedListItem

체크박스가 있는 목록 항목입니다. CheckedList 내에 하나 이상의 CheckedListItem을 추가하세요. 속성:
  • text (str): 목록 항목의 텍스트입니다.
  • checked (bool): 체크박스의 선택 여부입니다. 기본값은 False입니다.

클래스 CodeBlock

코드 블록입니다. 속성:
  • code (str): 블록 내 코드입니다.
  • language (Optional[Language]): 코드의 언어입니다. 지정된 언어는 구문 강조에 사용됩니다. 기본값은 “python”입니다. 선택 가능한 값은 ‘javascript’, ‘python’, ‘css’, ‘json’, ‘html’, ‘markdown’, ‘yaml’입니다.

클래스 CodeComparer

서로 다른 두 run의 코드를 비교하는 패널 객체입니다. 속성:
  • diff (Literal[‘split’, ‘unified’]): 코드 차이를 표시하는 방식입니다. 옵션은 “split”과 “unified”입니다.

클래스 Config

run의 설정 객체에 로깅된 메트릭입니다. 설정 객체는 일반적으로 run.config[name] = ...를 사용하거나 설정을 키-값 쌍의 딕셔너리로 전달하여 로깅합니다. 여기서 키는 메트릭의 이름이고 값은 해당 메트릭의 값입니다. 속성:
  • name (str): 메트릭의 이름입니다.

클래스 CustomChart

맞춤형 차트를 표시하는 패널입니다. 차트는 Weave 쿼리로 정의됩니다. 속성:
  • query (dict): 맞춤형 차트를 정의하는 쿼리입니다. 키는 필드 이름이고, 값은 쿼리입니다.
  • chart_name (str): 맞춤형 차트의 제목입니다.
  • chart_fields (dict): 플롯의 축을 정의하는 키-값 쌍입니다. 키는 레이블이고, 값은 메트릭입니다.
  • chart_strings (dict): 차트의 string을 정의하는 키-값 쌍입니다.

클래스 메서드 from_table

table에서 맞춤형 차트를 만듭니다. 인수:
  • table_name (str): table의 이름입니다.
  • chart_fields (dict): 차트에 표시할 필드입니다.
  • chart_strings (dict): 차트에 표시할 string입니다.

보고서와 URL의 갤러리를 렌더링하는 블록입니다. 속성:
  • items (List[Union[GalleryReport, GalleryURL]]): GalleryReport 및 GalleryURL 객체의 목록입니다.

클래스 GalleryReport

갤러리에 있는 report에 대한 레퍼런스입니다. 속성:
  • report_id (str): report의 ID입니다.

클래스 GalleryURL

외부 리소스의 URL입니다. 속성:
  • url (str): 리소스의 URL입니다.
  • title (Optional[str]): 리소스의 제목입니다.
  • description (Optional[str]): 리소스의 설명입니다.
  • image_url (Optional[str]): 표시할 이미지의 URL입니다.

클래스 GradientPoint

그라디언트의 한 점입니다. 속성:
  • color: 점의 색상입니다.
  • offset: 그라디언트 내 점의 위치입니다. 값은 0에서 100 사이여야 합니다.

클래스 H1

지정된 텍스트가 있는 H1 제목입니다. 속성:
  • text (str): 제목의 텍스트입니다.
  • collapsed_blocks (Optional[LList[“BlockTypes”]]): 제목이 접혀 있을 때 표시할 블록입니다.

클래스 H2

지정된 텍스트가 있는 H2 제목입니다. 속성:
  • text (str): 제목의 텍스트입니다.
  • collapsed_blocks (Optional[LList[“BlockTypes”]]): 제목이 접혔을 때 표시할 하나 이상의 블록입니다.

클래스 H3

지정된 텍스트가 있는 H3 제목입니다. 속성:
  • text (str): 제목의 텍스트입니다.
  • collapsed_blocks (Optional[LList[“BlockTypes”]]): 제목이 접혔을 때 표시할 하나 이상의 블록입니다.

클래스 Heading


클래스 HorizontalRule

HTML 수평선.

클래스 Image

이미지를 렌더링하는 블록입니다. 속성:
  • url (str): 이미지의 URL입니다.
  • caption (str): 이미지의 캡션입니다. 캡션은 이미지 아래에 표시됩니다.

클래스 InlineCode

인라인 코드입니다. 코드 뒤에 줄바꿈 문자를 추가하지 않습니다. 속성:
  • text (str): 리포트에 표시할 코드입니다.

클래스 InlineLatex

인라인 LaTeX 마크다운입니다. LaTeX 마크다운 뒤에 줄바꿈 문자를 추가하지 않습니다. 속성:
  • text (str): 리포트에 표시할 LaTeX 마크다운입니다.

클래스 LatexBlock

LaTeX 텍스트 블록입니다. 속성:
  • text (str): LaTeX 텍스트입니다.

클래스 Layout

리포트 내 패널의 레이아웃입니다. 패널의 크기와 위치를 조정합니다. 속성:
  • x (int): 패널의 x 위치입니다.
  • y (int): 패널의 y 위치입니다.
  • w (int): 패널의 너비입니다.
  • h (int): 패널의 높이입니다.

클래스 LinePlot

2D 선형 플롯이 있는 패널 객체입니다. 속성:
  • title (Optional[str]): 플롯 상단에 표시되는 텍스트입니다.
  • x (Optional[MetricType]): 리포트가 정보를 가져오는 W&B 프로젝트에 로깅된 메트릭의 이름입니다. 지정한 메트릭은 x축에 사용됩니다.
  • y (LList[MetricType]): 리포트가 정보를 가져오는 W&B 프로젝트에 로깅된 하나 이상의 메트릭입니다. 지정한 메트릭은 y축에 사용됩니다.
  • range_x (Tuple[float | None, float | None]): x축의 범위를 지정하는 튜플입니다.
  • range_y (Tuple[float | None, float | None]): y축의 범위를 지정하는 튜플입니다.
  • log_x (Optional[bool]): 밑이 10인 로그 스케일로 x 좌표를 플롯합니다.
  • log_y (Optional[bool]): 밑이 10인 로그 스케일로 y 좌표를 플롯합니다.
  • title_x (Optional[str]): x축의 레이블입니다.
  • title_y (Optional[str]): y축의 레이블입니다.
  • ignore_outliers (Optional[bool]): True로 설정하면 이상값을 플롯하지 않습니다.
  • groupby (Optional[str]): 리포트가 정보를 가져오는 W&B 프로젝트에 로깅된 메트릭을 기준으로 run을 그룹화합니다.
  • groupby_aggfunc (Optional[GroupAgg]): 지정한 함수로 run을 집계합니다. 옵션에는 “mean”, “min”, “max”, “median”, “sum”, “samples” 또는 None이 있습니다.
  • groupby_rangefunc (Optional[GroupArea]): 범위를 기준으로 run을 그룹화합니다. 옵션에는 “minmax”, “stddev”, “stderr”, “none”, “samples” 또는 None이 있습니다.
  • smoothing_factor (Optional[float]): 스무딩 유형에 적용할 스무딩 계수입니다. 0에서 1 사이의 값을 사용할 수 있습니다.
  • smoothing_type Optional[SmoothingType]: 지정한 분포를 기반으로 필터를 적용합니다. 옵션에는 “exponentialTimeWeighted”, “exponential”, “gaussian”, “average” 또는 “none”이 있습니다.
  • smoothing_show_original (Optional[bool]): True로 설정하면 원본 데이터를 표시합니다.
  • max_runs_to_show (Optional[int]): 선형 플롯에 표시할 run의 최대 개수입니다.
  • custom_expressions (Optional[LList[str]]): 데이터에 적용할 맞춤형 표현식입니다.
  • plot_type Optional[LinePlotStyle]: 생성할 선형 플롯의 유형입니다. 옵션에는 “line”, “stacked-area” 또는 “pct-area”가 있습니다.
  • font_size Optional[FontSize]: 선형 플롯의 글꼴 크기입니다. 옵션에는 “small”, “medium”, “large”, “auto” 또는 None이 있습니다.
  • legend_position Optional[LegendPosition]: 범례를 배치할 위치입니다. 옵션에는 “north”, “south”, “east”, “west” 또는 None이 있습니다.
  • legend_template (Optional[str]): 범례의 템플릿입니다.
  • aggregate (Optional[bool]): True로 설정하면 데이터를 집계합니다.
  • xaxis_expression (Optional[str]): x축의 표현식입니다.
  • xaxis_format (Optional[str]): x축의 형식입니다. 이 옵션은 맞춤형 메트릭을 정의한 경우에 표시됩니다. 예를 들어 ‘datetime’을 지정하면 x축을 날짜 및 시간 형식으로 표시할 수 있습니다.
  • legend_fields (Optional[LList[str]]): 범례에 포함할 필드입니다.
  • metric_regex (Optional[str]): y축 메트릭과 일치시킬 정규 표현식 패턴입니다. 백엔드는 이 패턴을 사용해 일치하는 메트릭을 선택합니다.
  • point_visualization_method (Optional[PointVizMethod]): 표시할 포인트가 너무 많을 때 포인트를 집계하는 방법입니다. “bucketing-gorilla”(데이터 포인트를 버킷으로 묶고 버킷별 최소, 최대, 평균을 표시해 이상값과 급증 구간을 보존)와 “sampling”(포인트를 무작위로 샘플링해 렌더링 속도가 빠르지만 이상값을 놓칠 수 있음) 중에서 선택할 수 있습니다.
  • line_titles (Optional[Dict[str, str]]): 시리즈별 표시 제목입니다. 키는 ”:” 형식을 사용합니다.
  • line_colors (Optional[Dict[str, Any]]): 시리즈별 색상입니다. 키는 ”:” 형식을 사용합니다.
  • line_widths (Optional[Dict[str, float]]): 시리즈별 선 너비입니다. 키는 ”:” 형식을 사용합니다.
  • line_marks (Optional[Dict[str, Mark]]): 시리즈별 대시 스타일입니다. 키는 ”:” 형식입니다.
  • Valid values: “solid”, “dashed”, “dotted”, “dotdash”, “dotdotdash”, “points”.

URL로 연결되는 링크입니다. 속성:
  • text (Union[str, TextWithInlineComments]): 링크의 텍스트입니다.
  • url (str): 링크가 가리키는 URL입니다.

클래스 MarkdownBlock

마크다운 텍스트 블록입니다. 일반적인 마크다운 구문을 사용하는 텍스트를 작성할 때 유용합니다. 속성:
  • text (str): 마크다운 텍스트입니다.

클래스 MarkdownPanel

마크다운을 렌더링하는 패널입니다. 속성:
  • markdown (str): 마크다운 패널에 표시할 텍스트입니다.

클래스 MediaBrowser

미디어 파일을 갤러리 또는 그리드 레이아웃으로 표시하는 패널입니다. 속성:
  • title (Optional[str]): 패널의 제목입니다.
  • num_columns (Optional[int]): 그리드의 열 수입니다.
  • media_keys (LList[str]): 미디어 파일에 대응하는 미디어 키 목록입니다.
  • mode (Optional[Literal[“gallery”, “grid”]]): 패널의 표시 모드입니다. 지정하지 않으면 제공된 축에서 추론합니다. gallery_axis와 그리드 축이 모두 지정된 경우 필수입니다.
  • gallery_axis (Optional[Literal[“step”, “index”, “run”]]): 갤러리 모드에서 축으로 사용할 필드입니다.
  • grid_x_axis (Optional[Literal[“step”, “index”, “run”]]): 그리드 모드에서 X축으로 사용할 필드입니다.
  • grid_y_axis (Optional[Literal[“step”, “index”, “run”]]): 그리드 모드에서 Y축으로 사용할 필드입니다.

클래스 Metric

프로젝트에 로깅된 메트릭 중 보고서에 표시할 메트릭입니다. 속성:
  • name (str): 메트릭의 이름입니다.

클래스 OrderBy

정렬 기준으로 사용할 메트릭입니다. 속성:
  • name (str): 메트릭의 이름입니다.
  • ascending (bool): 오름차순으로 정렬할지 여부입니다. 기본값은 False입니다.

클래스 OrderedList

번호가 매겨진 목록의 항목 목록입니다. 속성:
  • items (LList[TextLikeField]): 하나 이상의 OrderedListItem 객체로 구성된 목록입니다. 각 항목은 string 또는 TextLike 객체의 목록일 수 있습니다.

클래스 OrderedListItem

순서가 있는 목록의 항목입니다. 속성:
  • text (str): 목록 항목의 텍스트입니다.

클래스 P

텍스트 단락입니다. 속성:
  • text (str): 단락의 텍스트입니다.

클래스 Panel

패널 그리드에 시각화를 표시하는 패널입니다. 속성:
  • layout (Layout): Layout 객체입니다.

클래스 PanelGrid

runset과 패널로 구성된 그리드입니다. runset은 Runset 객체로, 패널은 Panel 객체로 추가하세요. 사용 가능한 패널: LinePlot, ScatterPlot, BarPlot, ScalarChart, CodeComparer, ParallelCoordinatesPlot, ParameterImportancePlot, RunComparer, MediaBrowser, MarkdownPanel, CustomChart, WeavePanel, WeavePanelSummaryTable, WeavePanelArtifactVersionedFile. 속성:
  • runsets (LList[“Runset”]): 하나 이상의 Runset 객체 목록입니다.
  • hide_run_sets (bool): 보고서 뷰어에게 패널 그리드의 run 세트를 숨길지 여부입니다.
  • panels (LList[“PanelTypes”]): 하나 이상의 Panel 객체 목록입니다.
  • active_runset (Optional[int]): 활성 runset 탭의 인덱스입니다. 기본값은 0입니다.
  • custom_run_colors (dict): 키는 run 이름이고 값은 16진수로 지정한 색상인 키-값 쌍입니다.

클래스 ParallelCoordinatesPlot

병렬 좌표 플롯을 표시하는 패널 객체입니다. 속성:
  • columns (LList[ParallelCoordinatesPlotColumn]): 하나 이상의 ParallelCoordinatesPlotColumn 객체 목록입니다.
  • title (Optional[str]): 플롯 상단에 표시되는 텍스트입니다.
  • gradient (Optional[LList[GradientPoint]]): 그라디언트 점 목록입니다.
  • font_size (Optional[FontSize]): 선형 플롯의 글꼴 크기입니다. “small”, “medium”, “large”, “auto” 또는 None 중에서 지정할 수 있습니다.

클래스 ParallelCoordinatesPlotColumn

병렬 좌표 플롯의 열입니다. 지정된 metric의 순서에 따라 병렬 좌표 플롯의 병렬 축(x축) 순서가 결정됩니다. 속성:
  • metric (str | Config | SummaryMetric): W&B 프로젝트에 로깅된 메트릭 중 보고서가 정보를 가져올 메트릭의 이름입니다.
  • display_name (Optional[str]): 메트릭의 이름입니다.
  • inverted (Optional[bool]): 메트릭을 반전할지 여부입니다.
  • log (Optional[bool]): 메트릭에 로그 변환을 적용할지 여부입니다.

클래스 ParameterImportancePlot

선택한 메트릭을 예측하는 데 각 하이퍼파라미터가 얼마나 중요한지 보여주는 패널입니다. 속성:
  • with_respect_to (str): 매개변수 중요도를 비교할 기준 메트릭입니다. 일반적인 메트릭에는 손실, 정확도 등이 있습니다. 지정한 메트릭은 리포트가 정보를 가져오는 프로젝트 내에 로깅되어 있어야 합니다.

클래스 Report

W&B Report를 나타내는 객체입니다. 반환된 객체의 blocks 속성을 사용하여 리포트를 사용자 지정하세요. Report 객체는 자동으로 저장되지 않습니다. 변경 사항을 저장하려면 save() 메서드를 사용하세요. 속성:
  • project (str): 불러올 W&B 프로젝트의 이름입니다. 지정한 프로젝트는 리포트의 URL에 표시됩니다.
  • entity (str): 리포트를 소유한 W&B entity입니다. entity는 리포트의 URL에 표시됩니다.
  • title (str): 리포트의 제목입니다. 제목은 리포트 상단에 H1 제목으로 표시됩니다.
  • description (str): 리포트에 대한 설명입니다. 설명은 리포트 제목 아래에 표시됩니다.
  • blocks (LList[BlockTypes]): HTML 태그, 플롯, 그리드, runset 등을 하나 이상 포함하는 목록입니다.
  • width (Literal[‘readable’, ‘fixed’, ‘fluid’]): 리포트의 너비입니다. ‘readable’, ‘fixed’, ‘fluid’ 중에서 선택할 수 있습니다.

속성 url

report가 호스팅되는 URL입니다. report URL은 https://wandb.ai/{entity}/{project_name}/reports/로 구성됩니다. 여기서 {entity}와 {project_name}은 각각 report가 속한 entity와 프로젝트의 이름으로 구성됩니다.

method delete

W&B에서 이 리포트를 삭제합니다. 이 리포트를 참조하는 모든 초안 뷰도 함께 삭제됩니다. 반환값:
  • bool: 백엔드에서 삭제 오퍼레이션이 성공한 것으로 확인되면 True, 그렇지 않으면 False입니다.

이 리포트의 “링크가 있는 모든 사용자가 볼 수 있음” 공유 링크를 비활성화합니다. 리포트의 활성 공개 액세스 토큰을 모두 철회합니다. 반환값:
  • bool: 링크가 철회되었으면 True, 활성 링크가 없었으면 False입니다.

이 보고서에 대해 “링크가 있는 모든 사용자가 조회할 수 있음” 공유를 활성화합니다. 보고서에 대한 공개 액세스 토큰을 생성합니다. 공유 링크가 이미 있으면 기존 링크를 반환합니다. 반환값:
  • str: 공유할 수 있는 매직 링크 URL입니다.

클래스 메서드 from_url

report를 현재 환경으로 불러옵니다. report가 호스팅된 URL을 전달하세요. 인수:
  • url (str): report가 호스팅된 URL입니다.
  • as_model (bool): True이면 Report 객체 대신 모델 객체를 반환합니다. 기본값은 False입니다.

method get_share_url

이 리포트의 매직 링크 URL을 가져옵니다. 공유가 활성화되어 있지 않으면 None을 반환합니다. 활성 액세스 토큰이 있는지 확인하기 위해 네트워크 호출을 수행합니다. 액세스 토큰이 추가된 리포트 URL을 반환하므로, 프로젝트가 비공개이더라도 링크가 있는 사람은 누구나 리포트를 볼 수 있습니다.

method save

report 객체의 변경 사항을 저장합니다.

method to_html

이 리포트를 표시하는 iframe을 포함한 HTML을 생성합니다. 주로 Python 노트북에서 사용합니다. 인수:
  • height (int): iframe의 높이입니다.
  • hidden (bool): True이면 iframe을 숨깁니다. 기본값은 False입니다.

클래스 RunComparer

리포트가 정보를 가져오는 프로젝트의 여러 run에서 메트릭을 비교하는 패널입니다. 속성:
  • diff_only (Optional[Literal[“split”, True]]): 프로젝트 내 run 간의 차이만 표시합니다. W&B Report UI에서 이 기능을 표시/숨기기할 수 있습니다.

클래스 RunSettings

report 패널 그리드에서 개별 run의 표시 모양과 가시성을 설정합니다. RunSettings를 사용하면 Runset 내에서 특정 run이 렌더링되는 방식을 사용자 지정할 수 있습니다. 여기에는 선 색상과 차트에서의 가시성이 포함됩니다. 속성:
  • color: run의 표시 색상입니다. hex 형식(#ff0000), CSS 색상 이름(red) 또는 RGB string(“rgb(255,0,0)“)을 사용할 수 있습니다.
  • disabled: True이면 차트에서 run을 숨깁니다. UI에서 닫힌 눈 아이콘을 클릭하는 것과 같습니다.

클래스 Runset

패널 그리드에 표시할 run 세트입니다. 속성:
  • entity (str): run이 저장된 프로젝트를 소유하거나 해당 프로젝트에 대한 올바른 권한을 가진 entity입니다.
  • project (str): run이 저장된 프로젝트의 이름입니다.
  • name (str): run 세트의 이름입니다. 기본값은 Run set입니다.
  • query (str): run을 필터링하는 쿼리 string입니다.
  • filters (Union[str, LList[expr.FilterExpr]]): run에 적용할 필터입니다. 다음 형식을 사용할 수 있습니다.
    • string 표현식: 예: “Config(‘lr’) = 0.001 and State = ‘finished’”
  • Supports operators: =, ==, !=, <, >, <=, >=, in, not in, and, or
    • FilterExpr 객체 목록: 예: [expr.Config(‘lr’) == 0.001]
  • groupby (LList[str]): 그룹화 기준이 될 메트릭 이름 목록입니다. 지원되는 형식은 다음과 같습니다.
    • run 속성으로 그룹화하려면 “group” 또는 “run.group”
    • 설정 매개변수로 그룹화하려면 “config.param”
    • summary 메트릭으로 그룹화하려면 “summary.metric”
  • order (LList[OrderBy]): 정렬 기준이 될 OrderBy 객체 목록입니다.
  • custom_run_colors (dict): run ID(그룹화된 run의 경우 RunsetGroup 키)를 색상에 매핑하는 딕셔너리입니다. run별로 색상만 단순하게 지정하려면 run_settings를 사용하는 것이 좋습니다.
  • run_settings (Dict[str, RunSettings]): run ID를 키로 하는 run별 표시 설정입니다. 색상을 설정하거나 개별 run을 숨길 때 사용합니다. RunSettings를 참조하세요.
  • pinned_columns (LList[str]): runs table의 왼쪽에 고정할 열 접근자입니다.
  • the runs table (e.g. [“summary: accuracy", "config:lr.value"]). hidden_columns에도 포함된 열은 저장 시 제거됩니다.
  • visible_columns (LList[str]): 항상 표시할 열 접근자입니다. lock_columns=True와 함께 사용하면 표시할 열 집합을 직접 지정할 수 있습니다. 다시 로드하면 column_order로만 설정된 열도 여기에 포함됩니다.
  • hidden_columns (LList[str]): 숨길 열 접근자입니다. pinned_columns, visible_columns, column_order보다 우선 적용됩니다. 다시 로드하면 서버에서 기본으로 추가한 항목이 포함될 수 있습니다.
  • like run: name.
  • column_order (LList[str]): 왼쪽에서 오른쪽 방향의 열 순서입니다. lock_columns=True인 경우 pinned_columns 또는 visible_columns에 없는 항목은 제외됩니다.
  • column_widths (Dict[str, int]): 열별 픽셀 너비입니다.
  • lock_columns (Optional[bool]): runs-table 열 집합을 잠그는 선택적 옵션입니다. True이면 pinned_columns와 visible_columns만 표시하고, False 또는 None(기본값)이면 제한하지 않습니다. runs-table 툴바의 잠금 아이콘과 동일한 기능입니다.
열 형식:
  • 열은 "<section>: <name>" 형식으로 지정합니다.
    • run:<attr>: 기본 제공 run 속성(예: run:state)
    • config:<key>.value: 설정 키(.value 접미사에 유의하세요)
    • summary:<key>: summary 메트릭
    • tags:__ALL__: run 태그
열 제한: 프런트엔드의 runs-table에는 최대 500개의 열이 표시됩니다. 표시되는 열 집합(pinned + visible + column_order에서 hidden 제외)이 500개 이상이면 SDK가 저장 시 경고를 표시합니다. hidden 열은 개수에 포함되지 않습니다. SDK는 열을 잘라내지 않고 전체 집합을 전송하며, 프런트엔드가 렌더링 시 제한을 강제 적용합니다. 예시:

방법 convert_filterexpr_list_to_string

FilterExpr 목록을 string 표현식으로 변환합니다.

방법 merge_custom_run_colors_into_run_settings

하위 호환성을 위해 일반 문자열 키를 사용하는 custom_run_colors를 run_settings에 병합합니다.

클래스 RunsetGroup

runset 그룹을 표시하는 UI 요소입니다. 속성:
  • runset_name (str): runset의 이름입니다.
  • keys (Tuple[RunsetGroupKey, …]): 그룹화 기준이 되는 키입니다. 그룹화하려면 RunsetGroupKey 객체를 하나 이상 전달하세요.

클래스 RunsetGroupKey

runset을 메트릭 유형과 값으로 그룹화합니다. RunsetGroup의 일부입니다. 그룹화할 메트릭 유형과 값을 키-값 쌍으로 지정하세요. 속성:
  • key (Type[str] | Type[Config] | Type[SummaryMetric] | Type[Metric]): 그룹화할 메트릭 유형입니다.
  • value (str): 그룹화할 메트릭의 값입니다.

클래스 ScalarChart

스칼라 차트를 표시하는 패널 객체입니다. 속성:
  • title (Optional[str]): 플롯 상단에 표시되는 텍스트입니다.
  • metric (MetricType): 보고서가 정보를 가져오는 W&B 프로젝트에 로깅된 메트릭의 이름입니다.
  • groupby_aggfunc (Optional[GroupAgg]): 지정된 함수로 run을 집계합니다. 옵션에는 “mean”, “min”, “max”, “median”, “sum”, “samples” 또는 None이 포함됩니다.
  • groupby_rangefunc (Optional[GroupArea]): 범위를 기준으로 run을 그룹화합니다. 옵션에는 “minmax”, “stddev”, “stderr”, “none”, “samples” 또는 None이 포함됩니다.
  • custom_expressions (Optional[LList[str]]): 스칼라 차트에서 사용할 맞춤형 표현식의 목록입니다.
  • legend_template (Optional[str]): 범례의 템플릿입니다.
  • font_size Optional[FontSize]: 선형 플롯의 글꼴 크기입니다. 옵션에는 “small”, “medium”, “large”, “auto” 또는 None이 포함됩니다.

클래스 ScatterPlot

패널 객체로 2D 또는 3D 산점도를 표시합니다. 인수:
  • title (Optional[str]): 플롯 상단에 표시되는 텍스트입니다.
  • x Optional[SummaryOrConfigOnlyMetric]: W&B 프로젝트에 로깅된 메트릭 이름으로, report가 정보를 가져옵니다. 지정된 메트릭이 x축에 사용됩니다.
  • y Optional[SummaryOrConfigOnlyMetric]: W&B 프로젝트에 로깅된 하나 이상의 메트릭으로, report가 정보를 가져옵니다. 지정된 메트릭이 y축에 표시됩니다. z Optional[SummaryOrConfigOnlyMetric]:
  • range_x (Tuple[float | None, float | None]): x축 범위를 지정하는 튜플입니다.
  • range_y (Tuple[float | None, float | None]): y축 범위를 지정하는 튜플입니다.
  • range_z (Tuple[float | None, float | None]): z축 범위를 지정하는 튜플입니다.
  • log_x (Optional[bool]): x 좌표를 밑이 10인 로그 스케일로 표시합니다.
  • log_y (Optional[bool]): y 좌표를 밑이 10인 로그 스케일로 표시합니다.
  • log_z (Optional[bool]): z 좌표를 밑이 10인 로그 스케일로 표시합니다.
  • running_ymin (Optional[bool]): 이동 평균 또는 롤링 평균을 적용합니다.
  • running_ymax (Optional[bool]): 이동 평균 또는 롤링 평균을 적용합니다.
  • running_ymean (Optional[bool]): 이동 평균 또는 롤링 평균을 적용합니다.
  • legend_template (Optional[str]): 범례 형식을 지정하는 string입니다.
  • gradient (Optional[LList[GradientPoint]]): 플롯의 색상 그라디언트를 지정하는 그라디언트 점 목록입니다.
  • font_size (Optional[FontSize]): 선형 플롯 글꼴 크기입니다. “small”, “medium”, “large”, “auto” 또는 None을 선택할 수 있습니다.
  • regression (Optional[bool]): True이면 산점도에 회귀선을 표시합니다.

클래스 SoundCloud

SoundCloud 플레이어를 렌더링하는 블록입니다. 속성:
  • html (str): SoundCloud 플레이어를 임베드하는 HTML 코드입니다.

클래스 Spotify

Spotify 플레이어를 렌더링하는 블록입니다. 속성:
  • spotify_id (str): 트랙 또는 플레이리스트의 Spotify ID입니다.

클래스 SummaryMetric

리포트에 표시할 summary 메트릭입니다. 속성:
  • name (str): 메트릭의 이름입니다.

클래스 TableOfContents

리포트에 지정된 H1, H2, H3 HTML 블록을 사용하여 섹션과 하위 섹션의 목록을 포함하는 블록입니다.

클래스 TextWithInlineComments

인라인 주석이 포함된 텍스트 블록입니다. 속성:
  • text (str): 블록의 텍스트입니다.

클래스 Twitter

Twitter 피드를 표시하는 블록입니다. 속성:
  • html (str): Twitter 피드를 표시할 HTML 코드입니다.

클래스 UnorderedList

글머리 기호로 표시되는 항목 목록입니다. 속성:
  • items (LList[TextLikeField]): 하나 이상의 UnorderedListItem 객체로 구성된 목록입니다. 각 항목은 string 또는 TextLike 객체 목록일 수 있습니다.

클래스 UnorderedListItem

순서 없는 목록의 목록 항목입니다. 속성:
  • text (str): 목록 항목의 텍스트입니다.

클래스 Video

비디오를 렌더링하는 블록입니다. 속성:
  • url (str): 비디오의 URL입니다.

클래스 WeaveBlockArtifact

W&B에 로깅된 아티팩트를 보여 주는 블록입니다. 쿼리는 다음 형식을 따릅니다.
API 이름의 “Weave”라는 용어는 LLM 추적 및 평가에 사용되는 W&B Weave 도구 모음을 가리키는 것이 아닙니다. 속성:
  • entity (str): 아티팩트가 저장된 프로젝트를 소유하거나 해당 프로젝트에 대한 적절한 권한을 가진 entity입니다.
  • project (str): 아티팩트가 저장된 프로젝트입니다.
  • artifact (str): 가져올 아티팩트의 이름입니다.
  • tab Literal["overview", "metadata", "usage", "files", "lineage"]: 아티팩트 패널에 표시할 탭입니다.

클래스 WeaveBlockArtifactVersionedFile

W&B 아티팩트에 로깅된 버전 관리 파일을 표시하는 블록입니다. 쿼리는 다음 형식을 따릅니다.
API 이름의 “Weave”라는 용어는 LLM 추적 및 평가에 사용되는 W&B Weave 도구 모음을 가리키는 것이 아닙니다. 속성:
  • entity (str): 아티팩트가 저장된 프로젝트를 소유하거나 해당 프로젝트에 대한 적절한 권한을 가진 entity입니다.
  • project (str): 아티팩트가 저장된 프로젝트입니다.
  • artifact (str): 가져올 아티팩트의 이름입니다.
  • version (str): 가져올 아티팩트의 버전입니다.
  • file (str): 가져올 아티팩트에 저장된 파일의 이름입니다.

클래스 WeaveBlockSummaryTable

W&B Table, pandas 데이터프레임, 플롯 또는 W&B에 로깅한 기타 값을 표시하는 블록입니다. 쿼리는 다음 형식을 따릅니다.
API 이름의 “Weave”라는 용어는 LLM 추적 및 평가에 사용되는 W&B Weave 도구 모음을 가리키는 것이 아닙니다. 속성:
  • entity (str): 값이 로깅되는 프로젝트를 소유하거나 해당 프로젝트에 대한 적절한 권한을 가진 entity입니다.
  • project (str): 값이 로깅되는 프로젝트입니다.
  • table_name (str): table, 데이터프레임, 플롯 또는 값의 이름입니다.

클래스 WeavePanel

쿼리를 사용하여 맞춤형 콘텐츠를 표시할 수 있는 빈 쿼리 패널입니다. API 이름의 “Weave”라는 용어는 LLM 추적 및 평가에 사용되는 W&B Weave 도구 모음을 가리키는 것이 아닙니다.

클래스 WeavePanelArtifact

W&B에 로깅한 아티팩트를 표시하는 패널입니다. API 이름의 “Weave”라는 용어는 LLM 추적 및 평가에 사용되는 W&B Weave 도구 모음을 가리키는 것이 아닙니다. 속성:
  • artifact (str): 가져올 아티팩트의 이름입니다.
  • tab Literal["overview", "metadata", "usage", "files", "lineage"]: 아티팩트 패널에 표시할 탭입니다.

클래스 WeavePanelArtifactVersionedFile

W&B 아티팩트에 로깅된 버전 관리 파일을 표시하는 패널입니다.
API 이름의 “Weave”라는 용어는 LLM 추적 및 평가에 사용되는 W&B Weave 도구 모음을 가리키는 것이 아닙니다. 속성:
  • artifact (str): 가져올 아티팩트의 이름입니다.
  • version (str): 가져올 아티팩트의 버전입니다.
  • file (str): 가져올 아티팩트에 저장된 파일의 이름입니다.

클래스 WeavePanelSummaryTable

W&B Table, pandas 데이터프레임, 플롯 또는 W&B에 로깅된 기타 값을 표시하는 패널입니다. 쿼리 형식은 다음과 같습니다.
API 이름의 “Weave”라는 용어는 LLM을 추적하고 평가하는 데 사용되는 W&B Weave 도구 모음을 가리키는 것이 아닙니다. 속성:
  • table_name (str): table, 데이터프레임, 플롯 또는 값의 이름입니다.
  • layout (Layout): 위치와 크기를 포함한 패널의 레이아웃 설정입니다. Panel 기본 클래스에서 상속됨. 너비(w)와 높이(h)를 조정하는 데 사용합니다.
예시: 맞춤형 크기의 table을 표시하는 요약 table 패널이 포함된 리포트를 생성합니다.
레이아웃 매개변수는 패널 크기를 제어합니다.
  • w (width): 그리드 단위의 너비 (기본값: 8, 최대: 24)
    • h (height): 그리드 단위의 높이 (기본값: 6)
    • x (x-position): 그리드 내 가로 위치 (기본값: 0)
    • y (y-position): 그리드 내 세로 위치 (기본값: 0)
마지막 수정일 2026년 9월 30일