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

# Sweep

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/sweeps.py" />

## <kbd>class</kbd> `Sweep`

sweep에 연결된 run 집합입니다.

**속성:**

* `runs` (Runs):  run 목록
* `id` (str):  Sweep ID
* `project` (str):  sweep가 속한 프로젝트 이름
* `config` (dict):  sweep 설정이 포함된 사전
* `state` (str):  sweep의 상태입니다. "Finished", "Failed", "Crashed" 또는 "Running"일 수 있습니다.
* `expected_run_count` (int):  sweep의 예상 run 수

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

```python theme={null}
__init__(
    service_api: 'ServiceApi',
    entity: 'str',
    project: 'str',
    sweep_id: 'str',
    attrs: 'Mapping[str, Any] | None' = None
)
```

***

### <kbd>속성</kbd> Sweep.config

해당 sweep에 사용되는 설정입니다.

***

### <kbd>속성</kbd> Sweep.entity

sweep에 연결된 entity입니다.

**반환값:**

* `str`: entity 속성 값.

***

### <kbd>속성</kbd> Sweep.expected\_run\_count

Sweep의 예상 run 수를 반환합니다. run 수가 무한한 경우 `None`을 반환합니다.

**반환값:**

* `int | None`: expected\_run\_count 속성 값입니다.

***

### <kbd>속성</kbd> Sweep.name

sweep의 이름입니다.

다음 우선순위에 따라 가장 먼저 존재하는 이름을 반환합니다:

1. 사용자가 수정한 표시 이름 2. 생성 시 설정한 이름 3. Sweep ID

***

### <kbd>속성</kbd> Sweep.order

Sweep의 순서 키를 반환합니다.

***

### <kbd>속성</kbd> Sweep.path

프로젝트 경로를 반환합니다.

이 경로는 entity, 프로젝트 이름, sweep ID로 구성된 목록입니다.

***

### <kbd>속성</kbd> Sweep.url

sweep의 URL입니다.

sweep URL은 entity, 프로젝트, "sweeps"라는 문자열, 그리고 sweep ID.run\_id를 조합해 생성됩니다. SaaS 사용자의 경우 `https://wandb.ai/entity/project/sweeps/sweeps_ID` 형식을 사용합니다.

***

### <kbd>속성</kbd> Sweep.username

사용 중단되었습니다. 대신 `Sweep.entity`를 사용하세요.

**반환값:**

* `str`: `username` 속성 값입니다.

***

### <kbd>방법</kbd> `Sweep.agent`

```python theme={null}
agent(agent_id: 'str') → Agent
```

이 스윕에서 ID로 에이전트를 쿼리합니다.

**인수:**

* `agent_id`: 조회할 에이전트의 ID입니다.

***

### <kbd>방법</kbd> `Sweep.agents`

```python theme={null}
agents() → list[Agent]
```

이 스윕의 모든 에이전트 목록을 쿼리합니다.

***

### <kbd>방법</kbd> `Sweep.best_run`

```python theme={null}
best_run(order=None)
```

설정에 정의된 메트릭 또는 전달된 순서를 기준으로 정렬된 최상의 run을 반환합니다.

***

### <kbd>클래스 메서드</kbd> `Sweep.get`

```python theme={null}
get(
    api: 'Api',
    entity: 'str | None' = None,
    project: 'str | None' = None,
    sid: 'str | None' = None,
    order: 'str | None' = None,
    query: 'str | None' = None,
    **kwargs
)
```

클라우드 백엔드에 쿼리를 실행합니다.

**인수:**

* `api`:  W\&B API 인스턴스입니다.
* `entity`:  프로젝트를 소유한 entity(사용자 이름 또는 팀)입니다.
* `project`:  스윕를 가져올 프로젝트 이름입니다.
* `sid`:  쿼리할 스윕 ID입니다.
* `order`:  스윕의 run이 반환되는 순서입니다.
* `query`:  쿼리 실행에 사용할 쿼리입니다.
* `**kwargs`:  쿼리에 전달할 추가 키워드 매개변수입니다.

***

### <kbd>방법</kbd> `Sweep.to_html`

```python theme={null}
to_html(height: 'int' = 420, hidden: 'bool' = False) → str
```

이 sweep을 표시하는 iframe이 포함된 HTML을 생성합니다.