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

# Runs

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "ソースを表示" : <>
    <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 compact url="https://github.com/wandb/wandb/blob/main/wandb/apis/public/runs.py#L188" />

## <Badge color="yellow" size="lg" shape="rounded">クラス</Badge> wandb.apis.public.Runs

project と省略可能なフィルターに関連付けられた `Run` オブジェクトの遅延イテレーターです。

必要に応じて、Runs は W\&B サーバーからページ単位で取得されます。

これは通常、`Api.runs` 名前空間を通じて間接的に使用されます。

```python theme={null}
(service_api: 'ServiceApi',
entity: 'str',
project: 'str',
filters: 'dict[str, Any] | None' = None,
order: 'str' = '+created_at',
per_page: 'int' = 50,
include_sweeps: 'bool' = False,
lazy: 'bool' = True,
api_key: 'str | None' = None)
```

<div id="args">
  ## 引数
</div>

<ResponseField name="service_api" type="ServiceApi">
  リクエストに使用するサービス API。
</ResponseField>

<ResponseField name="entity" type="str">
  project を所有する entity (ユーザー名またはチーム) 。
</ResponseField>

<ResponseField name="project" type="str">
  run を取得する project の名。
</ResponseField>

<ResponseField name="filters" type="dict[str, Any] | None">
  run のクエリに適用するフィルター。
</ResponseField>

<ResponseField name="order" type="str">
  `created_at`、`heartbeat_at`、`config.*.value`、または `summary_metrics.*` を指定できます。先頭に `+` を付けると昇順 (デフォルト) 、`-` を付けると降順になります。デフォルトの並び順は `run.created_at` で、古いものから新しいものへ並びます。
</ResponseField>

<ResponseField name="per_page" type="int">
  リクエストごとに取得する run の数 (デフォルトは 50) 。
</ResponseField>

<ResponseField name="include_sweeps" type="bool">
  run に sweep 情報を含めるかどうか。デフォルトは True です。
</ResponseField>

<ResponseField name="lazy" type="bool">
  アクセスされるまで重いフィールド (`config`、`summaryMetrics`、`systemMetrics`) の読み込みを遅延させるかどうか。デフォルトは True です。
</ResponseField>

<ResponseField name="api_key" type="str | None">
  説明はありません。
</ResponseField>

<div id="methods">
  ## メソッド
</div>

### <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Runs.histories()

```python theme={null}
self,
samples: 'int' = 500,
keys: 'list[str] | None' = None,
x_axis: 'str' = '_step',
format: "Literal['default', 'pandas', 'polars']" = 'default',
stream: "Literal['default', 'system']" = 'default'
```

フィルター条件に一致するすべての run について、サンプリングされた履歴メトリクスを返します。

<div id="arguments">
  ##### 引数
</div>

<ResponseField name="samples" type="int">
  run ごとに返すサンプル数
</ResponseField>

<ResponseField name="keys" type="list[str] | None">
  指定したキーのメトリクスのみを返します
</ResponseField>

<ResponseField name="x_axis" type="str">
  x 軸として使用するメトリクス。デフォルトは \_step です
</ResponseField>

<ResponseField name="format" type="Literal['default', 'pandas', 'polars']">
  データの返却形式。"default"、"pandas"、"polars" を指定できます
</ResponseField>

<ResponseField name="stream" type="Literal['default', 'system']">
  メトリクスには "default"、システムメトリクスには "system"
</ResponseField>

### <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> ページネーター.**next**()

```python theme={null}
self
```

イテレーターから次の項目を返します。すべての項目を返し終えている場合は、StopIteration を送出します

### <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> ページネーター.update\_variables()

```python theme={null}
self
```

次のページのフェッチに使用するクエリ変数を更新します。

### <Badge color="blue" size="lg" shape="rounded">メソッド</Badge> Runs.upgrade\_to\_full()

```python theme={null}
self
```

この Runs コレクションを 遅延 モードから full モードにアップグレードします。

これにより、完全な run データを取得するように切り替わり、
すでに読み込まれている Run オブジェクトも完全なデータを持つようになります。
複数の run をアップグレードする場合は、パフォーマンス向上のために並列読み込みを使用します。
