> ## Documentation Index > Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt > Use this file to discover all available pages before exploring further. # Api export const GitHubLink = ({url, compact = false}) => {compact ? "View source" : <> GitHub source } ;

クラス wandb.Api

W\&B サーバーをクエリするために使用します。 ```python theme={"system"} overrides: 'dict[str, Any] | None' = None, timeout: 'int | None' = None, api_key: 'str | None' = None ```

引数

`https://api.wandb.ai` 以外の W\&B サーバーを使用する場合は、`base_url` を設定できます。`entity`、`project`、`run` のデフォルトも設定できます。 API リクエストの HTTP タイムアウト (秒単位) です。指定しない場合は、デフォルトのタイムアウトが使用されます。 認証に使用する APIキーです。指定しない場合は、現在の環境または設定の APIキーが使用されます。APIキーが指定されておらず、環境にも設定されていない場合は、APIキーの入力を求めます。

サンプル

```python theme={"system"} import wandb wandb.Api() ```

プロパティ

デフォルトの W\&B entity を返します。 W\&B のパブリックユーザーエージェントを返します。 viewer オブジェクトを返します。

メソッド

メソッド Api.artifact()

```python theme={"system"} (self, name: 'str', type: 'str | None' = None) ``` 単一のアーティファクトを返します。
引数
アーティファクト名です。アーティファクト名はファイルパスに似た形式で、少なくとも、アーティファクトがログされたプロジェクト名、アーティファクト名、およびアーティファクトのバージョンまたはエイリアスで構成されます。必要に応じて、アーティファクトをログした entity を接頭辞として先頭に付け、スラッシュで区切ることもできます。名に entity が指定されていない場合は、run または API 設定の entity が使用されます。 取得するアーティファクトのタイプです。
送出される例外
* `ValueError`: アーティファクト名が指定されていない場合。 * `ValueError`: アーティファクト タイプが指定されているものの、取得したアーティファクトのタイプと一致しない場合。
サンプル
以下のスニペットでは、「entity」、「project」、「artifact」、 「version」、および「エイリアス」は、それぞれ W\&B の entity、 アーティファクトが属する project の名、アーティファクトの名、 およびアーティファクトのバージョンのプレースホルダーです。 ```python theme={"system"} import wandb # project、アーティファクトの名、およびアーティファクトの alias を指定します wandb.Api().artifact(name="project/artifact:alias") # project、アーティファクトの名、および特定のアーティファクトのバージョンを指定します wandb.Api().artifact(name="project/artifact:version") # entity、project、アーティファクトの名、およびアーティファクトの alias を指定します wandb.Api().artifact(name="entity/project/artifact:alias") # entity、project、アーティファクトの名、および特定のアーティファクトのバージョンを指定します wandb.Api().artifact(name="entity/project/artifact:version") ```

メソッド Api.artifact\_collection()

```python theme={"system"} self, type_name: 'str', name: 'str' ``` タイプを指定して単一のアーティファクト コレクションを返します。 返された `ArtifactCollection` オブジェクトを使用すると、 そのコレクション内の特定のアーティファクトに関する情報の取得などができます。
引数
取得するアーティファクト コレクションのタイプ。 アーティファクト コレクション名。必要に応じて、アーティファクトをログした entity とスラッシュを接頭辞として先頭に付けることができます。
サンプル
次のコードスニペットの "type"、"entity"、"project"、 "artifact\_name" は、それぞれコレクションのタイプ、W\&B の entity、アーティファクトが含まれるプロジェクト名、 アーティファクトの名を表すプレースホルダーです。 ```python theme={"system"} import wandb collections = wandb.Api().artifact_collection( type_name="type", name="entity/project/artifact_name" ) # コレクション内の最初のアーティファクトを取得します artifact_example = collections.artifacts()[0] # アーティファクトの内容を、指定したルートディレクトリにダウンロードします。 artifact_example.download() ```

メソッド Api.artifact\_collection\_exists()

```python theme={"system"} self, name: 'str', type: 'str' ``` 指定された project と entity 内にアーティファクト コレクションが存在するかどうか。
引数
アーティファクト コレクションの名です。オプションで、ログした entity を接頭辞として追加し、その後にスラッシュを付けます。entity または project が指定されていない場合、override params が存在すればそれらからコレクションを推測します。それ以外の場合は、entity はユーザー設定から取得され、project はデフォルトで "uncategorized" になります。 アーティファクト コレクションのタイプです。
サンプル
以下のコードスニペットの "type" と "collection\_name" は、それぞれアーティファクト コレクションのタイプ とコレクション名を指します。 ```python theme={"system"} import wandb wandb.Api.artifact_collection_exists(type="type", name="collection_name") ```

