Reports - CoreWeave Docs

W&B Report and Workspace API は Public Preview です。

W&B Reports API をプログラムで操作するための Python ライブラリです。

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()

`クラス` `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]): report が情報を取得する 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 内に 1 つ以上の CheckedListItem を追加します。 属性:

items (LList[CheckedListItem]): 1 つ以上の CheckedListItem オブジェクトのリスト。

`クラス` `CheckedListItem`

チェックボックス付きのリストアイテムです。CheckedList 内に 1 つ以上の CheckedListItem を追加します。 属性:

text (str): リストアイテムのテキスト。
checked (bool): チェックボックスがオンかどうか。デフォルトは False です。

`クラス` `CodeBlock`

コードのブロック。 属性:

code (str): ブロック内のコード。
language (Optional[Language]): コードの言語。指定された言語は構文ハイライトに使用されます。デフォルトでは “python” に設定されます。オプションには ‘javascript’, ‘python’, ‘css’, ‘json’, ‘html’, ‘markdown’, ‘yaml’ が含まれます。

`クラス` `CodeComparer`

2 つの異なる 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): チャート内の strings を定義するキーと値のペアです。

`クラスメソッド` `from_table`

from_table(
    table_name: str,
    chart_fields: dict = None,
    chart_strings: dict = None
)

表からカスタムチャートを作成する。 引数:

table_name (str): 表の名.
chart_fields (dict): チャートに表示するフィールド.
chart_strings (dict): チャートに表示する strings.

`クラス` `Gallery`

report と 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”]]): 見出しが折りたたまれたときに表示する 1 つ以上のブロック。

`クラス` `H3`

指定されたテキストを持つ H3 見出し。 属性:

text (str): 見出しのテキスト。
collapsed_blocks (Optional[LList[“BlockTypes”]]): 見出しが折りたたまれたときに表示する 1 つ以上のブロック。

`クラス` `Heading`

`クラス` `HorizontalRule`

HTML の水平線。

`クラス` `Image`

画像をレンダリングするブロックです。 属性:

url (str): 画像の URL。
caption (str): 画像のキャプション。キャプションは画像の下に表示されます。

`クラス` `InlineCode`

インラインコード。コードの後に改行文字を追加しません。 属性:

text (str): report に表示させたいコード。

`クラス` `InlineLatex`

Inline LaTeX Markdown。LaTeX Markdown の後に改行文字を追加しません。 属性:

text (str): report に表示したい LaTeX Markdown。

`クラス` `LatexBlock`

LaTeX テキストのブロックです。 属性:

text (str): LaTeX テキスト。

`クラス` `Layout`

report 内のパネルのレイアウト。パネルのサイズと位置を調整します。 属性:

x (int): パネルの x 位置。
y (int): パネルの y 位置。
w (int): パネルの幅。
h (int): パネルの高さ。

`クラス` `LinePlot`

パネルオブジェクトで、2Dの折れ線グラフを表示します。 属性:

title (Optional[str]): プロットの上部に表示されるテキスト。
x (Optional[MetricType]): report が情報を取得する W&B project にログされたメトリクスの名。指定したメトリクスが X 軸に使用されます。
y (LList[MetricType]): report が情報を取得する W&B project にログされた 1 つ以上のメトリクス。指定したメトリクスが 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]): report が情報を取得する W&B project にログされたメトリクスに基づいて 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” (データポイントをバケットに分け、バケットごとの最小値、最大値、平均値を表示して外れ値やスパイクを保持) または “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]]): 各時系列の破線スタイル。キーは ”:” の形式を使用します。
有効な値: “solid”, “dashed”, “dotted”, “dotdash”, “dotdotdash”, “points”.

`クラス` `Link`

URL へのリンク。 属性:

text (Union[str, TextWithInlineComments]): リンクのテキスト。
url (str): リンク先の URL。

`クラス` `MarkdownBlock`

Markdown テキストのブロックです。一般的な Markdown 構文を使用するテキストを書く場合に便利です。 属性:

text (str): Markdown テキストです。

`クラス` `MarkdownPanel`

Markdown をレンダリングするパネルです。 属性:

markdown (str): Markdown パネルに表示するテキストです。

`クラス` `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`

project にログされ、report に表示されるメトリクスです。 属性:

name (str): メトリクス名です。

`クラス` `OrderBy`

並べ替えの基準となるメトリクスです。 属性:

name (str): メトリクス名です。
ascending (bool): 昇順で並べ替えるかどうかを指定します。デフォルトでは False に設定されます。

`クラス` `OrderedList`

番号付きリストの項目のリストです。 属性:

items (LList[TextLikeField]): 1 つ以上の OrderedListItem オブジェクトのリストです。各項目は string または TextLike オブジェクトのリストにできます。

`クラス` `OrderedListItem`

番号付きリストの項目です。 属性:

text (str): リスト項目のテキストです。

`クラス` `P`

テキストの段落です。 属性:

text (str): 段落のテキストです。

`クラス` `Panel`

パネルグリッド内で可視化を表示するパネルです。 属性:

layout (Layout): Layout オブジェクト。

`クラス` `PanelGrid`

runset とパネルで構成されるグリッドです。Runset オブジェクトと Panel オブジェクトをそれぞれ使用して runset とパネルを追加します。利用可能なパネルには、LinePlot、ScatterPlot、BarPlot、ScalarChart、CodeComparer、ParallelCoordinatesPlot、ParameterImportancePlot、RunComparer、MediaBrowser、MarkdownPanel、CustomChart、WeavePanel、WeavePanelSummaryTable、WeavePanelArtifactVersionedFile が含まれます。 属性:

runsets (LList[“Runset”]): 1 つ以上の Runset オブジェクトのリスト。
hide_run_sets (bool): report のビューアーに対してパネルグリッドの run set を非表示にするかどうか。
panels (LList[“PanelTypes”]): 1 つ以上の Panel オブジェクトのリスト。
active_runset (Optional[int]): アクティブな runset タブのインデックス。デフォルトでは 0 に設定されます。
custom_run_colors (dict): キーが run の名、値が 16 進数値で指定された色であるキーと値のペア。

`クラス` `ParallelCoordinatesPlot`

平行座標プロットを表示するパネルオブジェクトです。 属性:

columns (LList[ParallelCoordinatesPlotColumn]): 1 つ以上の ParallelCoordinatesPlotColumn オブジェクトのリストです。
title (Optional[str]): プロットの上部に表示されるテキストです。
gradient (Optional[LList[GradientPoint]]): グラデーションポイントのリストです。
font_size (Optional[FontSize]): 折れ線グラフのフォントサイズです。指定できる値は “small”、“medium”、“large”、“auto”、または None です。

`クラス` `ParallelCoordinatesPlotColumn`

平行座標プロット内の列です。指定した metric の順序によって、平行座標プロットの平行軸 (X 軸) の順序が決まります。 属性:

metric (str | Config | SummaryMetric): report が情報を取得する W&B プロジェクトにログしたメトリクスの名です。
display_name (Optional[str]): メトリクスの名です
inverted (Optional[bool]): メトリクスを反転するかどうかを指定します。
log (Optional[bool]): メトリクスに対数変換を適用するかどうかを指定します。

`クラス` `ParameterImportancePlot`

選択したメトリクスの予測において、各ハイパーパラメーターがどれほど重要かを示すパネルです。 属性:

with_respect_to (str): パラメーター重要度の比較対象にするメトリクスです。一般的なメトリクスには、損失、精度などがあります。指定するメトリクスは、report が情報を取得する project 内でログされている必要があります。

`クラス` `Report`

W&B Report を表すオブジェクトです。返されたオブジェクトの blocks 属性を使用して report をカスタマイズします。Report オブジェクトは自動的には保存されません。変更を保存するには save() メソッドを使用してください。 属性:

project (str): 読み込む W&B プロジェクトの名。指定した project は report の URL に表示されます。
entity (str): report を所有する W&B entity。entity は report の URL に表示されます。
title (str): report のタイトル。タイトルは report の上部に H1 見出しとして表示されます。
description (str): report の説明。説明は report のタイトルの下に表示されます。
blocks (LList[BlockTypes]): 1 つ以上の HTML タグ、プロット、グリッド、runset などのリスト。
width (Literal[‘readable’, ‘fixed’, ‘fluid’]): report の幅。オプションには ‘readable’、‘fixed’、‘fluid’ があります。

`プロパティ` url

report がホストされている URL です。report の URL は https://wandb.ai/{entity}/{project_name}/reports/ で構成されます。{entity} と {project_name} は、それぞれ report が属する entity とプロジェクト名を表します。

`メソッド` `delete`

delete() → bool

この report を W&B から削除します。この report を参照する下書きビューも削除されます。 戻り値:

bool: バックエンドが削除操作の成功を確認した場合は True、それ以外の場合は False。

`メソッド` `disable_share_link`

disable_share_link() → bool

この report の “リンクを知っている全員が閲覧可能” な共有リンクを無効にします。この report の有効な公開アクセストークンをすべて失効させます。 戻り値:

bool: リンクが失効した場合は True、有効なリンクが存在しなかった場合は False。

`メソッド` `enable_share_link`

enable_share_link() → str

この report で”リンクを知っている全員が閲覧可能”な共有を有効にします。 report の公開アクセストークンを作成します。共有リンクがすでに存在する場合は、既存のリンクを返します。 戻り値

str: 共有可能なマジックリンクの URL です。

`クラスメソッド` `from_url`

from_url(url: str, as_model: bool = False)

report を現在の環境に読み込みます。report がホストされている URL を渡します。 引数:

url (str): report がホストされている URL。
as_model (bool): True の場合、Report オブジェクトではなくモデルオブジェクトを返します。デフォルトでは False に設定されています。

`メソッド` `get_share_url`

get_share_url() → Optional[str]

この report のマジックリンク URL を取得します。共有が有効でない場合は None を返します。ネットワーク呼び出しを行い、有効なアクセストークンを確認します。アクセストークンを付加した report の URL を返します。このリンクを持つユーザーは、project が非公開でも report を閲覧できます。

`メソッド` `save`

save(draft: bool = False, clone: bool = False)

report オブジェクトに加えた変更を永続化します。

`メソッド` `to_html`

to_html(height: int = 1024, hidden: bool = False) → str

この report を表示する iframe を含む HTML を生成します。通常、Python ノートブック内で使用します。 引数:

height (int): iframe の高さ。
hidden (bool): True の場合、iframe を非表示にします。デフォルトは False です。

`クラス` `RunComparer`

report が情報を取得する project の異なる run 間でメトリクスを比較するパネルです。 属性:

diff_only (Optional[Literal[“split”, True]]): project 内の run 間の差分のみを表示します。W&B Report UI でこの機能のオンとオフを切り替えられます。

`クラス` `RunSettings`

report のパネルグリッドで、個々の run の表示外観と可視性を設定します。 RunSettings を使用して、線の色やチャートでの可視性など、Runset 内で特定の run をどのようにレンダリングするかをカスタマイズします。 属性:

color: run の表示色です。16 進形式 (#ff0000)、CSS の色名 (red)、または RGB string (“rgb(255,0,0)”) を受け入れます。
disabled: True の場合、チャートで run を非表示にします。これは、UI で閉じた目のアイコンをクリックする操作と同じです。

`クラス` `Runset`

パネルグリッドに表示する run の集合です。 属性:

entity (str): run が保存されている project を所有するか、その project に対する適切な権限を持つ entity です。
project (str): run が保存されているプロジェクト名です。
name (str): run set 名です。デフォルトでは 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.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]): 次の左側に固定する列アクセサーです:
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]): run テーブルの列の集合に対する任意のロックです。True は pinned_columns と visible_columns のみを表示します。False または None (デフォルト) では制限しません。run テーブルのツールバーにあるロックアイコンに対応します。

列の形式:

列は "<section>: <name>" の形式で指定します:
- run:<attr>: run の組み込みプロパティ (例: run:state)
- config:<key>.value: 設定キー (接尾辞 .value に注意してください)
- summary:<key>: サマリーメトリクス
- tags:__ALL__: run のタグ

列の上限: フロントエンドの run テーブルは最大 500 列を表示します。表示する列の集合 (固定列 + 表示列 + column_order から非表示列を除いたもの) が 500 列以上になると、SDK は保存時に警告を出します。非表示列はカウントされません。SDK は列を切り捨てません。すべての列が送信され、フロントエンドがレンダリング時に上限を適用します。例:

    # string フィルターを使用します
    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`

