メインコンテンツへスキップ

class User

W&B インスタンス上のユーザー。 このクラスでは、ユーザーの APIキーを管理し、Teams への所属情報などにアクセスできます。create クラスメソッドを使用して、新しいユーザーを作成できます。 引数:
  • client: ネットワーク操作に使用する GraphQL クライアント。
  • attrs: GraphQL スキーマ内の User タイプのサブセット。

property User.api_keys

ユーザーのAPIキーの名前。 このプロパティが返すのはAPIキーの名前であり、キーに関連付けられたシークレットそのものではありません。キーの名前をAPIキーとして使用することはできません。 ユーザーがAPIキーを持っていない場合、またはAPIキーが読み込まれていない場合、このリストは空です。 戻り値:
  • list[str]: api_keys プロパティの値。

property User.teams

ユーザーが所属するTeamsの名前。 ユーザーがどのTeamsにも所属していない場合、またはTeamsデータが読み込まれていない場合、これは空のリストになります。 戻り値:
  • list[str]: teamsプロパティの値。

property User.user_api

ユーザーの認証情報を使用する wandb.Api インスタンス。 戻り値:
  • Api | None: user_api プロパティの値。

method User.delete_api_key

delete_api_key(api_key: 'str') → bool
ユーザーのAPIキーを削除します。 キーの所有者または管理者のみが削除できます。 引数:
  • api_key: 削除するAPIキーの名前。api_keys プロパティから返される名前のいずれかを使用してください。
戻り値: 成功時はTrue、失敗時はfalseです。

method User.generate_api_key

generate_api_key(description: 'str | None' = None) → str | None
新しいAPIキーを生成します。 引数:
  • description: 新しいAPIキーの説明。APIキーの用途を判別するために使用できます。
戻り値: 生成されたAPIキー (名前だけでなく、完全なシークレット) 、または失敗した場合は None。