メソッド Api.artifact\_collections()

```python theme={"system"} self, project_name: 'str', type_name: 'str', order: 'str | None' = None, per_page: 'int' = 50, start: 'str | None' = None ``` 一致するアーティファクト コレクションのコレクションを返します。
引数
フィルター対象とする project の名前。 フィルター対象とするアーティファクト タイプの名前。 結果の順序を指定するオプションの string。接頭辞が '+' の場合は昇順 (デフォルト)、'-' の場合は降順で並べ替えます。 クエリのページネーションにおけるページサイズを設定します。通常は変更する必要はありません。 過去のクエリを再開するためのページネーション カーソル。以前のページネーターの `.cursor` 属性から取得した値を指定します。

メソッド Api.artifact\_exists()

```python theme={"system"} self, name: 'str', type: 'str | None' = None ``` 指定した project と entity 内にアーティファクトのバージョンが存在するかどうか。
引数
アーティファクトの名です。先頭にアーティファクトの entity と project を接頭辞として付けます。末尾にはコロンに続けてアーティファクトのバージョンまたはエイリアスを付けます。entity または project が指定されていない場合、上書き用のパラメーターが設定されていれば、W\&B はそれを使用します。設定されていない場合、entity はユーザー設定から取得され、project は「Uncategorized」に設定されます。 アーティファクトのタイプです。
サンプル
以下のコードスニペットでは、「entity」、「project」、「artifact」、 「version」、「alias」は、それぞれ W\&B の entity、アーティファクトが属する project の名前、 アーティファクトの名前、 アーティファクトのバージョンを表すプレースホルダーです。 ```python theme={"system"} import wandb wandb.Api().artifact_exists("entity/project/artifact:version") wandb.Api().artifact_exists("entity/project/artifact:alias") ```

メソッド Api.artifact\_type()

```python theme={"system"} self, type_name: 'str', project: 'str | None' = None ``` 一致する `ArtifactType` を返します。
引数
取得するアーティファクト タイプの名。 フィルターに使用するプロジェクト名またはパス (指定した場合)。

メソッド Api.artifact\_types()

```python theme={"system"} self, project: 'str | None' = None, start: 'str | None' = None ``` 一致するアーティファクト タイプのコレクションを返します。
引数
フィルタリング対象のプロジェクト名またはパス。 過去のクエリを再開するためのページネーションカーソル。以前のページネーターの `.cursor` 属性から取得します。

メソッド Api.artifact\_versions()

```python theme={"system"} (self, type_name, name, per_page=50) ``` 非推奨。代わりに `Api.artifacts(type_name, name)` メソッドを使用してください。
引数
説明はありません。 説明はありません。 説明はありません。

メソッド Api.artifacts()

```python theme={"system"} self, type_name: 'str', name: 'str', order: 'str | None' = None, per_page: 'int' = 50, tags: 'list[str] | None' = None, start: 'str | None' = None ``` `Artifacts` コレクションを返します。
引数
取得するアーティファクトのタイプ。 アーティファクトのコレクション名。オプションで、接頭辞としてアーティファクトをログした entity を指定し、その後にスラッシュを追加できます。 結果の順序を指定するオプションの string。「+」を接頭辞にすると昇順 (デフォルト) でソートします。「-」を接頭辞にすると降順でソートします。 クエリページネーションのページサイズを設定します。通常、これを変更する理由はありません。 これらのタグをすべて持つアーティファクトのみを返します。 過去のクエリを再開するためのページネーションカーソル。以前のページネーターの `.cursor` 属性から取得されます。
サンプル
以下のコードスニペットでは、"type"、"entity"、"project"、 "artifact\_name" は、それぞれアーティファクト タイプ、W\&B entity、 アーティファクトがログされたプロジェクト名、 アーティファクト名のプレースホルダーです。 ```python theme={"system"} import wandb wandb.Api().artifacts(type_name="type", name="entity/project/artifact_name") ``` 反復処理を一時停止し、後で同じ位置から再開するには、 ページネーターの `.cursor` を保存し、`start=` として渡します。 ```python theme={"system"} from itertools import islice import wandb api = wandb.Api() # 結果の最初のページを読み取り、カーソルを保存します。 page_size = 10 artifacts = api.artifacts( type_name="type", name="entity/project/artifact_name", per_page=page_size, ) first_page = list(islice(artifacts, page_size)) saved_cursor = artifacts.cursor # 後で（例えば新しいプロセスで）、保存したカーソルから反復処理を再開します。 remaining_artifacts = api.artifacts( type_name="type", name="entity/project/artifact_name", per_page=page_size, start=saved_cursor, ) ```