convert_filterexpr_list_to_string()

FilterExpr のリストを string の式に変換します。

`メソッド` `merge_custom_run_colors_into_run_settings`

merge_custom_run_colors_into_run_settings()

後方互換性のために、通常の string をキーとする custom_run_colors を run_settings にマージします。

`クラス` `RunsetGroup`

runset のグループを表示する UI 要素です。 属性:

runset_name (str): runset の名です。
keys (Tuple[RunsetGroupKey, …]): グループ化に使用するキーです。グループ化に使用する RunsetGroupKey オブジェクトを 1 つ以上渡します。

`クラス` `RunsetGroupKey`

メトリクスのタイプと値で runset をグループ化します。RunsetGroup の一部です。グループ化に使用するメトリクスのタイプと値をキーと値のペアで指定します。 属性:

key (Type[str] | Type[Config] | Type[SummaryMetric] | Type[Metric]): グループ化に使用するメトリクスのタイプ。
value (str): グループ化に使用するメトリクスの値。

`クラス` `ScalarChart`

スカラーチャートを表示するパネルオブジェクトです。 属性:

title (Optional[str]): プロットの上部に表示されるテキストです。
metric (MetricType): report が情報を取得する、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]: report が情報を取得する、W&B プロジェクトにログされたメトリクスの名です。指定したメトリクスは X 軸に使用されます。
y Optional[SummaryOrConfigOnlyMetric]: report が情報を取得する、W&B プロジェクトにログされた 1 つ以上のメトリクスです。指定したメトリクスは 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]): 凡例の形式を指定する 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`

report に表示するサマリーメトリクスです。 属性:

name (str): メトリクスの名です。

`クラス` `TableOfContents`

report 内で指定された H1、H2、H3 HTML ブロックを使用して、セクションとサブセクションの一覧を含むブロックです。

`クラス` `TextWithInlineComments`

インラインコメントを含むテキストのブロックです。 属性:

text (str): ブロックのテキストです。

`クラス` `Twitter`

Twitter フィードを表示するブロックです。 属性:

html (str): Twitter フィードを表示するための HTML コードです。

`クラス` `UnorderedList`

箇条書きの項目のリストです。 属性:

items (LList[TextLikeField]): 1 つ以上の UnorderedListItem オブジェクトのリストです。各項目は string または TextLike オブジェクトのリストにできます。

`クラス` `UnorderedListItem`

順序なしリストの項目です。 属性:

text (str): リスト項目のテキストです。

`クラス` `Video`

動画をレンダリングするブロックです。 属性:

url (str): 動画の URL です。

`クラス` `WeaveBlockArtifact`

W&B にログされたアーティファクトを表示するブロックです。クエリは次の形式になります。

project('entity', 'project').artifact('artifact-name')

API 名の “Weave” は、LLM のトラッキングと評価に使用する W&B Weave ツールキットを指すものではありません。 属性:

entity (str): アーティファクトが保存されている project を所有するか、その project に対する適切な権限を持つ entity。
project (str): アーティファクトが保存されている project。
artifact (str): 取得するアーティファクトの名。
tab Literal["overview", "metadata", "usage", "files", "lineage"]: アーティファクトパネルに表示するタブ。

`クラス` `WeaveBlockArtifactVersionedFile`

W&B アーティファクトにログされたバージョン付きファイルを表示するブロックです。クエリは次の形式を取ります。

project('entity', 'project').artifactVersion('name', 'version').file('file-name')

API 名の “Weave” は、LLM のトラッキングと評価に使用する W&B Weave ツールキットを指すものではありません。 属性:

entity (str): アーティファクトが保存されている project を所有する、またはその project に対する適切な権限を持つ entity。
project (str): アーティファクトが保存されている project。
artifact (str): 取得するアーティファクトの名。
version (str): 取得するアーティファクトのバージョン。
file (str): 取得するアーティファクト内に保存されている file の名。

`クラス` `WeaveBlockSummaryTable`

W&B 表、pandas データフレーム、プロット、または W&B にログされたその他の値を表示するブロックです。クエリは次の形式を取ります。

project('entity', 'project').runs.summary['value']

API 名の “Weave” は、LLM のトラッキングと評価に使用する W&B Weave ツールキットを指すものではありません。 属性:

entity (str): 値がログされる project を所有するか、その project に対する適切な権限を持つ entity。
project (str): 値がログされる project。
table_name (str): 表、データフレーム、プロット、または値の名。

`クラス` `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 アーティファクトにログされたバージョン付きファイルを表示するパネルです。

