> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-weave-otel-prioritization.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Registry

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub のソース
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/main/wandb/apis/public/registries/registry.py#L38" />

## <kbd>クラス</kbd> wandb.apis.public.Registry

```python theme={null}
(service_api: 'ServiceApi',
organization: 'str',
entity: 'str',
name: 'str',
attrs: 'RegistryFragment | None' = None)
```

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

<div id="args">
  ## 引数
</div>

* `service_api`:
* `organization`:
* `entity`:
* `name`:
* `attrs`:

<div id="properties">
  ## プロパティ
</div>

### <kbd>プロパティ</kbd> allow\_all\_artifact\_types

レジストリで、すべての アーティファクト タイプが許可されているかどうかを返します。

`True` の場合、あらゆるタイプの アーティファクト を追加できます。`False` の場合、アーティファクト は
`artifact_types` に列挙されたタイプに制限されます。

### <kbd>プロパティ</kbd> artifact\_types

Registry で許可されている アーティファクト タイプを返します。

`allow_all_artifact_types` が `True` の場合、`artifact_types` には、以前に保存された
タイプ、または現在 Registry で使用されているタイプが反映されます。
`allow_all_artifact_types` が `False` の場合、アーティファクト は
`artifact_types` に含まれるタイプに制限されます。

注:
以前に保存された アーティファクト タイプは削除できません。

### <kbd>プロパティ</kbd> created\_at

Registryが作成された日時。

### <kbd>プロパティ</kbd> 説明

Registryの説明。

### <kbd>プロパティ</kbd> entity

Registry の組織 entity。

### <kbd>プロパティ</kbd> full\_name

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

### <kbd>プロパティ</kbd> id

この Registry の一意の ID。

### <kbd>プロパティ</kbd> 名

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

### <kbd>プロパティ</kbd> organization

Registry の組織名。

### <kbd>プロパティ</kbd> path

### <kbd>プロパティ</kbd> updated\_at

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

### <kbd>プロパティ</kbd> visibility

Registry の可視性。

<div id="methods">
  ## メソッド
</div>

### <kbd>method</kbd> Registry.add\_members()

```python theme={null}
self, *members: 'User | UserMember | Team | TeamMember | str'
```

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

<div id="arguments">
  ##### 引数
</div>

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

<div id="raises">
  ##### 送出される例外
</div>

* `TypeError`: 引数としてメンバーが1つも渡されなかった場合。
* `ValueError`: ユーザーまたはチームのIDを推定または解析できない場合。

<div id="examples">
  ##### 例
</div>

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

### <kbd>メソッド</kbd> 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 に属するコレクションを返します。

<div id="arguments">
  ##### 引数
</div>

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

### <kbd>メソッド</kbd> 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()` を使用して呼び出してください。

<div id="arguments">
  ##### 引数
</div>

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

<div id="raises">
  ##### 送出される例外
</div>

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

### <kbd>method</kbd> Registry.delete()

```python theme={null}
self
```

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

### <kbd>method</kbd> Registry.load()

```python theme={null}
self
```

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

### <kbd>method</kbd> Registry.members()

```python theme={null}
self
```

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

### <kbd>method</kbd> Registry.remove\_members()

```python theme={null}
self, *members: 'User | UserMember | Team | TeamMember | str'
```

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

<div id="arguments">
  ##### 引数
</div>

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

<div id="raises">
  ##### 送出される例外
</div>

* `TypeError`: 引数としてメンバーが1つも渡されなかった場合。
* `ValueError`: ユーザーまたはチームのIDを推定または解析できない場合。

<div id="examples">
  ##### 例
</div>

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

### <kbd>method</kbd> Registry.save()

```python theme={null}
self
```

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

### <kbd>method</kbd> Registry.team\_members()

```python theme={null}
self
```

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

### <kbd>method</kbd> Registry.update\_member()

```python theme={null}
self,
member: 'User | UserMember | Team | TeamMember | str',
role: 'MemberRole | str'
```

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

<div id="arguments">
  ##### 引数
</div>

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

<div id="raises">
  ##### 送出される例外
</div>

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

<div id="examples">
  ##### 例
</div>

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")
```

### <kbd>method</kbd> Registry.user\_members()

```python theme={null}
self
```

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

### <kbd>method</kbd> Registry.versions()

```python theme={null}
self,
filter: 'dict[str, Any] | None' = None,
per_page: 'PositiveInt' = 100,
start: 'str | None' = None
```

このRegistryに属するアーティファクト versionを返します。

<div id="arguments">
  ##### 引数
</div>

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