> ## 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.
# 스윕
export const GitHubLink = ({url}) =>
GitHub source
;
## class `Sweep`
Sweeps 와 관련된 Runs 의 집합입니다.
**Attributes:**
* `runs` (Runs): Runs 의 리스트
* `id` (str): Sweep ID
* `project` (str): Sweep 이 속한 Project 의 이름
* `config` (dict): Sweep 구성 (sweep configuration) 을 포함하는 사전 (dictionary)
* `state` (str): Sweep 의 상태. "Finished", "Failed", "Crashed", 또는 "Running" 이 될 수 있습니다.
* `expected_run_count` (int): Sweep 에 대해 예상되는 Runs 의 수
### method `Sweep.__init__`
```python theme={null}
__init__(
client: 'RetryingClient',
entity: 'str',
project: 'str',
sweep_id: 'str',
attrs: 'Mapping[str, Any] | None' = None
)
```
***
### property Sweep.config
Sweep 에 사용된 Sweep 구성 (sweep configuration) 입니다.
***
### property Sweep.entity
Sweep 과 관련된 Entities 입니다.
**Returns:**
* `str`: entity 속성 값.
***
### property Sweep.expected\_run\_count
Sweep 에서 예상되는 Runs 의 수를 반환하거나, 무제한 Runs 인 경우 None 을 반환합니다.
**Returns:**
* `int | None`: expected\_run\_count 속성 값.
***
### property Sweep.name
Sweep 의 이름입니다.
다음 우선순위에 따라 존재하는 첫 번째 이름을 반환합니다:
1. 사용자가 수정한 표시 이름 (display name) 2. 생성 시 설정된 이름 3. Sweep ID
***
### property Sweep.order
Sweep 의 정렬 키 (order key) 를 반환합니다.
***
### property Sweep.path
Project 의 경로를 반환합니다.
경로는 Entities, Project 이름, 그리고 Sweep ID 를 포함하는 리스트입니다.
***
### property Sweep.url
Sweep 의 URL 입니다.
Sweep URL 은 Entities, Project, "sweeps" 라는 용어, 그리고 Sweep ID 를 기반으로 생성됩니다. SaaS 사용자의 경우, `https://wandb.ai/entity/project/sweeps/sweeps_ID` 형식을 가집니다.
***
### property Sweep.username
더 이상 사용되지 않습니다 (Deprecated). 대신 `Sweep.entity` 를 사용하세요.
**Returns:**
* `str`: username 속성 값.
***
### method `Sweep.best_run`
```python theme={null}
best_run(order=None)
```
구성(config)에 정의된 메트릭 또는 전달된 정렬 순서에 따라 가장 우수한 Run 을 반환합니다.
***
### classmethod `Sweep.get`
```python theme={null}
get(
client: 'RetryingClient',
entity: 'str | None' = None,
project: 'str | None' = None,
sid: 'str | None' = None,
order: 'str | None' = None,
query: 'Document | None' = None,
**kwargs
)
```
클라우드 백엔드에 대해 쿼리를 실행합니다.
**Args:**
* `client`: 쿼리 실행에 사용할 클라이언트.
* `entity`: Project 를 소유한 Entities (사용자 이름 또는 팀).
* `project`: Sweep 을 가져올 Project 의 이름.
* `sid`: 쿼리할 Sweep ID.
* `order`: Sweep 의 Runs 가 반환되는 순서.
* `query`: 실행에 사용할 쿼리.
* `**kwargs`: 쿼리에 전달할 추가 키워드 인수 (arguments).
***
### method `Sweep.to_html`
```python theme={null}
to_html(height: 'int' = 420, hidden: 'bool' = False) → str
```
이 Sweep 을 표시하는 iframe 을 포함한 HTML 을 생성합니다.