project('entity', 'project').artifactVersion('name', 'version').file('file-name')

API 名の “Weave” は、LLM のトラッキングと評価に使用する W&B Weave ツールキットを指すものではありません。 属性:

artifact (str): 取得するアーティファクトの名。
version (str): 取得するアーティファクトのバージョン。
file (str): 取得する、アーティファクト内に保存された file の名。

`クラス` `WeavePanelSummaryTable`

W&B にログされた W&B 表、pandas データフレーム、プロット、またはその他の値を表示するパネルです。クエリは次の形式を取ります。

runs.summary['value']

API 名に含まれる “Weave” は、LLM のトラッキングと評価に使用する W&B Weave ツールキットを指すものではありません。 属性:

table_name (str): 表、データフレーム、プロット、または値の名。
layout (Layout): 位置とサイズを含む、パネルのレイアウト設定。 Panel 基底クラスから継承されます。幅 (w) と高さ (h) の調整に使用します。

例: カスタム寸法の表を表示するサマリー表パネルを含む report を作成します。

    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)

​クラス BarPlot

​クラス BlockQuote

​クラス CalloutBlock

​クラス CheckedList

​クラス CheckedListItem

​クラス CodeBlock

​クラス CodeComparer

​クラス Config

​クラス CustomChart

​クラスメソッド from_table

