Registry

​

class Registry

Registry 内の 1 つのレジストリ。

​

method Registry.__init__

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

---

​

property Registry.allow_all_artifact_types

レジストリで、すべての artifact タイプが許可されているかどうかを返します。

True の場合、あらゆるタイプの artifact を追加できます。False の場合、artifact は artifact_types に列挙されたタイプに制限されます。

戻り値:

• bool: allow_all_artifact_types のプロパティ値。

---

​

プロパティ Registry.artifact_types

Registry で許可されている artifact タイプを返します。

allow_all_artifact_types が True の場合、artifact_types には、以前に保存されたタイプ、または現在 Registry で使用されているタイプが反映されます。allow_all_artifact_types が False の場合、artifact は artifact_types に含まれるタイプに制限されます。

注:

以前に保存された artifact タイプは削除できません。

例:

import wandb

registry = wandb.Api().create_registry()
registry.artifact_types.append("model")
registry.save()  # 一度保存すると、artifact type `model` は削除できなくなります
registry.artifact_types.append("accidentally_added")
registry.artifact_types.remove(
     "accidentally_added"
)  # タイプは保存前であれば削除できます

戻り値:

• AddOnlyArtifactTypesList: artifact_types プロパティの値。

---

​

プロパティ Registry.created_at

Registryが作成された日時。

戻り値:

• str: created_at プロパティの値。

---

​

property Registry.description

Registryの説明。

戻り値:

• str | None: 説明プロパティの値。

---

​

プロパティ Registry.entity

Registry の組織 entity。

戻り値:

• str: entity プロパティの値。

---

​

プロパティ Registry.full_name

wandb-registry- プレフィックスを含むレジストリの完全な名前。

戻り値:

• str: full_name プロパティの値。

---

​

プロパティ Registry.id

この Registry の一意の ID。

戻り値:

• str: id プロパティの値。

---

​

プロパティ Registry.name

wandb-registry- プレフィックスを除いたレジストリ名。

戻り値:

• str: name プロパティの値。

---

​

property Registry.organization

Registry の組織名。

戻り値:

• str: 組織名を表すプロパティ値。

---

​

プロパティ Registry.path

---

​

property Registry.updated_at

Registry の最終更新日時を表す Timestamp。

戻り値:

• str: updated_at プロパティの値。

---

​

プロパティ Registry.visibility

Registry の可視性。

戻り値:

• Literal["organization", "restricted"]: 可視性のレベル。
  • “organization”: 組織内の誰でもこの Registry を閲覧できます。各ユーザーのロールは、後から UI の Settings で編集できます。
  • “restricted”: UI で招待されたメンバーのみがこの Registry にアクセスできます。公開共有は無効化されます。

戻り値:

• Literal['organization', 'restricted']: 可視性のプロパティ値。

---

​

method Registry.add_members

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

このレジストリにUsersまたはTeamsを追加します。

引数:

• members: レジストリに追加するUsersまたはTeams。User オブジェクト、Team オブジェクト、またはそれらの文字列IDを受け付けます。

戻り値: 必要に応じて、このレジストリ自体を返します。これにより、引き続きmethodチェーンを行えます。

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

レジストリに属するコレクションを返します。

---

​

クラスメソッド 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: 許可するアーティファクト タイプのリスト (省略可能) 。

戻り値:

• Registry: 新しく作成された Registry オブジェクト。

例外:

• ValueError: 組織内に同じ名のレジストリがすでに存在する場合、または作成に失敗した場合。

---

​

method Registry.delete

delete() → None

レジストリを削除します。この操作は元に戻せません。

---

​

method Registry.load

load() → None

バックエンドからレジストリの属性を読み込みます。

---

​

method Registry.members

members() → list[UserMember | TeamMember]

このレジストリの現在のメンバー (Users と Teams) を返します。

---

​

method Registry.remove_members

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

このレジストリからUsersまたはTeamsを削除します。

Args:

• members: レジストリから削除するUsersまたはTeams。User オブジェクト、Team オブジェクト、またはそれらの文字列IDを受け付けます。

Returns: 必要に応じて、さらにmethodチェーンできるよう、このレジストリを返します。

Raises:

• TypeError: 引数としてメンバーが1つも渡されなかった場合。
• 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.remove_members(user1, user2)

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

---

​

method Registry.save

save() → None

Registry の属性をバックエンドへ保存します。

---

​

method Registry.team_members

team_members() → list[TeamMember]

このレジストリに現在所属しているTeamsを返します。

---

​

method Registry.update_member

update_member(
    member: 'User | UserMember | Team | TeamMember | str',
    role: 'MemberRole | str'
) → Self

このRegistry内のメンバー (ユーザーまたはチーム) のロールを更新します。

引数:

• member: ロールを更新する対象のユーザーまたはチームです。User オブジェクト、Team オブジェクト、またはそれらの文字列 ID を受け取ります。
• role: メンバーに割り当てる新しいロールです。次のいずれかを指定できます。
  • “admin”
  • “member”
  • “viewer”
  • “restricted_viewer” (W&B サーバーでサポートされる場合)

戻り値: 必要に応じて、さらに method チェーンを行えるよう、このRegistry自身を返します。

送出される例外:

• ValueError: ユーザーまたはチームの ID を特定できない場合。

例: Registry内のすべてのUsersを管理者にします

import wandb

api = wandb.Api()

# 既存のRegistryを取得する
registry = api.registry(name="my-registry", organization="my-org")

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

---

​

method Registry.user_members

user_members() → list[UserMember]

このRegistryに現在所属しているメンバーユーザーを返します。

---

​

method Registry.versions

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

そのRegistryに属するバージョンを返します。