메인 콘텐츠로 건너뛰기

class 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 수

방법 Sweep.__init__

__init__(
    client: 'RetryingClient',
    entity: 'str',
    project: 'str',
    sweep_id: 'str',
    attrs: 'Mapping[str, Any] | None' = None
)

속성 Sweep.config

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

속성 Sweep.entity

sweep에 연결된 entity입니다. 반환값:
  • str: entity 속성 값.

속성 Sweep.expected_run_count

Sweep의 예상 run 수를 반환합니다. run 수가 무한한 경우 None을 반환합니다. 반환값:
  • int | None: expected_run_count 속성 값입니다.

속성 Sweep.name

sweep의 이름입니다. 다음 우선순위에 따라 가장 먼저 존재하는 이름을 반환합니다:
  1. 사용자가 수정한 표시 이름 2. 생성 시 설정한 이름 3. Sweep ID

속성 Sweep.order

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

속성 Sweep.path

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

속성 Sweep.url

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

속성 Sweep.username

사용 중단되었습니다. 대신 Sweep.entity를 사용하세요. 반환값:
  • str: username 속성 값입니다.

방법 Sweep.agent

agent(agent_id: 'str') → Agent
이 스윕에서 ID로 에이전트를 쿼리합니다. 인수:
  • agent_id: 조회할 에이전트의 ID입니다.

방법 Sweep.agents

agents() → list[Agent]
이 스윕의 모든 에이전트 목록을 쿼리합니다.

방법 Sweep.best_run

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

클래스 메서드 Sweep.get

get(
    client: 'RetryingClient',
    entity: 'str | None' = None,
    project: 'str | None' = None,
    sid: 'str | None' = None,
    order: 'str | None' = None,
    query: 'Document | None' = None,
    **kwargs
)
클라우드 백엔드에 쿼리를 실행합니다. 매개변수:
  • client: 쿼리 실행에 사용할 클라이언트입니다.
  • entity: 프로젝트를 소유한 entity(사용자 이름 또는 팀)입니다.
  • project: sweep를 가져올 프로젝트 이름입니다.
  • sid: 쿼리할 sweep ID입니다.
  • order: sweep의 run이 반환되는 순서입니다.
  • query: 쿼리 실행에 사용할 쿼리입니다.
  • **kwargs: 쿼리에 전달할 추가 키워드 매개변수입니다.

방법 Sweep.to_html

to_html(height: 'int' = 420, hidden: 'bool' = False) → str
이 sweep을 표시하는 iframe이 포함된 HTML을 생성합니다.