メソッド Api.automation()

```python theme={"system"} self, name: 'str', *, entity: 'str | None' = None ``` パラメーターに一致する唯一のオートメーションを返します。
引数
取得するオートメーションの名。 オートメーションの取得対象の entity。
送出される例外
* `ValueError`: 検索条件に一致するオートメーションがない場合、または複数ある場合。
サンプル
"my-automation" という名の既存のオートメーションを取得します: ```python theme={"system"} import wandb api = wandb.Api() automation = api.automation(name="my-automation") ``` entity "my-team" から、"other-automation" という名の既存のオートメーションを取得します: ```python theme={"system"} automation = api.automation(name="other-automation", entity="my-team") ```

メソッド Api.automations()

```python theme={"system"} self, entity: 'str | None' = None, *, name: 'str | None' = None, per_page: 'int' = 50, start: 'str | None' = None ``` 指定されたパラメーターに一致するすべてのオートメーションを走査するイテレーターを返します。 パラメーターを指定しない場合、返されるイテレーターには、ユーザーがアクセスできるすべての オートメーションが含まれます。
引数
オートメーションを取得する対象の entity。 取得するオートメーションの名。 ページごとに取得するオートメーションの数。デフォルトは 50 です。 通常、変更する必要はありません。 過去のクエリを再開するためのページネーションカーソル。以前のページネーターの `.cursor` 属性から取得します。
サンプル
entity "my-team" の既存のオートメーションをすべて取得します: ```python theme={"system"} import wandb api = wandb.Api() automations = api.automations(entity="my-team") ```

メソッド Api.create\_automation()

```python theme={"system"} self, obj: 'NewAutomation', *, fetch_existing: 'bool' = False, **kwargs: 'Unpack[WriteAutomationsKwargs]' ``` 新しいオートメーションを作成します。
引数
作成するオートメーション。 True で、競合するオートメーションがすでに存在する場合は、エラーを発生させる代わりに既存のオートメーションの取得を試みます。 説明はありません。
サンプル
特定の project 内の run がカスタムしきい値を超えるメトリクスをログしたときに Slack 通知を送信する、 "my-automation" という名の新しいオートメーションを作成します： ```python theme={"system"} import wandb from wandb.automations import OnRunMetric, RunEvent, SendNotification api = wandb.Api() project = api.project("my-project", entity="my-team") # チームの最初の Slack インテグレーションを使用します slack_hook = next(api.slack_integrations(entity="my-team")) event = OnRunMetric( scope=project, filter=RunEvent.metric("custom-metric") > 10, ) action = SendNotification.from_integration(slack_hook) automation = api.create_automation( event >> action, name="my-automation", description="Send a Slack message whenever 'custom-metric' exceeds 10.", ) ```

メソッド Api.create\_custom\_chart()

```python theme={"system"} self, entity: 'str', name: 'str', display_name: 'str', spec_type: "Literal['vega2']", access: "Literal['private', 'public']", spec: 'str | dict' ``` カスタム チャート プリセットを作成し、その ID を返します。
引数
チャートを所有する entity (ユーザーまたはチーム) チャートプリセットの一意の ID UI に表示される、人が読みやすい名 spec のタイプ。Vega-Lite v2 の spec では "vega2" にする必要があります。 チャートのアクセスレベル: * "private": チャートを作成した entity のみがアクセスできます * "public": チャートに誰でもアクセスできます 辞書または JSON string として指定する Vega/Vega-Lite の spec
送出される例外
* `wandb.Error`: チャートの作成に失敗した場合 * `UnsupportedError`: サーバーがカスタム チャートをサポートしていない場合
サンプル
```python theme={"system"} import wandb api = wandb.Api() # シンプルな棒グラフの spec を定義します vega_spec = { "$schema": "https://vega.github.io/schema/vega-lite/v6.json", "mark": "bar", "data": {"name": "wandb"}, "encoding": { "x": {"field": "${field:x}", "type": "ordinal"}, "y": {"field": "${field:y}", "type": "quantitative"}, }, } # カスタム チャートを作成します chart_id = api.create_custom_chart( entity="my-team", name="my-bar-chart", display_name="My Custom Bar Chart", spec_type="vega2", access="private", spec=vega_spec, ) # wandb.plot_table() と組み合わせて使用します chart = wandb.plot_table( vega_spec_name=chart_id, data_table=my_table, fields={"x": "category", "y": "value"}, ) ```