​クラス Gallery

​クラス GalleryReport

​クラス GalleryURL

​クラス GradientPoint

​クラス H1

​クラス H2

​クラス H3

​クラス Heading

​クラス HorizontalRule

​クラス Image

​クラス InlineCode

​クラス InlineLatex

​クラス LatexBlock

​クラス Layout

​クラス LinePlot

​クラス Link

​クラス MarkdownBlock

​クラス MarkdownPanel

​クラス MediaBrowser

​クラス Metric

​クラス OrderBy

​クラス OrderedList

​クラス OrderedListItem

​クラス P

​クラス Panel

​クラス PanelGrid

​クラス ParallelCoordinatesPlot

​クラス ParallelCoordinatesPlotColumn

​クラス ParameterImportancePlot

​クラス Report

​プロパティ url

​メソッド delete

​メソッド disable_share_link

​メソッド enable_share_link

​クラスメソッド from_url

​メソッド get_share_url

​メソッド save

​メソッド to_html

​クラス RunComparer

​クラス RunSettings

​クラス Runset

​メソッド convert_filterexpr_list_to_string

​メソッド merge_custom_run_colors_into_run_settings

​クラス RunsetGroup

​クラス RunsetGroupKey

​クラス ScalarChart

​クラス ScatterPlot

​クラス SoundCloud

