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

​
class File

W&B に保存されたファイル。 W&B に保存された単一のファイルを表します。ファイルのメタデータにもアクセスできます。ファイルは特定の run に関連付けられており、テキストファイル、モデルの重み、データセット、可視化、その他の Artifacts などを含めることができます。ファイルのダウンロード、削除、プロパティへのアクセスが可能です。 特定の run にログされた特定のファイルを絞り込むには、辞書で 1 つ以上の属性を指定します。次のキーを使用して検索できます。
  • id (str): ファイルを含む run の ID
  • name (str): ファイル名
  • url (str): ファイルへのパス
  • direct_url (str): バケット内のファイルへのパス
  • sizeBytes (int): ファイルサイズ (バイト単位)
  • md5 (str): ファイルの md5
  • mimetype (str): ファイルの MIME タイプ
  • updated_at (str): 最終更新のタイムスタンプ
  • path_uri (str): バケット内のファイルへのパス。現在は S3 オブジェクトと参照ファイルでのみ利用可能です
Args:
  • client: ファイルを含む run オブジェクト
  • attrs (dict): ファイルを定義する属性の辞書
  • run: ファイルを含む run オブジェクト

​
プロパティ File.path_uri

ストレージバケット内のファイルの URI パスを返します。 戻り値:
  • str: ファイルが S3 に保存されている場合は S3 URI (例: ‘s3://bucket/path/to/file’) 、参照ファイルの場合は直接 URL、利用できない場合は空文字列。
戻り値:
  • str: path_uri プロパティの値。

​
プロパティ File.size

ファイルのサイズをバイト単位で返します。 戻り値:
  • int: size プロパティの値。

​
method File.delete

delete() → None
W&B サーバーからこのファイルを削除します。

​
method File.download

download(
    root: 'str' = '.',
    replace: 'bool' = False,
    exist_ok: 'bool' = False,
    api: 'Api | None' = None
) → io.TextIOWrapper
wandb サーバーから、run が以前に保存したファイルをダウンロードします。 引数:
  • root: ファイルの保存先となるローカルディレクトリ。デフォルトは現在の作業ディレクトリ (”.”) です。
  • replace: True の場合、ローカルファイルが存在するとダウンロード時に上書きします。デフォルトは False です。
  • exist_ok: True の場合、ファイルがすでに存在していても ValueError を発生させず、replace=True でない限り再ダウンロードもしません。デフォルトは False です。
  • api: 指定した場合、ファイルのダウンロードに使用する Api インスタンス。
例外: ファイルがすでに存在し、replace=False かつ exist_ok=False の場合は ValueError を発生させます。