> ## 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.

# 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 소스 코드
  </a>;

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

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

프로젝트 및 선택 필터와 연결된 `Run` 객체의 lazy 이터레이터입니다.

필요할 때 W\&B Server에서 페이지 단위로 Runs를 조회합니다.

일반적으로 `Api.runs` 네임스페이스를 통해 간접적으로 사용됩니다.

### <kbd>방법</kbd> `Runs.__init__`

```python theme={null}
__init__(
    service_api: 'ServiceApi',
    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_key: 'str | None' = None
)
```

**매개변수:**

* `service_api`:  요청에 사용할 서비스 API입니다.
* `entity`:  프로젝트를 소유한 entity(사용자 이름 또는 팀)입니다.
* `project`:  run을 가져올 프로젝트 이름입니다.
* `filters`:  run 쿼리에 적용할 필터입니다.
* `order`:  `created_at`, `heartbeat_at`, `config.*.value`, 또는 `summary_metrics.*`를 사용할 수 있습니다. 앞에 `+`를 붙이면 오름차순(기본값)이고, `-`를 붙이면 내림차순입니다. 기본 정렬 순서는 가장 오래된 항목부터 최신 항목까지의 `run.created&#95;at`입니다.
* `per_page`:  요청당 가져올 run 수입니다(기본값: 50).
* `include_sweeps`:  run에 sweep 정보를 포함할지 여부입니다. 기본값은 True입니다.

***

### <kbd>속성</kbd> Runs.length

***

### <kbd>방법</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
```

필터 조건에 맞는 모든 run의 샘플링된 이력 메트릭을 반환합니다.

**매개변수:**

* `samples`:  각 run별로 반환할 샘플 수
* `keys`:  특정 키에 대한 메트릭만 반환합니다
* `x_axis`:  이 메트릭을 xAxis로 사용하며, 기본값은 \_step입니다
* `format`:  데이터를 반환할 형식입니다. 옵션은 "default", "pandas", "polars"입니다
* `stream`:  메트릭에는 "default", 시스템 메트릭에는 "system"을 사용합니다

**반환값:**

* `pandas.DataFrame`:  `format="pandas"`인 경우, 이력 메트릭이 담긴 `pandas.DataFrame`을 반환합니다.
* `polars.DataFrame`:  `format="polars"`인 경우, 이력 메트릭이 담긴 `polars.DataFrame`을 반환합니다.
* `list of dicts`:  `format="default"`인 경우, `run_id` 키를 포함한 이력 메트릭이 담긴 `dict` 목록을 반환합니다.

***

### <kbd>방법</kbd> `Runs.upgrade_to_full`

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

이 Runs collection을 lazy 모드에서 전체 모드로 업그레이드합니다.

그러면 전체 run 데이터를 가져오도록 전환되며, 이미 로드된 모든 Run 객체도 전체 데이터를 포함하도록 업그레이드됩니다. 여러 run을 업그레이드할 때 성능을 높이기 위해 병렬 로딩을 사용합니다.