メソッド Api.create\_project()

```python theme={"system"} self, name: 'str', entity: 'str' ``` 新しい project を作成します。
引数
新しい project の名。 新しい project の entity。

メソッド Api.create\_registry()

```python theme={"system"} self, name: 'str', visibility: "Literal['organization', 'restricted']", organization: 'str | None' = None, description: 'str | None' = None, artifact_types: 'list[str] | None' = None ``` 新しい Registry を作成します。
引数
Registry 名です。名は組織内で一意である必要があります。 Registry の可視性です。organization: 組織内の誰でもこの Registry を閲覧できます。ロールは後から UI の設定で編集できます。restricted: UI で招待されたメンバーのみがこの Registry にアクセスできます。公開共有は無効です。 Registry の組織です。設定で組織が指定されておらず、entity が 1 つの組織のみに所属している場合は、entity から組織を取得します。 Registry の説明です。 Registry で受け入れるアーティファクト タイプです。タイプは 128 文字以下で、`/` または `:` を含めることはできません。指定しない場合は、すべてのタイプを受け入れます。Registry に追加した許可タイプは、後から削除できません。
サンプル
```python theme={"system"} import wandb api = wandb.Api() registry = api.create_registry( name="my-registry", visibility="restricted", organization="my-org", description="This is a test registry", artifact_types=["model"], ) ```

メソッド Api.create\_run()

```python theme={"system"} self, *, run_id: 'str | None' = None, project: 'str | None' = None, entity: 'str | None' = None ``` 新しい run を作成します。
引数
run に割り当てる ID です。指定しない場合、W\&B がランダムな ID を作成します。 run をログする先の project です。project を指定しない場合、"Uncategorized" という project に run をログします。 project を所有する entity です。entity を指定しない場合、デフォルトの entity に run をログします。

メソッド Api.create\_run\_queue()

```python theme={"system"} self, name: 'str', type: 'public.RunQueueResourceType', entity: 'str | None' = None, prioritization_mode: 'public.RunQueuePrioritizationMode | None' = None, config: 'dict | None' = None, template_variables: 'dict | None' = None ``` W\&B Launch に新しい run キューを作成します。
引数
作成するキューの名 キューに使用するリソースのタイプ。"local-container", "local-process", "kubernetes","sagemaker", "gcp-vertex" のいずれかです。 キューを作成する entity の名。`None` の場合、設定済みの entity またはデフォルトの entity を使用します。 使用する優先順位付けのバージョン。"V0" または `None` です。 キューに使用するデフォルトのリソース設定。テンプレート変数を指定するには handlebars (例: `{{var}}`) を使用します。 設定とともに使用するテンプレート変数のスキーマの辞書。

メソッド Api.create\_team()

```python theme={"system"} self, team: 'str', admin_username: 'str | None' = None ``` 新しいチームを作成します。 W\&B Multi-tenant Cloud のユーザーは、`create_team()` を呼び出す前に、W\&B UI のユーザー設定で デフォルトの API 組織を設定してください。 この設定によって、新しいチームが所属する組織が決まります。
引数
チーム名。 チームの管理者ユーザーのユーザー名。デフォルトは現在のユーザーです。

メソッド Api.create\_user()

```python theme={"system"} self, email: 'str', admin: 'bool | None' = False ``` 新しいユーザーを作成します。
引数
ユーザーのメールアドレス。 ユーザーをインスタンス全体の管理者に設定します。

メソッド Api.delete\_automation()

```python theme={"system"} self, obj: 'Automation | str' ``` オートメーションを削除します。
引数
削除するオートメーション、またはその ID。

メソッド Api.flush()

```python theme={"system"} (self) ``` ローカルキャッシュをクリアします。 api オブジェクトは run のローカルキャッシュを保持するため、スクリプトの実行中に run の状態が 変わる可能性がある場合は、ローカルキャッシュをクリアする必要があります。 `api.flush()` を使用すると、run に関連付けられた最新の値を取得できます。

メソッド Api.from\_path()

