> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-update-reference-docs-60.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Registry
export const GitHubLink = ({url, compact = false}) =>
{compact ? "ソースを表示" : <>
GitHub のソース
}
;
## クラス wandb.apis.public.Registry
Registry 内の 1 つの Registry です。
```python theme={null}
(service_api: 'ServiceApi',
organization: 'str',
entity: 'str',
name: 'str',
attrs: 'RegistryFragment | None' = None)
```
## 引数
説明はありません。
説明はありません。
説明はありません。
説明はありません。
説明はありません。
## プロパティ
Registry ですべてのアーティファクト タイプが許可されているかどうかを返します。
`True` の場合、任意のタイプのアーティファクトを追加できます。`False` の場合、アーティファクトは
`artifact_types` にリストされているタイプに制限されます。
Registry で許可されているアーティファクト タイプを返します。
`allow_all_artifact_types` が `True` の場合、`artifact_types` には
以前に保存されたタイプ、または現在 Registry で使用されているタイプが反映されます。
`allow_all_artifact_types` が `False` の場合、アーティファクトは
`artifact_types` のタイプに制限されます。
注:
以前に保存されたアーティファクト タイプは削除できません。
Registry が作成された時点のタイムスタンプです。
Registry の説明です。
Registry の組織エンティティです。
`wandb-registry-` 接頭辞を含む Registry の完全名です。
この Registry の一意の ID です。
取得されている場合、この Registry の基盤となる project の GraphQL `internalId` です。
これは base64 エンコードされたグローバル ID です。デコードすると、
`Project:123` または `ProjectInternalId:123` のようになります。
`wandb-registry-` 接頭辞を除いた Registry の名です。
Registry の組織名です。
説明はありません。
Registry が最後に更新された時点のタイムスタンプです。
Registry の可視性です。
## メソッド
### メソッド Registry.add\_members()
```python theme={null}
self, *members: 'User | UserMember | Team | TeamMember | str'
```
この Registry にUsersまたはTeamsを追加します。
##### 引数
Registry に追加するUsersまたはTeams。`User` オブジェクト、`Team` オブジェクト、またはそれらの文字列IDを受け付けます。
##### 送出される例外
* `TypeError`: 引数としてメンバーが1つも渡されなかった場合。
* `ValueError`: ユーザーまたはチームのIDを推定または解析できない場合。
##### 例
```python theme={null}
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()
```python theme={null}
self,
filter: 'dict[str, Any] | None' = None,
order: 'str | None' = None,
per_page: 'PositiveInt' = 100,
start: 'str | None' = None
```
この Registry に属するコレクションを返します。
##### 引数
コレクションのクエリに適用するフィルターのマッピング (省略可) 。
結果の並び順を指定する string (省略可) 。先頭に '+' を付けると昇順 (デフォルト) 、'-' を付けると降順で並べ替えます。
1 ページあたりに取得する結果数です。通常、これを変更する必要はありません。
過去のクエリを再開するためのページネーションカーソルです。以前のページネーターの `.cursor` 属性から取得します。
### メソッド Registry.create()
```python theme={null}
api: 'Api',
organization: 'str',
name: 'str',
visibility: "Literal['organization', 'restricted']",
description: 'str | None' = None,
artifact_types: 'list[str] | None' = None
```
新しいRegistryを作成します。
Registry名は、組織内で一意である必要があります。
この関数は `api.create_registry()` を使用して呼び出してください。
##### 引数
W\&B API のインスタンス。
組織名。
Registry の名前 (`wandb-registry-` 接頭辞を除く) 。
可視性レベル ('organization' または 'restricted') 。
Registry の任意の説明。
許可するアーティファクト タイプの任意のリスト。
##### 送出される例外
* `ValueError`: 組織内に同じ名のRegistryがすでに存在する場合、または作成に失敗した場合。
### メソッド Registry.delete()
```python theme={null}
self
```
Registry を削除します。この操作は元に戻せません。
### メソッド Registry.load()
```python theme={null}
self
```
バックエンドから Registry の属性を読み込みます。
### メソッド Registry.members()
```python theme={null}
self
```
この Registry の現在のメンバー (Users と Teams) を返します。
### メソッド Registry.remove\_members()
```python theme={null}
self, *members: 'User | UserMember | Team | TeamMember | str'
```
この Registry からUsersまたはTeamsを削除します。
##### 引数
Registry から削除するUsersまたはTeams。`User` オブジェクト、`Team` オブジェクト、またはそれらの文字列IDを受け付けます。
##### 送出される例外
* `TypeError`: 引数としてメンバーが1つも渡されなかった場合。
* `ValueError`: ユーザーまたはチームのIDを推定または解析できない場合。
##### 例
```python theme={null}
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()
```python theme={null}
self
```
Registry の属性をバックエンドへ保存します。
### メソッド Registry.team\_members()
```python theme={null}
self
```
この Registry に現在所属しているTeamsを返します。
### メソッド Registry.update\_member()
```python theme={null}
self,
member: 'User | UserMember | Team | TeamMember | str',
role: 'MemberRole | str'
```
このRegistry内のメンバー (ユーザーまたはチーム) のロールを更新します。
##### 引数
ロールを更新する対象のユーザーまたはチームです。`User` オブジェクト、`Team` オブジェクト、またはそれらの文字列 ID を受け取ります。
メンバーに割り当てる新しいロールです。次のいずれかを指定できます。
* "admin"
* "member"
* "viewer"
* "restricted\_viewer" (W\&B サーバーでサポートされる場合)
##### 送出される例外
* `ValueError`: ユーザーまたはチームの ID を特定できない場合。
##### 例
Registry のすべてのユーザーを管理者にする
```python theme={null}
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")
```
### メソッド Registry.user\_members()
```python theme={null}
self
```
このRegistryに現在所属しているメンバーUsersを返します。
### メソッド Registry.versions()
```python theme={null}
self,
filter: 'dict[str, Any] | None' = None,
order: '_VersionOrder | None' = None,
per_page: 'PositiveInt' = 100,
start: 'str | None' = None
```
このRegistryに属するアーティファクト versionを返します。
##### 引数
アーティファクト version のクエリに適用する、省略可能なフィルターのマッピング。
結果の並び順を指定する省略可能な string です。`created_at`、`artifact_size`、`linked_at` を指定できます。'+' を接頭辞として付けると昇順 (デフォルト) で並べ替え、'-' を接頭辞として付けると降順で並べ替えます。
1ページあたりに取得する結果の数です。通常、これを変更する理由はありません。
過去のクエリを再開するためのページネーションカーソルで、以前のページネーターの `.cursor` 属性から取得します。