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

# Runs

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <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 source
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/main/wandb/apis/public/runs.py" />

## <kbd>class</kbd> `Runs`

プロジェクトに関連付けられ、オプションでフィルタリングされた `Run` オブジェクトのレイジーイテレータです。

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

通常、これは `Api.runs` ネームスペースを介して間接的に使用されます。

### <kbd>method</kbd> `Runs.__init__`

```python theme={null}
__init__(
    client: 'RetryingClient',
    entity: 'str',
    project: 'str',
    filters: 'dict[str, Any] | None' = None,
    order: 'str' = '+created_at',
    per_page: 'int' = 50,
    include_sweeps: 'bool' = True,
    lazy: 'bool' = True,
    api: 'public.Api | None' = None
)
```

**Args:**

* `client`: (`wandb.apis.public.RetryingClient`) リクエストに使用する API クライアント。
* `entity`: (str) プロジェクトを所有する Entities（ユーザー名またはチーム）。
* `project`: (str) Runs を取得する Projects の名前。
* `filters`: (Optional\[Dict\[str, Any]]) Runs クエリに適用するフィルタの辞書。
* `order`: (str) ソート順。`created_at`、`heartbeat_at`、`config.*.value`、または `summary_metrics.*` が指定可能です。先頭に `+` を付けると昇順（デフォルト）、`-` を付けると降順になります。デフォルトの順序は `run.created_at` で、古いものから新しい順です。
* `per_page`: (int) 1回のリクエストで取得する Runs の数（デフォルトは 50）。
* `include_sweeps`: (bool) Runs に Sweeps の情報を含めるかどうか。デフォルトは True です。

***

### <kbd>property</kbd> Runs.length

***

### <kbd>method</kbd> `Runs.histories`

```python theme={null}
histories(
    samples: 'int' = 500,
    keys: 'list[str] | None' = None,
    x_axis: 'str' = '_step',
    format: "Literal['default', 'pandas', 'polars']" = 'default',
    stream: "Literal['default', 'system']" = 'default'
) → list[dict[str, Any]] | pd.DataFrame | pl.DataFrame
```

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

**Args:**

* `samples`: 各 Run ごとに返されるサンプル数。
* `keys`: 特定のキーのメトリクスのみを返します。
* `x_axis`: X軸として使用するメトリクス。デフォルトは `_step` です。
* `format`: データを返す形式。オプションは "default"、"pandas"、"polars" です。
* `stream`: メトリクスの場合は "default"、マシンメトリクスの場合は "system" を指定します。

**Returns:**

* `pandas.DataFrame`: `format="pandas"` の場合、履歴メトリクスの `pandas.DataFrame` を返します。
* `polars.DataFrame`: `format="polars"` の場合、履歴メトリクスの `polars.DataFrame` を返します。
* `list of dicts`: `format="default"` の場合、`run_id` キーを含む履歴メトリクスの辞書のリストを返します。

***

### <kbd>method</kbd> `Runs.upgrade_to_full`

```python theme={null}
upgrade_to_full() → None
```

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

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