Files

GitHub ソースコード

​

class Files

File オブジェクトのコレクションに対する遅延イテレーターです。

run 中に W&B にアップロードされたファイルへのアクセスと管理を行います。多数のファイルを含むコレクションを反復処理する際も、自動的にページネーションを処理します。

例:

from wandb.apis.public.files import Files
from wandb.apis.public.api import Api

# run オブジェクトの例
run = Api().run("entity/project/run-id")

# run 内のファイルを反復処理するための Files オブジェクトを作成する
files = Files(api.client, run)

# ファイルを反復処理する
for file in files:
     print(file.name)
     print(file.url)
     print(file.size)

     # ファイルをダウンロードする
     file.download(root="download_directory", replace=True)

​

method Files.__init__

__init__(
    client: 'RetryingClient',
    run: 'Run',
    names: 'list[str] | None' = None,
    per_page: 'int' = 50,
    upload: 'bool' = False,
    pattern: 'str | None' = None
)

File オブジェクトのコレクションに対する遅延評価イテレーターを初期化します。

必要に応じて、ファイルは W&B サーバーからページ単位で取得されます。

引数:

• client: ファイルを含む run オブジェクト
• run: ファイルを含む run オブジェクト
• names (list, optional): ファイルをフィルタリングするためのファイル名のリスト
• per_page (int, optional): 1 ページあたりに取得するファイル数
• upload (bool, optional): True の場合、各ファイルのアップロード URL を取得する
• pattern (str, optional): W&B からファイルを取得する際にマッチさせるパターン。 このパターンは MySQL の LIKE 構文を使用します。たとえば、拡張子が .json で終わるすべてのファイルにマッチさせるには “%.json” となります。 names と pattern の両方が指定された場合、ValueError が発生します。

---

​

property Files.length

---