메인 콘텐츠로 건너뛰기

class Registry

레지스트리의 개별 레지스트리입니다.

방법 Registry.__init__

__init__(
    client: 'RetryingClient',
    organization: 'str',
    entity: 'str',
    name: 'str',
    attrs: 'RegistryFragment | None' = None
)

속성 Registry.allow_all_artifact_types

레지스트리에서 모든 artifact 유형을 허용하는지 여부를 반환합니다. True이면 모든 유형의 artifact를 추가할 수 있습니다. False이면 artifact_types에 나열된 유형의 artifact만 허용됩니다. 반환값:
  • bool: allow_all_artifact_types 속성 값입니다.

속성 Registry.artifact_types

레지스트리에서 허용되는 artifact 유형을 반환합니다. allow_all_artifact_typesTrue이면 artifact_types는 이전에 저장되었거나 현재 레지스트리에서 사용 중인 유형을 반영합니다. allow_all_artifact_typesFalse이면 artifact는 artifact_types에 있는 유형으로 제한됩니다. 참고:
이전에 저장된 artifact 유형은 제거할 수 없습니다.
예시:
import wandb

registry = wandb.Api().create_registry()
registry.artifact_types.append("model")
registry.save()  # 저장 후에는 artifact 유형 `model`을 제거할 수 없습니다
registry.artifact_types.append("accidentally_added")
registry.artifact_types.remove(
     "accidentally_added"
)  # 유형은 저장되기 전에만 제거할 수 있습니다
반환값:
  • AddOnlyArtifactTypesList: artifact_types 속성 값입니다.

속성 Registry.created_at

레지스트리가 생성된 시점을 나타내는 타임스탬프입니다. 반환값:
  • str: created_at 속성 값입니다.

속성 Registry.description

레지스트리에 대한 설명입니다. 반환값:
  • str | None: 설명 속성의 값입니다.

속성 Registry.entity

레지스트리의 조직 entity입니다. 반환값:
  • str: entity 속성 값입니다.

속성 Registry.full_name

wandb-registry- 접두사를 포함한 레지스트리의 전체 이름입니다. 반환값:
  • str: full_name 속성 값입니다.

속성 Registry.id

이 레지스트리의 고유 ID입니다. 반환값:
  • str: id 속성 값입니다.

속성 Registry.name

wandb-registry- 접두사를 제외한 레지스트리 이름입니다. 반환값:
  • str: name 속성 값입니다.

속성 Registry.organization

레지스트리의 조직 이름입니다. 반환값:
  • str: 조직 속성의 값입니다.

속성 Registry.path


속성 Registry.updated_at

레지스트리가 마지막으로 업데이트된 Timestamp입니다. 반환값:
  • str: updated_at 속성 값입니다.

속성 Registry.visibility

레지스트리의 공개 범위입니다. 반환값:
  • Literal["organization", "restricted"]: 공개 범위 수준입니다.
    • “organization”: 조직의 누구나 이 레지스트리를 볼 수 있습니다. 역할은 나중에 UI의 Settings에서 변경할 수 있습니다.
    • “restricted”: UI를 통해 초대된 멤버만 이 레지스트리에 액세스할 수 있습니다. 공개 공유는 사용할 수 없습니다.
반환값:
  • Literal['organization', 'restricted']: 공개 범위 속성 값입니다.

방법 Registry.add_members

add_members(*members: 'User | UserMember | Team | TeamMember | str') → Self
이 레지스트리에 사용자 또는 Teams를 추가합니다. 매개변수:
  • members: 레지스트리에 추가할 사용자 또는 Teams입니다. User 객체, Team 객체 또는 해당 문자열 ID를 받을 수 있습니다.
반환값: 필요한 경우 추가 메서드 체이닝에 사용할 수 있는 이 레지스트리입니다. 예외:
  • TypeError: 인수로 전달된 멤버가 없는 경우
  • ValueError: 사용자 또는 팀 ID를 추론하거나 파싱할 수 없는 경우
예시:
import wandb

api = wandb.Api()

# 기존 레지스트리 가져오기
registry = api.registry(name="my-registry", organization="my-org")

user1 = api.user(username="some-user")
user2 = api.user(username="other-user")
registry.add_members(user1, user2)

my_team = api.team(name="my-team")
registry.add_members(my_team)

방법 Registry.collections

