> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-dependabot-submodules-dot-claude-85784ca.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Sweep
export const GitHubLink = ({url}) =>
GitHub 소스 코드
;
## 클래스 wandb.apis.public.Sweep
```python theme={null}
(service_api: 'ServiceApi',
entity: 'str',
project: 'str',
sweep_id: 'str',
attrs: 'Mapping[str, Any] | None' = None)
```
스윕에 연결된 Runs 집합입니다.
* `runs` (`Runs`): Runs 목록
* `id` (`str`): 스윕 ID
* `project` (`str`): 스윕가 속한 프로젝트 이름
* `config` (`dict`): 스윕 설정이 포함된 사전
* `state` (`str`): 스윕의 상태입니다. "Finished", "Failed", "Crashed" 또는 "Running"일 수 있습니다.
* `expected_run_count` (`int`): 스윕의 예상 Runs 수
## 속성
### 속성 config
해당 스윕에 사용되는 설정입니다.
### 속성 entity
스윕에 연결된 entity입니다.
### 속성 expected\_run\_count
스윕의 예상 run 수를 반환합니다. run 수가 무한한 경우 `None`을 반환합니다.
### 속성 name
스윕의 이름입니다.
다음 우선순위에 따라 가장 먼저 존재하는 이름을 반환합니다:
1. 사용자가 수정한 표시 이름
2. 생성 시 설정한 이름
3. 스윕 ID
### 속성 order
스윕의 순서 키를 반환합니다.
### 속성 path
프로젝트 경로를 반환합니다.
이 경로는 entity, 프로젝트 이름, 스윕 ID로 구성된 목록입니다.
### 속성 url
스윕의 URL입니다.
스윕 URL은 entity, 프로젝트, "sweeps"라는 문자열, 그리고 스윕 ID.run\_id를 조합해 생성됩니다. SaaS 사용자의 경우 `https://wandb.ai/entity/project/sweeps/sweeps_ID` 형식을 사용합니다.
### 속성 username
사용 중단되었습니다. 대신 `Sweep.entity`를 사용하세요.
## 메서드
### 방법 Sweep.agent()
```python theme={null}
self,
agent_id: 'str'
```
이 스윕에서 ID로 에이전트를 쿼리합니다.
##### 인수
* `agent_id`: 조회할 에이전트의 ID입니다.
### 방법 Sweep.agents()
```python theme={null}
self
```
이 스윕의 모든 에이전트 목록을 쿼리합니다.
### 방법 Sweep.best\_run()
```python theme={null}
(self, order=None)
```
설정에 정의된 메트릭 또는 전달된 순서를 기준으로 정렬된 최상의 run을 반환합니다.
* `api`: W\&B API 인스턴스입니다.
* `entity`: 프로젝트를 소유한 entity(사용자 이름 또는 팀)입니다.
* `project`: 스윕를 가져올 프로젝트 이름입니다.
* `sid`: 쿼리할 스윕 ID입니다.
* `order`: 스윕의 Runs가 반환되는 순서입니다.
* `query`: 쿼리 실행에 사용할 쿼리입니다.
* `kwargs`:
### 방법 Sweep.to\_html()
```python theme={null}
self,
height: 'int' = 420,
hidden: 'bool' = False
```
이 스윕을 표시하는 iframe이 포함된 HTML을 생성합니다.