Api
GitHubでソースを表示するwandbサーバーを照会するために使用されます。
Api(
overrides=None,
timeout: Optional[int] = None,
api_key: Optional[str] = None
) -> None
例:
最も一般的な初期化方法
wandb.Api()
| 引数 | |
|---|---|
overrides | (dict) https://api.wandb.ai 以外の wandb サーバーを使用している場合は、base_url を設定できます。また、entity、project、および run のデフォルトも設定できます。 |
| 属性 |
|---|
メソッド
artifact
artifact(
name, type=None
)
entity/project/run_id の形式でパスを解析して、単一のアーティファクトを返します。
| 引数 | |
|---|---|
name | (str) アーティファクトの名前。エンティティ/プロジェクトでプレフィックスがつく可能性があります。有効な名前は以下の形式であることができます: name:version name:alias digest |
type | (str, 任意) 取得するアーティファクトのタイプ。 |
| 返り値 | |
|---|---|
Artifact オブジェクト。 |
artifact_type
artifact_type(
type_name, project=None
)
artifact_types
artifact_types(
project=None
)
artifact_versions
artifact_versions(
type_name, name, per_page=50
)
create_project
create_project(
name: str,
entity: str
)
create_report
create_report(
project: str,
entity: str = "",
title: Optional[str] = "無題のレポート",
description: Optional[str] = "",
width: Optional[str] = "readable",
blocks: Optional['wandb.apis.reports.util.Block'] = None
) -> "wandb.apis.reports.Report"
create_run
create_run(
**kwargs
)
新しいrunを作成します。
create_team
create_team(
team, admin_username=None
)
新しいチームを作成します。
| 引数 | |
|---|---|
team | (str) チームの名前 |
admin_username | (str) オプション: チームの管理ユーザーのユーザー名。デフォルトは現在のユーザーです。 |
| 戻り値 | |
|---|---|
Team オブジェクト |
create_user
create_user(
email, admin=(False)
)
新しいユーザーを作成します。
| 引数 | |
| :--- | :--- |
| email | (str) チーム名 |
| admin | (bool) このユーザーがグローバルインスタンスの管理者であるかどうか |
| 戻り値 | |
|---|---|
User オブジェクト |
flush
flush()
ローカルキャッシュをフラッシュします。
apiオブジェクトはrunsのローカルキャッシュを保持しているため、スクリプトの実行中にrunの状態が変更される可能性がある場合は、api.flush()でローカルキャッシュをクリアして、runに関連する最新の値を取得する必要があります。
from_path
from_path(
path
)
パスからrun、スイープ、プロジェクト、またはレポートを返します。
例:
project = api.from_path("my_project")
team_project = api.from_path("my_team/my_project")
run = api.from_path("my_team/my_project/runs/id")
sweep = api.from_path("my_team/my_project/sweeps/id")
report = api.from_path("my_team/my_project/reports/My-Report-Vm11dsdf")
| 引数 | |
|---|---|
path | (str) プロジェクト、run、スイープ、またはレポートへのパス |
| Returns | |
|---|---|
Project、Run、Sweep、または BetaReport のインスタンス。 |
| Raises | |
|---|---|
| パスが無効であるか、オブジェクトが存在しない場合は wandb.Error |
job
job(
name, path=None
)
load_report
load_report(
path: str
) -> "wandb.apis.reports.Report"
指定したパスのレポートを取得します。
| 引数 | |
|---|---|
path | (str) 対象のレポートへのパス。形式は entity/project/reports/reportId です。これは、wandbのURLの後にURLをコピーして貼り付けることで取得できます。例： megatruong/report-editing/reports/My-fabulous-report-title--VmlldzoxOTc1Njk0 |
| 返り値 | |
|---|---|
path で指定されたレポートを表す BetaReport オブジェクト |
| 例外 | |
|---|---|
| パスが無効な場合はwandb.Error |
project
project(
name, entity=None
)
projects
projects(
entity=None, per_page=200
)
指定されたエンティティのプロジェクトを取得します。
| 引数 | |
|---|---|
entity | (str) 要求されたエンティティの名前。Noneの場合、Apiに渡されたデフォルトのエンティティにフォールバックします。デフォルトのエンティティがない場合、ValueErrorを発生させます。 |
per_page | (int) クエリのページネーションに対するページサイズを設定します。Noneの場合、デフォルトのサイズを使用します。通常、これを変更する理由はありません。 |
| 戻り値 | |
|---|---|
イテラブルなProjectオブジェクトのコレクションであるProjectsオブジェクト。 |
queued_run
queued_run(
entity, project, queue_name, run_queue_item_id, container_job=(False),
project_queue=None
)
パスに基づいて、1つのキューに入ったrunを返します。
entity/project/queue_id/run_queue_item_id の形式のパスを解析します。
reports
reports(
path="", name=None, per_page=50
)
指定したプロジェクトパスに対するレポートを取得します。
警告: このAPIはベータ版であり、今後のリリースで変更される可能性があります。
| 引数 | |
|---|---|
path | (str) レポートが存在するプロジェクトへのパスで、"entity/project"の形式であるべきです。 |
name | (str) オプションで指定するレポートの名前。 |
per_page | (int) クエリのページネーションにおけるページサイズを設定します。Noneを指定するとデフォルトサイズが使用されます。通常、この設定を変更する必要はありません。 |
| 戻り値 | |
|---|---|
BetaReportオブジェクトのイテラブルなコレクションである Reportsオブジェクト。 |
run
run(
path=""
)
エンティティ/プロジェクト/ランIDの形式でパスを解析して、単一のランを返します。
| 引数 | 説明 |
|---|---|
path | (str) パスはentity/project/run_idの形式です。api.entityが設定されている場合、project/run_idの形式で、api.projectが設定されている場合は、run_id だけで構いません。 |
| 戻り値 | 説明 |
|---|---|
Runオブジェクト。 |
runs
runs(
path: Optional[str] = None,
filters: Optional[Dict[str, Any]] = None,
order: str = "-created_at",
per_page: int = 50,
include_sweeps: bool = (True)
)
指定されたフィルタに一致するプロジェクトからのrunsのセットを返します。
config.*、summary_metrics.*、tags、state、entity、createdAtなどでフィルタリングできます。
例：
my_projectでconfig.experiment_nameが"foo"に設定されているrunsを検索
api.runs(path="my_entity/my_project", filters={"config.experiment_name": "foo"})
my_projectでconfig.experiment_nameが"foo"または"bar"に設定されているrunsを検索
api.runs(
path="my_entity/my_project",
filters={"$or": [{"config.experiment_name": "foo"}, {"config.experiment_name": "bar"}]}
)
私のプロジェクトでconfig.experiment_nameが正規表現に一致するrunを見つける（アンカーはサポートされていません）
api.runs(
path="my_entity/my_project",
filters={"config.experiment_name": {"$regex": "b.*"}}
)
私のプロジェクトでrun名が正規表現に一致するrunを見つける（アンカーはサポートされていません）
api.runs(
path="my_entity/my_project",
filters={"display_name": {"$regex": "^foo.*"}}
)
私のプロジェクトのrunを昇順の損失で並べ替える
api.runs(path="my_entity/my_project", order="+summary_metrics.loss")
| 引数 | |
|---|---|
path | (str) プロジェクトへのパスで、"entity/project"の形式である必要があります |
filters | (dict) MongoDBクエリ言語を使用して特定のrunをクエリします。config.key、summary_metrics.key、state、entity、createdAtなどのrunプロパティで絞り込むことができます。例：{"config.experiment_name": "foo"} は実験名が"foo"に設定されているrunを見つけます。詳細なクエリを作成するために、操作を組み合わせることができます。言語のリファレンスは https://docs.mongodb.com/manual/reference/operator/query で参照できます。 |
order | (str) 順序は created_at、heartbeat_at、config.*.value、または summary_metrics.* にすることができます。順序に+を付けると昇順になります。順序に-を付けると降順になります（デフォルト）。デフォルトの順序は最新から最古のrun.created_atです。 |
| 戻り値 | |
| :--- | :--- |
Runsオブジェクト。これは、Runオブジェクトのイテレータブルなコレクションです。 |
sweep
sweep(
path=""
)
entity/project/sweep_idの形式でパスを解析して、スイープを返します。
| 引数 | |
|---|---|
path | (str, optional) entity/project/sweep_idの形式で指定されたスイープへのパス。api.entityが設定されている場合は、project/sweep_idの形式で指定でき、api.projectが設定されている場合は、sweep_idだけで指定できます。 |
| 戻り値 | |
|---|---|
Sweepオブジェクト。 |
sync_tensorboard
sync_tensorboard(
root_dir, run_id=None, project=None, entity=None
)
tfeventファイルを含むローカルディレクトリをwandbに同期します。
team
team(
team
)
user
user(
ユーザー名_または_メール
)
ユーザー名またはメールアドレスからユーザーを返します。
注: この関数はローカル管理者専用です。自分自身のユーザーオブジェクトを取得しようとする場合は、api.viewerを使用してください。
| 引数 | |
|---|---|
ユーザー名_または_メール | (str) ユーザーのユーザー名またはメールアドレス |
| 返り値 | |
|---|---|
Userオブジェクト または ユーザーが見つからない場合はNone |
users
users(
username_or_email
)
部分的なユーザー名またはメールアドレスのクエリからすべてのユーザーを返します。
注: この関数はローカル管理者のみが使用できます。自分のユーザーオブジェクトを取得しようとしている場合は、api.viewerを使用してください。
| 引数 | |
|---|---|
username_or_email | (str) 検索したいユーザーの接頭辞または接尾辞 |
| 戻り値 | |
|---|---|
Userオブジェクトの配列 | |
| クラス変数 |
| :--- | :--- |
| CREATE_PROJECT | |
| USERS_QUERY | |
| VIEWER_QUERY | |