> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-docs-sandboxes-integrations-placement.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# File

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub のソース
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/main/wandb/apis/public/files.py" />

## <kbd>class</kbd> `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 オブジェクトと参照ファイルでのみ利用可能です

**引数:**

* `service_api`:  W\&B のクエリに使用する service API インスタンス
* `attrs` (dict):  ファイルを定義する属性の辞書
* `run`:  ファイルを含む run オブジェクト

### <kbd>プロパティ</kbd> File.path\_uri

ストレージバケット内のファイルの URI パスを返します。

**戻り値:**

* `str`: ファイルが S3 に保存されている場合は S3 URI (例: 's3://bucket/path/to/file') 、参照ファイルの場合は直接 URL、利用できない場合は空文字列。

**戻り値:**

* `str`: path\_uri プロパティの値。

***

### <kbd>プロパティ</kbd> File.size

ファイルのサイズをバイト単位で返します。

**戻り値:**

* `int`: size プロパティの値。

***

### <kbd>method</kbd> `File.delete`

```python theme={null}
delete() → None
```

W\&B サーバーからこのファイルを削除します。

***

### <kbd>method</kbd> `File.download`

```python theme={null}
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` を発生させます。