```python theme={"system"} (self, path: 'str') ``` パスから run、sweep、project または report を返します。
引数
project、run、sweep または report へのパス
サンプル
以下のコードスニペットの "project"、"team"、"run\_id"、"sweep\_id"、 および "report\_name" は、それぞれ project、チーム、run ID、 sweep ID、および特定の report の名を表すプレースホルダーです。 ```python theme={"system"} import wandb api = wandb.Api() project = api.from_path("project") team_project = api.from_path("team/project") run = api.from_path("team/project/runs/run_id") sweep = api.from_path("team/project/sweeps/sweep_id") report = api.from_path("team/project/reports/report_name") ```

メソッド Api.integrations()

```python theme={"system"} self, entity: 'str | None' = None, *, per_page: 'int' = 50, start: 'str | None' = None ``` entity のすべてのインテグレーションのイテレーターを返します。
引数
インテグレーションを取得する entity (例：チーム名) 。 指定しない場合は、ユーザーのデフォルトの entity を使用します。 ページごとに取得するインテグレーションの数。デフォルトは 50 です。 通常、変更する必要はありません。 説明はありません。

メソッド Api.job()

```python theme={"system"} self, name: 'str | None', path: 'str | None' = None ``` `Job` オブジェクトを返します。
引数
ジョブ名。 ジョブのアーティファクトをダウンロードするルートパス。

メソッド Api.list\_jobs()

```python theme={"system"} self, entity: 'str', project: 'str' ``` 指定された entity と project にジョブがある場合、その一覧を返します。
引数
一覧表示するジョブの entity です。 一覧表示するジョブの project です。

メソッド Api.organization()

```python theme={"system"} self, name: 'str | None' = None ``` 一致する `Organization` を返します。
引数
組織名。省略した場合、このメソッドは現在のデフォルトの組織を推定して返そうとします。

メソッド Api.project()

```python theme={"system"} self, name: 'str', entity: 'str | None' = None ``` 指定された名 (および指定されている場合は entity) を持つ `Project` を返します。
引数
プロジェクト名。 リクエストされた entity の名。 None の場合、`Api` に渡されたデフォルトの entity にフォールバックします。 デフォルトの entity がない場合、`ValueError` を発生させます。

メソッド Api.projects()

```python theme={"system"} self, entity: 'str | None' = None, per_page: 'int' = 200 ``` 指定された entity の project を取得します。
引数
リクエストされた entity の名です。 None の場合、`Api` に渡されたデフォルトの entity が使用されます。 デフォルトの entity がない場合、`ValueError` が発生します。 クエリのページネーションのページサイズを設定します。通常、これを変更する必要はありません。

メソッド Api.queued\_run()

```python theme={"system"} (self, entity: 'str', project: 'str', queue_name: 'str', run_queue_item_id: 'str', project_queue=None, priority=None) ``` パスに基づいて、キューに登録された単一の run を返します。 `entity/project/queue_id/run_queue_item_id` 形式のパスを解析します。
引数
説明はありません。 説明はありません。 説明はありません。 説明はありません。 説明はありません。 説明はありません。

メソッド Api.registries()

