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

# Files

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> `Files`

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

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

**例:**

```python theme={null}
from wandb.apis.public.files import Files
from wandb.apis.public.api import Api

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

# run のファイルを取得する
files = run.files()

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

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

### <kbd>method</kbd> `Files.__init__`

```python theme={null}
__init__(
    service_api: 'ServiceApi',
    run: 'Run',
    names: 'list[str] | None' = None,
    per_page: 'int' = 50,
    upload: 'bool' = False,
    pattern: 'str | None' = None
)
```

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

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

**Args:**

* `service_api`:  W\&B のクエリに使用するサービス API のインスタンス
* `run`:  ファイルを含む run オブジェクト
* `names` (list, optional):  ファイルをフィルターするためのファイル名のリスト
* `per_page` (int, optional):  1 ページあたりに取得するファイル数
* `upload` (bool, optional):  `True` の場合、各ファイルのアップロード URL を取得します
* `pattern` (str, optional):  W\&B から返されるファイルを照合する際に使用するパターン。このパターンでは MySQL の LIKE 構文を使用します。そのため、`.json` で終わるすべてのファイルに一致させるには `&quot;%.json&quot;` を指定します。`names` と `pattern` の両方を指定した場合は、ValueError が発生します。

***

### <kbd>プロパティ</kbd> Files.length

***