collections(
    filter: 'dict[str, Any] | None' = None,
    per_page: 'PositiveInt' = 100
) → Collections
레지스트리에 속한 컬렉션을 반환합니다.

클래스 메서드 Registry.create

create(
    client: 'RetryingClient',
    organization: 'str',
    name: 'str',
    visibility: "Literal['organization', 'restricted']",
    description: 'str | None' = None,
    artifact_types: 'list[str] | None' = None
) → Self
새 레지스트리를 생성합니다. 레지스트리 이름은 조직 내에서 고유해야 합니다. 이 함수는 api.create_registry()를 사용해 호출해야 합니다. 매개변수:
  • client: GraphQL 클라이언트입니다.
  • organization: 조직 이름입니다.
  • name: 레지스트리 이름입니다(wandb-registry- 접두사 제외).
  • visibility: 공개 범위입니다(‘organization’ 또는 ‘restricted’).
  • description: 레지스트리에 대한 선택 설명입니다.
  • artifact_types: 허용되는 artifact 유형의 선택 목록입니다.
반환값:
  • Registry: 새로 생성된 레지스트리 객체입니다.
예외:
  • ValueError: 조직 내에 같은 이름의 레지스트리가 이미 있거나 생성에 실패한 경우입니다.

방법 Registry.delete

delete() → None
레지스트리를 삭제합니다. 이 작업은 되돌릴 수 없습니다.

방법 Registry.load

load() → None
백엔드에서 레지스트리 속성을 불러옵니다.

방법 Registry.members

members() → list[UserMember | TeamMember]
이 레지스트리의 현재 멤버(Users 및 Teams)를 반환합니다.

방법 Registry.remove_members

remove_members(*members: 'User | UserMember | Team | TeamMember | str') → Self
이 레지스트리에서 Users 또는 Teams를 제거합니다. 매개변수:
  • members: 레지스트리에서 제거할 Users 또는 Teams입니다. User 객체, Team 객체 또는 해당 문자열 ID를 받습니다.
반환값: 필요한 경우 후속 메서드 체이닝에 사용할 수 있도록 이 레지스트리 자체를 반환합니다. 예외:
  • TypeError: 인수로 전달된 멤버가 없으면 발생합니다.
  • ValueError: 사용자 또는 팀 ID를 추론하거나 파싱할 수 없으면 발생합니다.
예제:
import wandb

api = wandb.Api()

# 기존 레지스트리 가져오기
registry = api.registry(name="my-registry", organization="my-org")

user1 = api.user(username="some-user")
user2 = api.user(username="other-user")
registry.remove_members(user1, user2)

old_team = api.team(name="old-team")
registry.remove_members(old_team)

방법 Registry.save

save() → None
레지스트리 속성을 백엔드에 저장합니다.

방법 Registry.team_members

team_members() → list[TeamMember]
이 레지스트리에 현재 멤버로 등록된 Teams를 반환합니다.

방법 Registry.update_member

update_member(
    member: 'User | UserMember | Team | TeamMember | str',
    role: 'MemberRole | str'
) → Self
이 레지스트리에서 멤버(사용자 또는 팀)의 역할을 업데이트합니다. 매개변수:
  • member: 역할을 업데이트할 사용자 또는 팀입니다. User 객체, Team 객체 또는 해당 문자열 ID를 받을 수 있습니다.
  • role: 멤버에게 할당할 새 역할입니다. 다음 중 하나일 수 있습니다: - “admin” - “member” - “viewer” - “restricted_viewer” (W&B 서버에서 지원하는 경우)
반환값: 필요한 경우 후속 메서드 체이닝에 사용할 수 있도록 이 레지스트리를 반환합니다. 예외:
  • ValueError: 사용자 또는 팀 ID를 식별할 수 없는 경우 발생합니다.
예제: 레지스트리의 모든 사용자를 관리자로 설정하기
import wandb

api = wandb.Api()

# 기존 레지스트리 가져오기
registry = api.registry(name="my-registry", organization="my-org")

for member in registry.user_members():
    registry.update_member(member.user, role="admin")

방법 Registry.user_members

user_members() → list[UserMember]
이 레지스트리의 현재 Member Users를 반환합니다.

방법 Registry.versions

versions(
    filter: 'dict[str, Any] | None' = None,
    per_page: 'PositiveInt' = 100
) → Versions
레지스트리에 속한 버전들을 반환합니다.