```python theme={"system"} self, organization: 'str | None' = None, filter: 'dict[str, Any] | None' = None, order: 'str | None' = None, per_page: 'int' = 100, start: 'str | None' = None ``` `Registry` オブジェクトの遅延イテレーターを返します。 イテレーターを使用して、組織の Registry 全体で Registry、コレクション、 またはアーティファクトのバージョンを検索し、フィルターを適用します。結果は 反復処理に応じて遅延取得されるため、任意の件数の 項目を取得した後で、たとえば :func:`itertools.islice` を使用して、残りをリクエストせずに 停止できます。
引数
取得する Registry の組織です。指定しない場合は、ユーザーの設定で指定された組織を使用します。 遅延評価の Registry イテレーター内の各オブジェクトに適用する、省略可能な MongoDB 形式のフィルターです。Registry のフィルターに使用できるフィールドは `name`、`description`、`created_at`、`updated_at` です。コレクションのフィルターに使用できるフィールドは `name`、`tag`、`description`、`created_at`、`updated_at` です。バージョンのフィルターに使用できるフィールドは `tag`、`alias`、`created_at`、`updated_at`、`metadata` です。 結果の順序を指定する、省略可能な string です。接頭辞が '+' の場合は昇順 (デフォルト) 、'-' の場合は降順で並べ替えます。 クエリのページネーションのページサイズを設定します。 過去のクエリを再開するためのページネーションカーソルです。以前のページネーターの `.cursor` 属性から取得します。
サンプル
名に "model" を含むすべてのレジストリを検索します ```python theme={"system"} import wandb api = wandb.Api() # entity が複数の組織に所属している場合は、組織を指定します api.registries(filter={"name": {"$regex": "model"}}) ``` レジストリ内で、名が "my\_collection" でタグが "my\_tag" のコレクションをすべて検索します ```python theme={"system"} api.registries().collections(filter={"name": "my_collection", "tag": "my_tag"}) ``` コレクション名に "my\_collection" を含み、バージョンにエイリアス "best" が付いている、レジストリ内のすべてのアーティファクトのバージョンを検索します ```python theme={"system"} api.registries().collections( filter={"name": {"$regex": "my_collection"}} ).versions(filter={"alias": "best"}) ``` "model" を含むレジストリ内で、タグ "prod" またはエイリアス "best" を持つすべてのアーティファクトのバージョンを検索します ```python theme={"system"} api.registries(filter={"name": {"$regex": "model"}}).versions( filter={"$or": [{"tag": "prod"}, {"alias": "best"}]} ) ``` ページネーターの `.cursor` を保存し、`start=` として渡すことで、 反復処理を一時停止して、後で同じ位置から再開できます。 ```python theme={"system"} from itertools import islice import wandb api = wandb.Api() # 結果の最初のページを取得し、カーソルを保存します。 page_size = 10 registries = api.registries(per_page=page_size) first_page = list(islice(registries, page_size)) saved_cursor = registries.cursor # 後で（例えば新しいプロセスで）、保存したカーソルから反復処理を再開します。 remaining_registries = api.registries(per_page=page_size, start=saved_cursor) ```

メソッド Api.registry()

```python theme={"system"} self, name: 'str', organization: 'str | None' = None ``` Registry 名を指定して Registry を返します。
引数
Registry の名です。`wandb-registry-` 接頭辞は含みません。 Registry の組織です。設定で組織が指定されておらず、entity が 1 つの組織にのみ属している場合は、entity から組織を取得します。
サンプル
Registry を取得して更新します ```python theme={"system"} import wandb api = wandb.Api() registry = api.registry(name="my-registry", organization="my-org") registry.description = "This is an updated description" registry.save() ```

メソッド Api.reports()

```python theme={"system"} self, path: 'str' = '', name: 'str | None' = None, per_page: 'int' = 50 ``` 指定されたプロジェクトパスの report を取得します。 注: `wandb.Api.reports()` API はベータ版であり、 今後のリリースで変更される可能性があります。
引数
report が存在する project へのパスです。project を作成した entity を接頭辞として指定し、その後にスラッシュを付けます。 リクエストされた report の名です。 クエリのページネーションのページサイズを設定します。通常、変更する必要はありません。
サンプル
```python theme={"system"} import wandb wandb.Api.reports("entity/project") ```

メソッド Api.run()

```python theme={"system"} self, path: 'str' = '' ``` `entity/project/run_id` 形式のパスを解析して、単一の run を返します。
引数
`entity/project/run_id` 形式の run へのパスです。`api.entity` が設定されている場合は `project/run_id` 形式にでき、`api.project` が設定されている場合は run\_id のみを指定できます。
送出される例外
* `RunNotFoundError`: run が見つからない場合、または run データを読み込めない場合。

メソッド Api.run\_queue()

```python theme={"system"} (self, entity: 'str', name: 'str') ``` entity の指定された名の `RunQueue` を返します。 run キューの作成方法の詳細については、`Api.create_run_queue` を参照してください。
引数
説明はありません。 説明はありません。

メソッド Api.runs()

