Skip to main content

クラス wandb.apis.public.Registry

Registry 内の 1 つの Registry です。

引数

ServiceApi
説明はありません。
str
説明はありません。
str
説明はありません。
str
説明はありません。
RegistryFragment | None
説明はありません。

プロパティ

bool
Registry ですべてのアーティファクト タイプが許可されているかどうかを返します。True の場合、任意のタイプのアーティファクトを追加できます。False の場合、アーティファクトは artifact_types にリストされているタイプに制限されます。
AddOnlyArtifactTypesList
Registry で許可されているアーティファクト タイプを返します。allow_all_artifact_typesTrue の場合、artifact_types には 以前に保存されたタイプ、または現在 Registry で使用されているタイプが反映されます。 allow_all_artifact_typesFalse の場合、アーティファクトは artifact_types のタイプに制限されます。注: 以前に保存されたアーティファクト タイプは削除できません。
str
Registry が作成された時点のタイムスタンプです。
str | None
Registry の説明です。
str
Registry の組織エンティティです。
str
wandb-registry- 接頭辞を含む Registry の完全名です。
str
この Registry の一意の ID です。
str | None
取得されている場合、この Registry の基盤となる project の GraphQL internalId です。これは base64 エンコードされたグローバル ID です。デコードすると、 Project:123 または ProjectInternalId:123 のようになります。
str
wandb-registry- 接頭辞を除いた Registry の名です。
str
Registry の組織名です。
list[str]
説明はありません。
str | None
Registry が最後に更新された時点のタイムスタンプです。
The visibility level.
Registry の可視性です。

メソッド

メソッド Registry.add_members()

この Registry にUsersまたはTeamsを追加します。
引数
User | UserMember | Team | TeamMember | str
Registry に追加するUsersまたはTeams。User オブジェクト、Team オブジェクト、またはそれらの文字列IDを受け付けます。
送出される例外
  • TypeError: 引数としてメンバーが1つも渡されなかった場合。
  • ValueError: ユーザーまたはチームのIDを推定または解析できない場合。

メソッド Registry.collections()

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

メソッド Registry.create()

新しいRegistryを作成します。 Registry名は、組織内で一意である必要があります。 この関数は api.create_registry() を使用して呼び出してください。
引数
Api
W&B API のインスタンス。
str
組織名。
str
Registry の名前 (wandb-registry- 接頭辞を除く) 。
Literal['organization', 'restricted']
可視性レベル (‘organization’ または ‘restricted’) 。
str | None
Registry の任意の説明。
list[str] | None
許可するアーティファクト タイプの任意のリスト。
送出される例外
  • ValueError: 組織内に同じ名のRegistryがすでに存在する場合、または作成に失敗した場合。

メソッド Registry.delete()

Registry を削除します。この操作は元に戻せません。

メソッド Registry.load()

バックエンドから Registry の属性を読み込みます。

メソッド Registry.members()

この Registry の現在のメンバー (Users と Teams) を返します。

メソッド Registry.remove_members()

この Registry からUsersまたはTeamsを削除します。
引数
User | UserMember | Team | TeamMember | str
Registry から削除するUsersまたはTeams。User オブジェクト、Team オブジェクト、またはそれらの文字列IDを受け付けます。
送出される例外
  • TypeError: 引数としてメンバーが1つも渡されなかった場合。
  • ValueError: ユーザーまたはチームのIDを推定または解析できない場合。

メソッド Registry.save()

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

メソッド Registry.team_members()

この Registry に現在所属しているTeamsを返します。

メソッド Registry.update_member()

このRegistry内のメンバー (ユーザーまたはチーム) のロールを更新します。
引数
User | UserMember | Team | TeamMember | str
ロールを更新する対象のユーザーまたはチームです。User オブジェクト、Team オブジェクト、またはそれらの文字列 ID を受け取ります。
MemberRole | str
メンバーに割り当てる新しいロールです。次のいずれかを指定できます。
  • “admin”
  • “member”
  • “viewer”
  • “restricted_viewer” (W&B サーバーでサポートされる場合)
送出される例外
  • ValueError: ユーザーまたはチームの ID を特定できない場合。
Registry のすべてのユーザーを管理者にする

メソッド Registry.user_members()

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

メソッド Registry.versions()

このRegistryに属するアーティファクト versionを返します。
引数
dict[str, Any] | None
アーティファクト version のクエリに適用する、省略可能なフィルターのマッピング。
_VersionOrder | None
結果の並び順を指定する省略可能な string です。created_atartifact_sizelinked_at を指定できます。’+’ を接頭辞として付けると昇順 (デフォルト) で並べ替え、’-’ を接頭辞として付けると降順で並べ替えます。
PositiveInt
1ページあたりに取得する結果の数です。通常、これを変更する理由はありません。
str | None
過去のクエリを再開するためのページネーションカーソルで、以前のページネーターの .cursor 属性から取得します。