line_series()

GitHub source

​

function line_series

line_series(
    xs: 'Iterable[Iterable[Any]] | Iterable[Any]',
    ys: 'Iterable[Iterable[Any]]',
    keys: 'Iterable[str] | None' = None,
    title: 'str' = '',
    xname: 'str' = 'x',
    split_table: 'bool' = False
) → CustomChart

折れ線グラフ（line series chart）を構築します。

Args:

• xs: x 値のシーケンス。単一の配列が渡された場合、すべての y 値はその x 配列に対してプロットされます。配列の配列が渡された場合、各 y 値は対応する x 配列に対してプロットされます。
• ys: y 値のシーケンス。各イテラブル（iterable）が個別のラインシリーズを表します。
• keys: 各ラインシリーズにラベルを付けるためのキーのシーケンス。指定されない場合、キーは “line_1”, “line_2” などとして自動生成されます。
• title: チャートのタイトル。
• xname: x 軸のラベル。
• split_table: W&B UI 上で テーブル を別のセクションに分割するかどうか。 True の場合、 テーブル は “Custom Chart Tables” という名前のセクションに表示されます。デフォルトは False です。

Returns:

• CustomChart: W&B に ログ 記録可能なカスタムチャート オブジェクト。チャートを ログ 記録するには、 wandb.log() に渡してください。

Examples: すべての y シリーズが同じ x 値に対してプロットされる、単一の x 配列を ログ 記録する場合：

import wandb

# W&B run を初期化
with wandb.init(project="line_series_example") as run:
    # すべての y シリーズで共有される x 値
    xs = list(range(10))

    # プロットする複数の y シリーズ
    ys = [
         [i for i in range(10)],  # y = x
         [i**2 for i in range(10)],  # y = x^2
         [i**3 for i in range(10)],  # y = x^3
    ]

    # 折れ線グラフを生成してログ記録
    line_series_chart = wandb.plot.line_series(
         xs,
         ys,
         title="title",
         xname="step",
    )
    run.log({"line-series-single-x": line_series_chart})

この例では、単一の xs シリーズ（共有 x 値）がすべての ys シリーズに使用されます。その結果、各 y シリーズは同じ x 値（0-9）に対してプロットされます。

各 y シリーズが対応する x 配列に対してプロットされる、複数の x 配列を ログ 記録する場合：

import wandb

# W&B run を初期化
with wandb.init(project="line_series_example") as run:
    # 各 y シリーズごとの個別の x 値
    xs = [
         [i for i in range(10)],  # 最初のシリーズの x
         [2 * i for i in range(10)],  # 2番目のシリーズの x (引き伸ばし)
         [3 * i for i in range(10)],  # 3番目のシリーズの x (さらに引き伸ばし)
    ]

    # 対応する y シリーズ
    ys = [
         [i for i in range(10)],  # y = x
         [i**2 for i in range(10)],  # y = x^2
         [i**3 for i in range(10)],  # y = x^3
    ]

    # 折れ線グラフを生成してログ記録
    line_series_chart = wandb.plot.line_series(
         xs, ys, title="Multiple X Arrays Example", xname="Step"
    )
    run.log({"line-series-multiple-x": line_series_chart})

この例では、各 y シリーズが独自の固有の x シリーズに対してプロットされます。これにより、データシリーズ間で x 値が一様でない場合に、より柔軟な対応が可能になります。

keys を使用してラインラベルをカスタマイズする場合：

import wandb

# W&B run を初期化
with wandb.init(project="line_series_example") as run:
    xs = list(range(10))  # 単一の x 配列
    ys = [
         [i for i in range(10)],  # y = x
         [i**2 for i in range(10)],  # y = x^2
         [i**3 for i in range(10)],  # y = x^3
    ]

    # 各ラインのカスタムラベル
    keys = ["Linear", "Quadratic", "Cubic"]

    # 折れ線グラフを生成してログ記録
    line_series_chart = wandb.plot.line_series(
         xs,
         ys,
         keys=keys,  # カスタムキー (ラインラベル)
         title="Custom Line Labels Example",
         xname="Step",
    )
    run.log({"line-series-custom-keys": line_series_chart})

この例では、 keys 引数を使用してラインにカスタムラベルを付ける方法を示しています。キーは凡例に “Linear”, “Quadratic”, “Cubic” として表示されます。