```python theme={"system"} (self, path: 'str | None' = None, filters: 'dict[str, Any] | None' = None, order: 'str' = '+created_at', per_page: 'int' = 50, include_sweeps: 'bool' = False, lazy: 'bool' = True) ``` `Run` オブジェクトを遅延反復する `Runs` オブジェクトを返します。 フィルターに使用できるフィールドは次のとおりです。 * `createdAt`: run が作成されたタイムスタンプです。(ISO 8601 形式、例: "2023-01-01T12:00:00Z") * `displayName`: run の人間が読みやすい表示名です。(例: "eager-fox-1") * `duration`: run の総実行時間 (秒) です。 * `group`: 関連する run をまとめて整理するために使用するグループ名です。 * `host`: run が実行されたホスト名です。 * `jobType`: ジョブのタイプまたは run の目的です。 * `name`: run の一意の ID です。(例: "a1b2cdef") * `state`: run の現在の状態です。 * `tags`: run に関連付けられたタグです。 * `username`: run を開始したユーザーのユーザー名です さらに、run 設定やサマリー メトリクスの項目でフィルターすることもできます。 たとえば、`config.experiment_name`、`summary_metrics.loss` などです。 より複雑なフィルターには、MongoDB のクエリオペレーターを使用できます。 詳細については、[https://docs.mongodb.com/manual/reference/operator/query](https://docs.mongodb.com/manual/reference/operator/query) を参照してください。 次の操作がサポートされます。 * `$and` * `$or` * `$nor` * `$eq` * `$ne` * `$gt` * `$gte` * `$lt` * `$lte` * `$in` * `$nin` * `$exists` * `$regex`
引数
(str) project へのパスです。"entity/project" の形式で指定してください。 (dict) MongoDB クエリ言語を使用して特定の run をクエリします。config.key、summary\_metrics.key、state、entity、createdAt などの run のプロパティでフィルターできます。たとえば、`{"config.experiment_name": "foo"}` は、設定エントリの実験名が "foo" に設定されている run を検索します。 (str) 順序には `created_at`、`heartbeat_at`、`config.*.value`、`summary_metrics.*` を指定できます。先頭に + を付けると昇順になります (デフォルト) 。先頭に - を付けると降順になります。デフォルトの順序は run.created\_at に基づく古い順です。 (int) クエリのページネーションのページサイズを設定します。 (bool) 各 run の結果で sweep オブジェクトを即時取得するかどうかを指定します。 (bool) パフォーマンスを向上させるために遅延読み込みを使用するかどうかを指定します。True (デフォルト) の場合、最初は必須の run メタデータのみが読み込まれます。config、summaryMetrics、systemMetrics などの重いフィールドは、アクセス時にオンデマンドで読み込まれます。最初からすべてのデータを読み込むには False に設定してください。
サンプル
```python theme={"system"} import wandb from wandb.apis.public import Api # project 内で config.experiment_name が "foo" に設定されている run を検索します Api.runs(path="my_entity/project", filters={"config.experiment_name": "foo"}) ``` ```python theme={"system"} # project 内で config.experiment_name が "foo" または "bar" に設定されている run を検索します Api.runs( path="my_entity/project", filters={ "$or": [ {"config.experiment_name": "foo"}, {"config.experiment_name": "bar"}, ] }, ) ``` ```python theme={"system"} # project 内で config.experiment_name が正規表現に一致する run を検索します Api.runs( path="my_entity/project", filters={"config.experiment_name": {"$regex": "b.*"}}, ) ``` 注意: 正規表現は Google の RE2 構文を使用します: [https://github.com/google/re2/wiki/Syntax](https://github.com/google/re2/wiki/Syntax) ```python theme={"system"} # project 内で run 名が正規表現に一致する run を検索します Api.runs( path="my_entity/project", filters={"display_name": {"$regex": "^foo.*"}} ) ``` ```python theme={"system"} # project 内の run を損失の昇順で並べて検索します Api.runs(path="my_entity/project", order="+summary_metrics.loss") ```

メソッド Api.slack\_integrations()

```python theme={"system"} self, *, entity: 'str | None' = None, per_page: 'int' = 50, start: 'str | None' = None ``` entity の Slack インテグレーションのイテレーターを返します。
引数
インテグレーションを取得する entity (例：チーム名) 。 指定しない場合は、ユーザーのデフォルトの entity を使用します。 ページごとに取得するインテグレーションの数。デフォルトは 50 です。 通常、変更する必要はありません。 説明はありません。
サンプル
チーム "my-team" に登録されているすべての Slack インテグレーションを取得します: ```python theme={"system"} import wandb api = wandb.Api() slack_integrations = api.slack_integrations(entity="my-team") ``` チャンネル名が "team-alerts-" で始まるチャンネルに投稿する Slack インテグレーションのみを検索します: ```python theme={"system"} slack_integrations = api.slack_integrations(entity="my-team") team_alert_integrations = [ ig for ig in slack_integrations if ig.channel_name.startswith("team-alerts-") ] ```

メソッド Api.sweep()

```python theme={"system"} (self, path='') ``` `entity/project/sweep_id` 形式のパスを解析して sweep を返します。
引数
entity/project/sweep\_id 形式の sweep へのパスです。`api.entity` が設定されている場合は project/sweep\_id 形式で指定でき、`api.project` が設定されている場合は sweep\_id のみで指定できます。

メソッド Api.sync\_tensorboard()

```python theme={"system"} (self, root_dir, run_id=None, project=None, entity=None) ``` tfevent ファイルを含むローカルディレクトリを wandb に同期します。
引数
説明はありません。 説明はありません。 説明はありません。 説明はありません。

メソッド Api.team()

```python theme={"system"} self, team: 'str' ``` 指定された名に一致する `Team` を返します。
引数
チーム名。

メソッド Api.update\_automation()

```python theme={"system"} self, obj: 'Automation', *, create_missing: 'bool' = False, **kwargs: 'Unpack[WriteAutomationsKwargs]' ``` 既存のオートメーションを更新します。
引数
更新するオートメーション。 既存のオートメーションである必要があります。 True の場合、オートメーションが存在しなければ作成します。 説明はありません。
サンプル
既存のオートメーション ("my-automation") を無効にし、説明を編集します: ```python theme={"system"} import wandb api = wandb.Api() automation = api.automation(name="my-automation") automation.enabled = False automation.description = "Kept for reference, but no longer used." updated_automation = api.update_automation(automation) ``` または ```python theme={"system"} import wandb api = wandb.Api() automation = api.automation(name="my-automation") updated_automation = api.update_automation( automation, enabled=False, description="Kept for reference, but no longer used.", ) ```

メソッド Api.upsert\_run\_queue()

```python theme={"system"} (self, name: 'str', resource_config: 'dict', resource_type: 'public.RunQueueResourceType', entity: 'str | None' = None, template_variables: 'dict | None' = None, external_links: 'dict | None' = None, prioritization_mode: 'public.RunQueuePrioritizationMode | None' = None) ``` W\&B Launch で run キューを作成または更新します。
引数
作成するキューの名 キューで使用するデフォルトのリソース設定 (省略可能) 。テンプレート変数を指定するには、handlebars (例：`{{var}}`) を使用します。 キューで使用するリソースのタイプ。"local-container"、"local-process"、"kubernetes"、"sagemaker"、"gcp-vertex" のいずれかです。 キューを作成する entity の名 (省略可能) 。`None` の場合は、設定済みの entity またはデフォルトの entity を使用します。 設定で使用するテンプレート変数のスキーマの辞書。 キューで使用する外部リンクの辞書 (省略可能) 。 使用する優先順位付けのバージョン (省略可能) 。"V0" または None です

メソッド Api.user()

```python theme={"system"} self, username_or_email: 'str' ``` ユーザー名またはメールアドレスからユーザーを返します。 この関数はローカル管理者のみ使用できます。`api.viewer` を使用して 自分のユーザーオブジェクトを取得します。
引数
ユーザーのユーザー名またはメールアドレス。

メソッド Api.users()

```python theme={"system"} self, username_or_email: 'str' ``` ユーザー名またはメールアドレスの部分一致でクエリし、該当するすべてのユーザーを返します。 この関数はローカル管理者のみ使用できます。`api.viewer` を使用して 自分のユーザーオブジェクトを取得します。
引数
検索するユーザーの接頭辞または接尾辞。

メソッド Api.webhook\_integrations()

```python theme={"system"} self, entity: 'str | None' = None, *, per_page: 'int' = 50, start: 'str | None' = None ``` entity の webhook インテグレーションのイテレーターを返します。
引数
インテグレーションを取得する entity (例：チーム名) 。 指定しない場合は、ユーザーのデフォルトの entity を使用します。 ページごとに取得するインテグレーションの数。デフォルトは 50 です。 通常、変更する必要はありません。 説明はありません。
サンプル
チーム "my-team" に登録されているすべての Webhook インテグレーションを取得します: ```python theme={"system"} import wandb api = wandb.Api() webhook_integrations = api.webhook_integrations(entity="my-team") ``` "[https://my-fake-url.com](https://my-fake-url.com)" にリクエストを送信する webhook インテグレーションのみを検索します: ```python theme={"system"} webhook_integrations = api.webhook_integrations(entity="my-team") my_webhooks = [ ig for ig in webhook_integrations if ig.url_endpoint.startswith("https://my-fake-url.com") ] ``` ## Related topics - [API](/ja/support/models/tags/api.md)