> ## Documentation Index > Fetch the complete documentation index at: https://wb-21fd5541-sdk-testing-latest.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Reports export const GitHubLink = ({url}) => GitHub 소스 코드 ; W\&B Report and Workspace API는 공개 미리보기 상태입니다. W\&B Reports API를 프로그래밍 방식으로 다루기 위한 Python 라이브러리입니다. ```python theme={null} import wandb_workspaces.reports.v2 as wr report = wr.Report( entity="entity", project="project", title="An amazing title", description="A descriptive description.", ) blocks = [ wr.PanelGrid( panels=[ wr.LinePlot(x="time", y="velocity"), wr.ScatterPlot(x="time", y="acceleration"), ] ) ] report.blocks = blocks report.save() ``` ## class `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`로 설정하면 데이터를 집계합니다. *** ## class `BlockQuote` 인용문 텍스트 블록입니다. **속성:** * `text` (str): 인용문 블록의 텍스트입니다. *** ## class `CalloutBlock` 콜아웃 텍스트 블록입니다. **속성:** * `text` (str): 콜아웃 텍스트입니다. *** ## class `CheckedList` 체크박스가 있는 항목 목록입니다. `CheckedList` 내에 하나 이상의 `CheckedListItem`을 추가합니다. **속성:** * `items` (LList\[CheckedListItem]): 하나 이상의 `CheckedListItem` 객체로 구성된 목록입니다. *** ## class `CheckedListItem` 체크박스가 있는 목록 항목입니다. `CheckedList` 안에 하나 이상의 `CheckedListItem`을 추가하세요. **속성:** * `text` (str): 목록 항목의 텍스트입니다. * `checked` (bool): 체크박스가 선택되어 있는지 여부입니다. 기본값은 `False`입니다. *** ## class `CodeBlock` 코드 블록입니다. **속성:** * `code` (str): 블록에 포함된 코드입니다. * `language` (Optional\[Language]): 코드의 언어입니다. 지정한 언어는 구문 강조 표시에 사용됩니다. 기본값은 "python"입니다. 옵션으로는 'javascript', 'python', 'css', 'json', 'html', 'markdown', 'yaml'이 있습니다. *** ## class `CodeComparer` 서로 다른 두 run 간의 코드를 비교하는 패널 객체입니다. **속성:** * `diff` (Literal\['split', 'unified']): 코드 차이를 표시하는 방식입니다. 옵션에는 "split" 및 "unified"가 있습니다. *** ## class `Config` run의 설정 객체에 로깅되는 메트릭입니다. 설정 객체는 일반적으로 `run.config[name] = ...`를 사용해 로깅하거나, 키-값 쌍으로 이루어진 딕셔너리 형태의 설정을 전달해 로깅합니다. 여기서 키는 메트릭의 이름이고 값은 해당 메트릭의 값입니다. **속성:** * `name` (str): 메트릭의 이름입니다. *** ## class `CustomChart` 맞춤형 차트를 표시하는 패널입니다. 차트는 Weave 쿼리로 정의됩니다. **속성:** * `query` (dict): 맞춤형 차트를 정의하는 쿼리입니다. 키는 필드 이름이고 값은 쿼리입니다. * `chart_name` (str): 맞춤형 차트의 제목입니다. * `chart_fields` (dict): 플롯의 축을 정의하는 키-값 쌍입니다. 여기서 키는 레이블이고 값은 메트릭입니다. * `chart_strings` (dict): 차트의 문자열을 정의하는 키-값 쌍입니다. *** ### classmethod `from_table` ```python theme={null} from_table( table_name: str, chart_fields: dict = None, chart_strings: dict = None ) ``` 테이블로 맞춤형 차트를 만듭니다. **인수:** * `table_name` (str): 테이블 이름입니다. * `chart_fields` (dict): 차트에 표시할 필드입니다. * `chart_strings` (dict): 차트에 표시할 문자열입니다. *** ## class `Gallery` 리포트와 URL을 갤러리 형태로 렌더링하는 블록입니다. **속성:** * `items` (List\[Union\[`GalleryReport`, `GalleryURL`]]): `GalleryReport` 및 `GalleryURL` 객체 목록입니다. *** ## class `GalleryReport` 갤러리의 리포트를 가리키는 레퍼런스입니다. **속성:** * `report_id` (str): 리포트의 ID입니다. *** ## class `GalleryURL` 외부 리소스를 가리키는 URL입니다. **속성:** * `url` (str): 리소스의 URL입니다. * `title` (Optional\[str]): 리소스의 제목입니다. * `description` (Optional\[str]): 리소스의 설명입니다. * `image_url` (Optional\[str]): 표시할 이미지의 URL입니다. *** ## class `GradientPoint` 그라디언트의 한 지점입니다. **속성:** * `color`: 지점의 색상입니다. * `offset`: 그라디언트에서 지점의 위치입니다. 값은 0과 100 사이여야 합니다. *** ## class `H1` 지정된 텍스트를 사용하는 H1 제목입니다. **속성:** * `text` (str): 제목의 텍스트입니다. * `collapsed_blocks` (Optional\[LList\["BlockTypes"]]): 제목이 접혔을 때 표시할 블록입니다. *** ## class `H2` 지정한 텍스트를 사용하는 H2 제목입니다. **속성:** * `text` (str): 제목 텍스트입니다. * `collapsed_blocks` (Optional\[LList\["BlockTypes"]]): 제목이 접혀 있을 때 표시할 하나 이상의 블록입니다. *** ## class `H3` 지정된 텍스트를 사용하는 H3 제목입니다. **속성:** * `text` (str): 제목 텍스트입니다. * `collapsed_blocks` (Optional\[LList\["BlockTypes"]]): 제목이 접혀 있을 때 표시할 하나 이상의 블록입니다. *** ## class `Heading` *** ## class `HorizontalRule` HTML 수평선. *** ## class `Image` 이미지를 표시하는 블록입니다. **속성:** * `url` (str): 이미지의 URL입니다. * `caption` (str): 이미지의 캡션입니다. 캡션은 이미지 아래에 표시됩니다. *** ## class `InlineCode` 인라인 코드입니다. 코드 뒤에 줄바꿈 문자를 추가하지 않습니다. **속성:** * `text` (str): 리포트에 표시할 코드입니다. *** ## class `InlineLatex` 인라인 LaTeX 마크다운입니다. LaTeX 마크다운 뒤에는 줄바꿈 문자를 추가하지 않습니다. **속성:** * `text` (str): 리포트에 표시할 LaTeX 마크다운입니다. *** ## class `LatexBlock` LaTeX 텍스트로 이루어진 블록입니다. **속성:** * `text` (str): LaTeX 텍스트입니다. *** ## class `Layout` 리포트의 패널 레이아웃입니다. 패널의 크기와 위치를 조정합니다. **속성:** * `x` (int): 패널의 x 위치입니다. * `y` (int): 패널의 y 위치입니다. * `w` (int): 패널의 너비입니다. * `h` (int): 패널의 높이입니다. *** ## class `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]): x 좌표를 밑이 10인 로그 스케일로 표시합니다. * `log_y` (Optional\[bool]): y 좌표를 밑이 10인 로그 스케일로 표시합니다. * `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축 형식입니다. 이 옵션은 맞춤형 메트릭을 정의한 경우 표시됩니다. 예를 들어 x축을 날짜 및 시간 형식으로 표시하려면 'datetime'을 지정할 수 있습니다. * `legend_fields` (Optional\[LList\[str]]): 범례에 포함할 필드입니다. * `metric_regex` (Optional\[str]): y축 메트릭과 일치하는 정규식 패턴입니다. 백엔드는 이 패턴을 사용해 일치하는 메트릭을 선택합니다. * `point_visualization_method` (Optional\[PointVizMethod]): 표시할 포인트가 너무 많을 때 포인트를 집계하는 데 사용하는 방법입니다. 옵션에는 "bucketing-gorilla"(데이터 포인트를 버킷으로 묶고 각 버킷의 min, max, avg를 표시해 이상치와 스파이크를 보존) 또는 "sampling"(더 빠르게 렌더링하기 위해 포인트를 무작위로 샘플링하지만 이상치를 놓칠 수 있음)이 있습니다. * `line_titles` (Optional\[Dict\[str, str]]): 각 시리즈의 표시 제목입니다. 키는 "{runId}:{metricName}" 형식입니다. * `line_colors` (Optional\[Dict\[str, Any]]): 각 시리즈의 색상입니다. 키는 "{runId}:{metricName}" 형식을 사용합니다. * `line_widths` (Optional\[Dict\[str, float]]): 시리즈별 선 두께입니다. 키는 "{runId}:{metricName}" 형식을 사용합니다. * `line_marks` (Optional\[Dict\[str, Mark]]): 시리즈별 대시 스타일입니다. 키는 "{runId}:{metricName}" 형식입니다. * `유효한 값`: "solid", "dashed", "dotted", "dotdash", "dotdotdash", "points". *** ## class `Link` URL로 연결되는 링크입니다. **속성:** * `text` (Union\[str, TextWithInlineComments]): 링크 텍스트입니다. * `url` (str): 링크가 가리키는 URL입니다. *** ## class `MarkdownBlock` 마크다운 텍스트 블록입니다. 일반적인 마크다운 문법을 사용하는 텍스트를 작성할 때 유용합니다. **속성:** * `text` (str): 마크다운 텍스트입니다. *** ## class `MarkdownPanel` 마크다운을 렌더링하는 패널입니다. **속성:** * `markdown` (str): 마크다운 패널에 표시할 텍스트입니다. *** ## class `MediaBrowser` 미디어 파일을 갤러리 또는 그리드 레이아웃으로 표시하는 패널입니다. **속성:** * `title` (Optional\[str]): 패널의 제목입니다. * `num_columns` (Optional\[int]): 그리드의 열 수입니다. * `media_keys` (LList\[str]): 미디어 파일에 해당하는 미디어 키 목록입니다. * `mode` (Optional\[Literal\["gallery", "grid"]]): 패널의 표시 모드입니다. 지정하지 않으면 지정된 축을 기준으로 추론됩니다. `gallery_axis`와 grid 축이 모두 지정된 경우 필수입니다. * `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축으로 사용할 필드입니다. *** ## class `Metric` 프로젝트에 로깅되어 리포트에 표시되는 메트릭입니다. **속성:** * `name` (str): 메트릭의 이름입니다. *** ## class `OrderBy` 정렬에 사용할 메트릭입니다. **속성:** * `name` (str): 메트릭 이름입니다. * `ascending` (bool): 오름차순으로 정렬할지 여부입니다. 기본값은 `False`입니다. *** ## class `OrderedList` 번호가 매겨진 목록의 항목을 나타냅니다. **속성:** * `items` (LList\[TextLikeField]): 하나 이상의 `OrderedListItem` 객체로 이루어진 목록입니다. 각 항목은 문자열이거나 TextLike 객체의 목록일 수 있습니다. *** ## class `OrderedListItem` 순서 있는 목록의 항목입니다. **속성:** * `text` (str): 목록 항목의 텍스트입니다. *** ## class `P` 텍스트 문단입니다. **속성:** * `text` (str): 문단의 텍스트입니다. *** ## class `Panel` 패널 그리드에 시각화를 표시하는 패널입니다. **속성:** * `layout` (Layout): `Layout` 객체입니다. *** ## class `PanelGrid` runset과 패널로 구성된 그리드입니다. `Runset` 객체와 `Panel` 객체를 사용해 각각 runset과 패널을 추가합니다. 사용 가능한 패널은 다음과 같습니다: `LinePlot`, `ScatterPlot`, `BarPlot`, `ScalarChart`, `CodeComparer`, `ParallelCoordinatesPlot`, `ParameterImportancePlot`, `RunComparer`, `MediaBrowser`, `MarkdownPanel`, `CustomChart`, `WeavePanel`, `WeavePanelSummaryTable`, `WeavePanelArtifactVersionedFile`. **속성:** * `runsets` (LList\["Runset"]): 하나 이상의 `Runset` 객체로 구성된 목록입니다. * `hide_run_sets` (bool): 리포트 뷰어에게 패널 그리드의 run set을 숨길지 여부입니다. * `panels` (LList\["PanelTypes"]): 하나 이상의 `Panel` 객체로 구성된 목록입니다. * `active_runset` (Optional\[int]): 현재 활성화된 runset 탭의 인덱스입니다. 기본값은 0입니다. * `custom_run_colors` (dict): 키는 run 이름이고 값은 16진수 값으로 지정된 색상인 키-값 쌍입니다. *** ## class `ParallelCoordinatesPlot` 병렬 좌표 플롯을 표시하는 패널 객체입니다. **속성:** * `columns` (LList\[ParallelCoordinatesPlotColumn]): 하나 이상의 `ParallelCoordinatesPlotColumn` 객체로 구성된 목록입니다. * `title` (Optional\[str]): 플롯 상단에 표시되는 텍스트입니다. * `gradient` (Optional\[LList\[GradientPoint]]): 그라디언트 포인트 목록입니다. * `font_size` (Optional\[FontSize]): 선형 플롯의 글꼴 크기입니다. 옵션에는 "small", "medium", "large", "auto" 또는 `None`이 있습니다. *** ## class `ParallelCoordinatesPlotColumn` 병렬 좌표 플롯 내의 열입니다. 지정한 `메트릭`의 순서에 따라 병렬 좌표 플롯의 병렬 축(x-axis) 순서가 정해집니다. **속성:** * `metric` (str | Config | SummaryMetric): 리포트가 정보를 가져오는 W\&B 프로젝트에 로깅된 메트릭의 이름입니다. * `display_name` (Optional\[str]): 메트릭의 이름입니다. * `inverted` (Optional\[bool]): 메트릭을 반전할지 여부입니다. * `log` (Optional\[bool]): 메트릭에 로그 변환을 적용할지 여부입니다. *** ## class `ParameterImportancePlot` 선택한 메트릭을 예측하는 데 각 하이퍼파라미터가 얼마나 중요한지 보여주는 패널입니다. **속성:** * `with_respect_to` (str): 파라미터 중요도를 비교할 기준 메트릭입니다. 일반적인 메트릭으로는 loss, accuracy 등이 있습니다. 지정한 메트릭은 리포트가 정보를 가져오는 프로젝트 내에 로깅되어 있어야 합니다. *** ## class `Report` W\&B 리포트를 나타내는 객체입니다. 반환된 객체의 `blocks` 속성을 사용해 리포트를 사용자 지정하세요. 리포트 객체는 자동으로 저장되지 않습니다. 변경 사항을 저장하려면 `save()` 메서드를 사용하세요. **속성:** * `project` (str): 로드할 W\&B 프로젝트의 이름입니다. 지정한 프로젝트는 리포트의 URL에 표시됩니다. * `entity` (str): 리포트를 소유한 W\&B entity입니다. entity는 리포트의 URL에 표시됩니다. * `title` (str): 리포트의 제목입니다. 제목은 리포트 상단에 H1 제목으로 표시됩니다. * `description` (str): 리포트에 대한 설명입니다. 설명은 리포트 제목 아래에 표시됩니다. * `blocks` (LList\[BlockTypes]): 하나 이상의 HTML 태그, plot, 그리드, runset 등이 포함된 목록입니다. * `width` (Literal\['readable', 'fixed', 'fluid']): 리포트의 너비입니다. 옵션에는 'readable', 'fixed', 'fluid'가 있습니다. *** ### 속성 url 리포트가 호스팅되는 URL입니다. 리포트 URL은 `https://wandb.ai/{entity}/{project_name}/reports/`로 구성됩니다. 여기서 `{entity}`는 리포트가 속한 entity이고, `{project_name}`는 프로젝트 이름입니다. *** ### 방법 `delete` ```python theme={null} delete() → bool ``` 이 리포트를 W\&B에서 삭제합니다. 이 리포트를 참조하는 모든 초안 뷰도 함께 삭제됩니다. **반환값:** * `bool`: 백엔드가 삭제 오퍼레이션의 성공을 확인하면 `True`, 그렇지 않으면 `False`입니다. *** ### 방법 `disable_share_link` ```python theme={null} disable_share_link() → bool ``` 이 리포트의 "링크가 있는 누구나 볼 수 있음" 공유 링크를 비활성화합니다. 리포트의 활성 상태인 모든 공개 액세스 토큰을 무효화합니다. **반환값:** * `bool`: 링크가 무효화되었으면 True, 활성 링크가 없으면 False. *** ### 방법 `enable_share_link` ```python theme={null} enable_share_link() → str ``` 이 리포트에 대해 "링크가 있는 모든 사용자가 볼 수 있음" 공유를 활성화합니다. 리포트의 공개 액세스 토큰을 생성합니다. 공유 링크가 이미 있으면 기존 링크를 반환합니다. **반환값:** * `str`: 공유할 수 있는 매직 링크 URL입니다. *** ### 클래스 메서드 `from_url` ```python theme={null} from_url(url: str, as_model: bool = False) ``` 현재 환경에 리포트를 불러옵니다. 리포트가 호스팅된 URL을 전달하세요. **인수:** * `url` (str): 리포트가 호스팅된 URL입니다. * `as_model` (bool): `True`이면 리포트 객체 대신 모델 객체를 반환합니다. 기본값은 `False`입니다. *** ### 방법 `get_share_url` ```python theme={null} get_share_url() → Optional[str] ``` 이 리포트의 매직 링크 URL을 가져옵니다. 공유가 활성화되지 않은 경우에는 `None`을 반환합니다. 활성 액세스 토큰을 확인하기 위해 네트워크 call을 수행합니다. 액세스 토큰이 추가된 리포트 URL을 반환하므로, 링크가 있는 사람은 프로젝트가 비공개여도 리포트를 볼 수 있습니다. *** ### 방법 `save` ```python theme={null} save(draft: bool = False, clone: bool = False) ``` 리포트 객체에 적용한 변경 사항을 저장합니다. *** ### 방법 `to_html` ```python theme={null} to_html(height: int = 1024, hidden: bool = False) → str ``` 이 리포트를 표시하는 iframe이 포함된 HTML을 생성합니다. 일반적으로 Python notebook 내에서 사용됩니다. **인수:** * `height` (int): iframe의 높이입니다. * `hidden` (bool): `True`이면 iframe을 숨깁니다. 기본값은 `False`입니다. *** ## class `RunComparer` 리포트가 정보를 가져오는 프로젝트의 서로 다른 run 전반에 걸쳐 메트릭을 비교하는 패널입니다. **속성:** * `diff_only` (Optional\[Literal\["split", `True`]]): 프로젝트 내 run 간 차이만 표시합니다. 이 기능은 W\&B Reports UI에서 켜거나 끌 수 있습니다. *** ## class `RunSettings` 리포트 패널 그리드에서 개별 run의 표시 방식과 가시성을 구성합니다. `RunSettings`를 사용하면 `Runset` 내에서 특정 run이 렌더링되는 방식을 사용자 지정할 수 있습니다. 여기에는 선 색상과 차트에서의 표시 여부가 포함됩니다. **속성:** * `color`: run의 표시 색상입니다. 16진수 형식(`#ff0000`), CSS 색상 이름(red), 또는 RGB 문자열("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을 필터링하기 위한 쿼리 문자열입니다. * `filters` (Union\[str, LList\[expr.FilterExpr]]): run에 적용할 필터입니다. 다음 중 하나일 수 있습니다: * 문자열 표현식: 예: "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 파라미터로 그룹화하려면 "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 툴바의 잠금 아이콘과 일치합니다. 열 형식: * 열은 `"
: "` 형식으로 지정합니다: * `run:`: 기본 제공 run 속성(예: `run:state`) * `config:.value`: config 키(`.value` 접미사에 유의하세요) * `summary:`: summary 메트릭 * `tags:__ALL__`: run 태그 열 제한: FE Runs table은 최대 500개 열까지만 표시합니다. 표시 집합(고정 + 표시 + column\_order, hidden 제외)이 500개에 도달하거나 이를 초과하면 SDK는 저장 시 경고를 출력합니다. 숨겨진 열은 개수에 포함되지 않습니다. SDK는 잘라내지 않고 전체 집합을 전송하며, 프런트엔드가 렌더링 시 제한을 강제 적용합니다. **예시:** ```python theme={null} # 문자열 필터 사용 wr.Runset( entity="my-entity", project="my-project", filters="Config('learning_rate') = 0.001 and State = 'finished'" ) # FilterExpr 목록 사용 wr.Runset( entity="my-entity", project="my-project", filters=[expr.Config("learning_rate") == 0.001] ) ``` *** ### 방법 `convert_filterexpr_list_to_string` ```python theme={null} convert_filterexpr_list_to_string() ``` FilterExpr 목록을 string 표현식으로 변환합니다. *** ### 방법 `merge_custom_run_colors_into_run_settings` ```python theme={null} merge_custom_run_colors_into_run_settings() ``` 하위 호환성을 위해 일반 문자열 키를 사용하는 custom\_run\_colors를 run\_settings로 병합합니다. *** ## class `RunsetGroup` runset 그룹을 표시하는 UI 요소입니다. **속성:** * `runset_name` (str): runset의 이름입니다. * `keys` (Tuple\[RunsetGroupKey, ...]): 그룹화에 사용할 키입니다. 그룹화 기준으로 하나 이상의 `RunsetGroupKey` 객체를 전달하세요. *** ## class `RunsetGroupKey` runset을 메트릭 유형과 값에 따라 그룹화합니다. `RunsetGroup`의 일부입니다. 그룹화 기준이 되는 메트릭 유형과 값을 키-값 쌍으로 지정합니다. **속성:** * `key` (Type\[str] | Type\[Config] | Type\[SummaryMetric] | Type\[Metric]): 그룹화 기준 메트릭의 유형입니다. * `value` (str): 그룹화 기준 메트릭의 값입니다. *** ## class `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 프로젝트에 로깅된 메트릭의 이름입니다. 지정한 메트릭이 x축에 사용됩니다. * `y Optional[SummaryOrConfigOnlyMetric]`: 리포트가 정보를 가져오는 W\&B 프로젝트에 로깅된 하나 이상의 메트릭입니다. 지정한 메트릭은 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]): 밑이 10인 로그 스케일을 사용해 x 좌표를 그립니다. * `log_y` (Optional\[bool]): 밑이 10인 로그 스케일을 사용해 y 좌표를 그립니다. * `log_z` (Optional\[bool]): 밑이 10인 로그 스케일을 사용해 z 좌표를 그립니다. * `running_ymin` (Optional\[bool]): 이동 평균 또는 롤링 평균을 적용합니다. * `running_ymax` (Optional\[bool]): 이동 평균 또는 롤링 평균을 적용합니다. * `running_ymean` (Optional\[bool]): 이동 평균 또는 롤링 평균을 적용합니다. * `legend_template` (Optional\[str]): 범례 형식을 지정하는 문자열입니다. * `gradient` (Optional\[LList\[GradientPoint]]): 플롯의 색상 그라디언트를 지정하는 그라디언트 포인트 목록입니다. * `font_size` (Optional\[FontSize]): 선형 플롯 글꼴 크기입니다. 옵션에는 "small", "medium", "large", "auto" 또는 `None`이 포함됩니다. * `regression` (Optional\[bool]): `True`이면 산점도에 회귀선을 그립니다. *** ## class `SoundCloud` SoundCloud 플레이어를 렌더링하는 블록입니다. **속성:** * `html` (str): SoundCloud 플레이어를 임베드하기 위한 HTML 코드입니다. *** ## class `Spotify` Spotify 플레이어를 렌더링하는 블록입니다. **속성:** * `spotify_id` (str): 트랙 또는 재생목록의 Spotify ID입니다. *** ## class `SummaryMetric` 리포트에 표시되는 요약 메트릭입니다. **속성:** * `name` (str): 메트릭의 이름입니다. *** ## class `TableOfContents` 리포트에 지정된 H1, H2, H3 HTML 블록을 사용해 섹션과 하위 섹션 목록을 표시하는 블록입니다. *** ## class `TextWithInlineComments` 인라인 주석이 포함된 텍스트 블록입니다. **속성:** * `text` (str): 블록의 텍스트입니다. *** ## class `Twitter` Twitter 피드를 표시하는 블록입니다. **속성:** * `html` (str): Twitter 피드를 표시할 HTML 코드입니다. *** ## class `UnorderedList` 글머리 기호 목록의 항목들로 이루어진 목록입니다. **속성:** * `items` (LList\[TextLikeField]): 하나 이상의 `UnorderedListItem` 객체로 이루어진 목록입니다. 각 항목은 문자열이거나 TextLike 객체의 목록일 수 있습니다. *** ## class `UnorderedListItem` 순서 없는 목록의 항목입니다. **속성:** * `text` (str): 항목의 텍스트입니다. *** ## class `Video` 비디오를 표시하는 블록입니다. **속성:** * `url` (str): 비디오의 URL입니다. *** ## class `WeaveBlockArtifact` W\&B에 로깅된 artifact를 표시하는 블록입니다. 쿼리는 다음 형식입니다. ```python theme={null} project('entity', 'project').artifact('artifact-name') ``` API 이름의 "Weave"라는 용어는 LLM 추적 및 평가에 사용되는 W\&B Weave 툴킷을 가리키는 것이 아닙니다. **속성:** * `entity` (str): artifact가 저장된 프로젝트를 소유하거나 해당 프로젝트에 대한 적절한 권한이 있는 entity입니다. * `project` (str): artifact가 저장된 프로젝트입니다. * `artifact` (str): 조회할 artifact의 이름입니다. * `tab Literal["overview", "metadata", "usage", "files", "lineage"]`: artifact 패널에 표시할 탭입니다. *** ## class `WeaveBlockArtifactVersionedFile` W\&B artifact에 로깅된 버전 관리 파일을 표시하는 블록입니다. 쿼리 형식은 다음과 같습니다 ```python theme={null} project('entity', 'project').artifactVersion('name', 'version').file('file-name') ``` API 이름의 "Weave"라는 용어는 LLM 추적 및 평가에 사용되는 W\&B Weave 툴킷을 가리키는 것이 아닙니다. **속성:** * `entity` (str): artifact가 저장된 프로젝트를 소유하거나 해당 프로젝트에 대한 적절한 권한이 있는 entity입니다. * `project` (str): artifact가 저장된 프로젝트입니다. * `artifact` (str): 조회할 artifact의 이름입니다. * `version` (str): 조회할 artifact의 버전입니다. * `file` (str): 조회할 artifact에 저장된 파일의 이름입니다. *** ## class `WeaveBlockSummaryTable` W\&B에 로깅된 W\&B Table, pandas 데이터프레임, 플롯 또는 기타 값을 표시하는 블록입니다. 쿼리는 다음 형식입니다 ```python theme={null} project('entity', 'project').runs.summary['value'] ``` API 이름의 "Weave"라는 용어는 LLM 추적 및 평가에 사용되는 W\&B Weave 툴킷을 가리키는 것이 아닙니다. **속성:** * `entity` (str): 값이 로깅되는 프로젝트를 소유하거나 해당 프로젝트에 대한 적절한 권한을 가진 entity입니다. * `project` (str): 값이 로깅되는 프로젝트입니다. * `table_name` (str): 테이블, 데이터프레임, 플롯 또는 값의 이름입니다. *** ## class `WeavePanel` 쿼리를 사용해 맞춤형 콘텐츠를 표시할 수 있는 빈 쿼리 패널입니다. API 이름의 "Weave"는 LLM을 추적하고 평가하는 데 사용되는 W\&B Weave 툴킷을 가리키는 것이 아닙니다. *** ## class `WeavePanelArtifact` W\&B에 로깅된 artifact를 보여주는 패널입니다. API 이름의 "Weave"라는 용어는 LLM 추적 및 평가에 사용되는 W\&B Weave 툴킷을 가리키는 것이 아닙니다. **속성:** * `artifact` (str): 조회할 artifact의 이름입니다. * `tab Literal["overview", "metadata", "usage", "files", "lineage"]`: artifact 패널에 표시할 탭입니다. *** ## class `WeavePanelArtifactVersionedFile` W\&B artifact에 로깅된 버전 관리 파일을 표시하는 패널입니다. ```python theme={null} project('entity', 'project').artifactVersion('name', 'version').file('file-name') ``` API 이름의 "Weave"는 LLM을 추적하고 평가하는 데 사용되는 W\&B Weave 툴킷을 가리키는 것이 아닙니다. **속성:** * `artifact` (str): 조회할 artifact의 이름입니다. * `version` (str): 조회할 artifact의 버전입니다. * `file` (str): 조회할 artifact에 저장된 파일의 이름입니다. *** ## class `WeavePanelSummaryTable` W\&B에 로깅된 W\&B Table, pandas DataFrame, plot 또는 기타 값을 표시하는 패널입니다. 쿼리는 다음 형식입니다. ```python theme={null} runs.summary['value'] ``` API 이름의 "Weave"라는 용어는 LLM 추적 및 평가에 사용되는 W\&B Weave 툴킷을 가리키는 것이 아닙니다. **속성:** * `table_name` (str): 테이블, 데이터프레임, 플롯 또는 값의 이름입니다. * `layout` (Layout): 위치와 크기를 포함하는 패널의 레이아웃 설정입니다. Panel 기본 클래스에서 상속됩니다. 너비(`w`)와 높이(`h`)를 조정할 때 사용합니다. **예시:** 맞춤형 크기의 테이블을 표시하는 summary table 패널이 포함된 리포트를 생성합니다: ```python theme={null} import wandb_workspaces.reports as wr report = wr.Report( project="my-project", entity="my-entity", title="Summary Table Report" ) report.blocks = [ wr.PanelGrid( runsets=[wr.Runset(project="my-project")], panels=[ wr.WeavePanelSummaryTable( table_name="my-table-name", layout=wr.Layout(w=24, h=20) ) ] ) ] report.save() ``` 레이아웃 파라미터는 패널의 크기를 제어합니다: * w (너비): 그리드 단위의 너비(기본값: 8, 최대: 24) * h (높이): 그리드 단위의 높이(기본값: 6) * x (x 위치): 그리드 내 가로 위치(기본값: 0) * y (y 위치): 그리드 내 세로 위치(기본값: 0)