레지스트리

`class` `Registry`

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

`method` `Registry.init`

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

`property` Registry.allow_all_artifact_types

레지스트리에서 모든 아티팩트 타입이 허용되는지 여부를 반환합니다. True이면 어떤 타입의 아티팩트든 추가할 수 있습니다. False이면 아티팩트는 artifact_types에 나열된 타입으로 제한됩니다. 반환값:

bool: allow_all_artifact_types 프로퍼티 값.

`property` Registry.artifact_types

레지스트리에서 허용되는 아티팩트 유형을 반환합니다. allow_all_artifact_types가 True이면 artifact_types는 레지스트리에서 이전에 저장되었거나 현재 사용 중인 유형을 반영합니다. allow_all_artifact_types가 False이면 아티팩트는 artifact_types에 있는 유형으로 제한됩니다. 참고:

이전에 저장된 아티팩트 유형은 제거할 수 없습니다.

예제:

import wandb

registry = wandb.Api().create_registry()
registry.artifact_types.append("model")
registry.save()  # 저장 후에는 아티팩트 유형 `model`을 제거할 수 없습니다
registry.artifact_types.append("accidentally_added")
registry.artifact_types.remove(
     "accidentally_added"
)  # 저장되기 전에만 유형을 제거할 수 있습니다

반환값:

AddOnlyArtifactTypesList: artifact_types 속성의 값입니다.

`property` Registry.created_at

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

str: created_at 속성 값입니다.

`property` Registry.description

레지스트리에 대한 설명입니다. 반환값:

str | None: description 속성의 값입니다.

`property` Registry.entity

레지스트리가 속한 조직 엔터티입니다. 반환값:

str: 엔터티 속성의 값입니다.

`property` Registry.full_name

wandb-registry- 접두사가 포함된 Registry의 전체 이름입니다. 반환값:

str: full_name 속성 값.

`property` Registry.id

이 레지스트리의 고유 ID입니다. 반환:

str: id 속성 값.

`property` Registry.name

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

str: name 속성의 값입니다.

`property` Registry.organization

레지스트리가 속한 Organization 이름입니다. 반환값:

str: organization 속성 값입니다.

`property` Registry.path

`property` Registry.updated_at

레지스트리가 마지막으로 업데이트된 시점의 타임스탬프입니다. 반환값:

str: updated_at 속성 값.

`property` Registry.visibility

레지스트리의 공개 범위입니다. 반환값:

Literal["organization", "restricted"]: 공개 수준입니다.
- “organization”: 조직 내 모든 사용자가 이 레지스트리를 조회할 수 있습니다. 이후 UI의 설정에서 이들의 역할을 수정할 수 있습니다.
- “restricted”: UI를 통해 초대된 멤버만 이 레지스트리에 접근할 수 있습니다. 공개 공유는 비활성화됩니다.

반환값:

Literal['organization', 'restricted']: visibility 속성의 값입니다.

`메서드` `Registry.add_members`

add_members(*members: 'User | UserMember | Team | TeamMember | str') → Self

이 레지스트리에 사용자 또는 팀을 추가합니다. 인수(Args):

members: 레지스트리에 추가할 사용자 또는 팀입니다. User 객체, Team 객체 또는 해당 문자열 ID를 받을 수 있습니다.

반환값(Returns): 필요하다면, 추가 메서드 체이닝을 위해 이 레지스트리를 반환합니다. 예외(Raises):

TypeError: 인수로 전달된 멤버가 하나도 없는 경우.
ValueError: 사용자 또는 팀 ID를 유추하거나 파싱할 수 없는 경우.

예시(Examples):

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)

`method` `Registry.collections`

collections(
    filter: 'dict[str, Any] | None' = None,
    per_page: 'PositiveInt' = 100
) → Collections

레지스트리에 속한 컬렉션을 반환합니다.