​クラス Spotify

​クラス SummaryMetric

​クラス TableOfContents

​クラス TextWithInlineComments

​クラス Twitter

​クラス UnorderedList

​クラス UnorderedListItem

​クラス Video

​クラス WeaveBlockArtifact

​クラス WeaveBlockArtifactVersionedFile

​クラス WeaveBlockSummaryTable

​クラス WeavePanel

​クラス WeavePanelArtifact

​クラス WeavePanelArtifactVersionedFile

​クラス WeavePanelSummaryTable

`クラス` `BarPlot`

`クラス` `BlockQuote`

`クラス` `CalloutBlock`

`クラス` `CheckedList`

`クラス` `CheckedListItem`

`クラス` `CodeBlock`

`クラス` `CodeComparer`

`クラス` `Config`

`クラス` `CustomChart`

`クラスメソッド` `from_table`

`クラス` `Gallery`

`クラス` `GalleryReport`

`クラス` `GalleryURL`

`クラス` `GradientPoint`

`クラス` `H1`

`クラス` `H2`

`クラス` `H3`

`クラス` `Heading`

`クラス` `HorizontalRule`

`クラス` `Image`

`クラス` `InlineCode`

`クラス` `InlineLatex`

`クラス` `LatexBlock`

`クラス` `Layout`

`クラス` `LinePlot`

`クラス` `Link`

`クラス` `MarkdownBlock`

`クラス` `MarkdownPanel`

`クラス` `MediaBrowser`

`クラス` `Metric`

`クラス` `OrderBy`

`クラス` `OrderedList`

`クラス` `OrderedListItem`

`クラス` `P`

`クラス` `Panel`

`クラス` `PanelGrid`

`クラス` `ParallelCoordinatesPlot`

`クラス` `ParallelCoordinatesPlotColumn`

`クラス` `ParameterImportancePlot`

`クラス` `Report`

`プロパティ` url

`メソッド` `delete`

`メソッド` `disable_share_link`

`メソッド` `enable_share_link`

`クラスメソッド` `from_url`

`メソッド` `get_share_url`

`メソッド` `save`

`メソッド` `to_html`

`クラス` `RunComparer`

`クラス` `RunSettings`

`クラス` `Runset`

`メソッド` `convert_filterexpr_list_to_string`

`メソッド` `merge_custom_run_colors_into_run_settings`

`クラス` `RunsetGroup`

`クラス` `RunsetGroupKey`

`クラス` `ScalarChart`

`クラス` `ScatterPlot`

`クラス` `SoundCloud`

`クラス` `Spotify`

`クラス` `SummaryMetric`

`クラス` `TableOfContents`

`クラス` `TextWithInlineComments`

`クラス` `Twitter`

`クラス` `UnorderedList`

`クラス` `UnorderedListItem`

`クラス` `Video`

`クラス` `WeaveBlockArtifact`

`クラス` `WeaveBlockArtifactVersionedFile`

`クラス` `WeaveBlockSummaryTable`

`クラス` `WeavePanel`

`クラス` `WeavePanelArtifact`

`クラス` `WeavePanelArtifactVersionedFile`

`クラス` `WeavePanelSummaryTable`