Registry

​

クラス wandb.apis.public.Registry

(service_api: 'ServiceApi',
organization: 'str',
entity: 'str',
name: 'str',
attrs: 'RegistryFragment | None' = None)

• service_api:
• organization:
• entity:
• name:
• attrs:

​

プロパティ allow_all_artifact_types

​

プロパティ artifact_types

​

プロパティ created_at

​

プロパティ 説明

​

プロパティ entity

​

プロパティ full_name

​

プロパティ id

​

プロパティ 名

​

プロパティ organization

​

プロパティ path

​

プロパティ updated_at

​

プロパティ visibility

​

method Registry.add_members()

self, *members: 'User | UserMember | Team | TeamMember | str'

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

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

self,
filter: 'dict[str, Any] | None' = None,
order: 'str | None' = None,
per_page: 'PositiveInt' = 100,
start: 'str | None' = None

• filter: コレクションのクエリに適用するフィルターのマッピング (省略可) 。
• order: 結果の並び順を指定する string (省略可) 。先頭に ’+’ を付けると昇順 (デフォルト) 、’-’ を付けると降順で並べ替えます。
• per_page: 1 ページあたりに取得する結果数です。通常、これを変更する必要はありません。
• start: 過去のクエリを再開するためのページネーションカーソルです。以前のページネーターの .cursor 属性から取得します。

​

メソッド Registry.create()

api: 'Api',
organization: 'str',
name: 'str',
visibility: "Literal['organization', 'restricted']",
description: 'str | None' = None,
artifact_types: 'list[str] | None' = None

• api: W&B API インスタンス。
• organization: 組織の名。
• name: Registryの名 (wandb-registry- プレフィックスを除く) 。
• visibility: 公開レベル (‘organization’ または ‘restricted’) 。
• description: Registryの説明 (省略可能) 。
• artifact_types: 許可するアーティファクト タイプのリスト (省略可能) 。

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

​

method Registry.delete()

self

​

method Registry.load()

self

​

method Registry.members()

self

​

method Registry.remove_members()

self, *members: 'User | UserMember | Team | TeamMember | str'

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

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

self

​

method Registry.team_members()

self

​

method Registry.update_member()

self,
member: 'User | UserMember | Team | TeamMember | str',
role: 'MemberRole | str'

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

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

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()

self

​

method Registry.versions()

self,
filter: 'dict[str, Any] | None' = None,
per_page: 'PositiveInt' = 100,
start: 'str | None' = None

• filter: アーティファクト version のクエリに適用する、省略可能なフィルターのマッピング。
• per_page: 1ページあたりに取得する結果の数です。通常、これを変更する理由はありません。
• start: 過去のクエリを再開するためのページネーションカーソルで、以前のページネーターの .cursor 属性から取得します。