> ## 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.

# wandb sync

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/v0.28.0/wandb/cli/cli.py#L561" />

<div id="usage">
  ## 使い方
</div>

```bash theme={null}
sync [OPTIONS] [PATH]...
```

<div id="description">
  ## 説明
</div>

既存のローカル W\&B run データをクラウドにアップロードします。

ローカルの `wandb` ディレクトリにあるオフラインまたは未完了の Runs を
W\&B サーバーに同期します。PATH が指定されている場合は、そのパスにある
Runs を同期します。パスが指定されていない場合は、まず ./wandb ディレクトリを
検索し、次に wandb/
サブディレクトリを検索します。

引数なしで実行すると、何もアップロードせずに、同期済みおよび未同期の
Runs の概要を表示します。

特定のパスを同期する場合は、デフォルトで TensorBoard のイベントファイルも
含まれます。`--sync-all` を使用する場合は、デフォルトで TensorBoard が
無効になります (有効にするには `--sync-tensorboard` を使用します) 。

PATH は .wandb ファイル、または .wandb ファイルを含む run ディレクトリです。
一般的なパスは次のようになります。

./wandb/run-YYYYMMDD\_HHMMSS-RUN\_ID/run-RUN\_ID.wandb

ここで、run-YYYYMMDD\_HHMMSS-RUN\_ID は run ディレクトリ、
run-RUN\_ID.wandb は .wandb ファイルです。YYYYMMDD\_HHMMSS は
run が作成された時点のタイムスタンプで、RUN\_ID はその run の一意の ID
です。

たとえば、ローカルの Runs とその同期ステータスの概要を表示するには、次のようにします。

```bash theme={null}
wandb sync
```

ローカルの
./wandb/run-20170617\_000000-abcd1234 ディレクトリに保存されている run ID abcd1234 を同期するには:

```bash theme={null}
wandb sync ./wandb/run-20170617_000000-abcd1234
```

ローカルの .wandb ファイルパス (./wandb/run-20170617\_000000-abcd1234/run-abcd1234.wandb) を使って run abcd1234 を同期するには:

```bash theme={null}
wandb sync ./wandb/run-20170617_000000-abcd1234/run-abcd1234.wandb
```

ローカルのwandbディレクトリ内にある未同期のRunsをすべて同期するには:

```bash theme={null}
wandb sync --sync-all
```

すでに同期されているRunsのローカルデータを削除するには:

```bash theme={null}
wandb sync --clean
```

確認プロンプトを表示せずに、48 時間より古い同期済みの Runs を削除するには:

```bash theme={null}
wandb sync --clean --clean-old-hours 48 --clean-force
```

<div id="arguments">
  ## 引数
</div>

| 名      | デフォルト | タイプ   |
| ------ | ----- | ----- |
| `path` | PATH  | False |

<div id="options">
  ## オプション
</div>

| フラグ                  | タイプ       | 説明                                                                                      |
| -------------------- | --------- | --------------------------------------------------------------------------------------- |
| `--id`               | STR       | 既存の run ID にアップロードします。**デフォルト**: None                                                   |
| `--project, -p`      | STR       | run のアップロード先の project を設定します。**デフォルト**: None                                            |
| `--entity, -e`       | STR       | project のスコープに使用する entity を設定します。**デフォルト**: None                                        |
| `--job_type`         | STR       | 関連する Runs をグループ化するためのジョブタイプを設定します。**デフォルト**: None                                       |
| `--sync-tensorboard` | BOOL Flag | TensorBoard の tfevent ファイルを同期します。特定のパスではデフォルトで有効ですが、`--sync-all` では無効です。**デフォルト**: None |
| `--include-globs`    | STR       | これらの glob パターンに一致する Runs のみを含めます (カンマ区切り) 。**デフォルト**: None                              |
| `--exclude-globs`    | STR       | これらの glob パターンに一致する Runs を除外します (カンマ区切り) 。**デフォルト**: None                               |
| `--include-online`   | BOOL Flag | オンラインモードで作成された Runs を含めます。**デフォルト**: None                                               |
| `--include-offline`  | BOOL Flag | オフラインモードで作成された Runs を含めます。**デフォルト**: None                                               |
| `--include-synced`   | BOOL Flag | すでに同期済みの Runs を含めます。**デフォルト**: None                                                     |
| `--mark-synced`      | BOOL Flag | アップロード後に Runs を同期済みとしてマークします。**デフォルト**: True                                            |
| `--sync-all`         | BOOL Flag | ローカルの wandb ディレクトリ内にある未同期の Runs をすべて同期します。**デフォルト**: False                              |
| `--clean`            | BOOL Flag | すでに同期済みの Runs のローカルデータを削除します。**デフォルト**: False                                           |
| `--clean-old-hours`  | INT       | 指定した時間数より古い同期済み Runs のみを削除します (`--clean` と併用) 。**デフォルト**: 24                            |
| `--clean-force`      | BOOL Flag | `--clean` が指定されている場合、確認プロンプトをスキップします。**デフォルト**: False                                   |
| `--show`             | INT       | サマリーに表示する Runs の数を設定します。**デフォルト**: 5                                                    |
| `--append`           | BOOL Flag | 新しい run を作成する代わりに、既存の run にデータを追加します。**デフォルト**: False                                   |
| `--skip-console`     | BOOL Flag | コンソールログのアップロードをスキップします。**デフォルト**: False                                                 |
| `--replace-tags`     | STR       | 同期中に tags の名前を変更します。カンマ区切りの `old=new` ペアを使用します。**デフォルト**: None                          |