`classmethod` `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()를 사용하여 호출해야 합니다. 인자(Args):

client: GraphQL 클라이언트.
organization: 조직 이름.
name: 레지스트리 이름 (wandb-registry- 접두사 제외).
visibility: 가시성 수준 (organization 또는 restricted).
description: 레지스트리에 대한 선택적 설명.
artifact_types: 허용되는 아티팩트 유형의 선택적 목록.

반환값(Returns):

Registry: 새로 생성된 Registry 객체.

예외(Raises):

ValueError: 동일한 이름의 레지스트리가 조직에 이미 존재하거나 레지스트리 생성에 실패한 경우.

`method` `Registry.delete`

delete() → None

레지스트리를 삭제합니다. 삭제는 되돌릴 수 없습니다.

`method` `Registry.load`

load() → None

백엔드에서 레지스트리 속성을 불러옵니다.

`method` `Registry.members`

members() → list[UserMember | TeamMember]

이 레지스트리의 현재 구성원(사용자 및 팀)을 반환합니다.

`method` `Registry.remove_members`

remove_members(*members: 'User | UserMember | Team | TeamMember | str') → Self

이 레지스트리에서 사용자 또는 팀을 제거합니다. 인자:

members: 레지스트리에서 제거할 사용자 또는 팀입니다. 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)

`method` `Registry.save`

save() → None

레지스트리 속성을 백엔드에 저장합니다.

`method` `Registry.team_members`

team_members() → list[TeamMember]

이 레지스트리에 현재 속한 팀들을 반환합니다.

`메서드` `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를 판별할 수 없는 경우.

예시: 레지스트리의 모든 사용자를 admin으로 설정합니다

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]

이 레지스트리의 현재 멤버 사용자 목록을 반환합니다.

`method` `Registry.versions`

versions(
    filter: 'dict[str, Any] | None' = None,
    per_page: 'PositiveInt' = 100
) → Versions

레지스트리에 속한 버전 목록을 반환합니다.

가이드

통합

튜토리얼

레퍼런스

`class` `Registry`

`method` `Registry.init`

`property` Registry.allow_all_artifact_types

`property` Registry.artifact_types

`property` Registry.created_at

`property` Registry.description

`property` Registry.entity

`property` Registry.full_name

`property` Registry.id

`property` Registry.name

`property` Registry.organization

`property` Registry.path

`property` Registry.updated_at

`property` Registry.visibility

`메서드` `Registry.add_members`

`method` `Registry.collections`

`classmethod` `Registry.create`

`method` `Registry.delete`

`method` `Registry.load`

`method` `Registry.members`

`method` `Registry.remove_members`

`method` `Registry.save`

`method` `Registry.team_members`

`메서드` `Registry.update_member`

`메서드` `Registry.user_members`

`method` `Registry.versions`

가이드

통합

튜토리얼

레퍼런스

​class Registry

​method Registry.__init__

​property Registry.allow_all_artifact_types

​property Registry.artifact_types

​property Registry.created_at

​property Registry.description

​property Registry.entity

​property Registry.full_name

​property Registry.id

​property Registry.name

​property Registry.organization

​property Registry.path

​property Registry.updated_at

​property Registry.visibility

​메서드 Registry.add_members

​method Registry.collections

​classmethod Registry.create

​method Registry.delete

​method Registry.load

​method Registry.members

​method Registry.remove_members

​method Registry.save

​method Registry.team_members

​메서드 Registry.update_member

​메서드 Registry.user_members

​method Registry.versions

`class` `Registry`

`method` `Registry.init`

`property` Registry.allow_all_artifact_types

`property` Registry.artifact_types

`property` Registry.created_at

`property` Registry.description

`property` Registry.entity

`property` Registry.full_name

`property` Registry.id

`property` Registry.name

`property` Registry.organization

`property` Registry.path

`property` Registry.updated_at

`property` Registry.visibility

`메서드` `Registry.add_members`

`method` `Registry.collections`

`classmethod` `Registry.create`

`method` `Registry.delete`

`method` `Registry.load`

`method` `Registry.members`

`method` `Registry.remove_members`

`method` `Registry.save`

`method` `Registry.team_members`

`메서드` `Registry.update_member`

`메서드` `Registry.user_members`

`method` `Registry.versions`