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

> PaddleDetection を W&B と統合して、物体検出モデルのトレーニングをトラッキングし、メトリクスをログして、結果を可視化します。

# PaddleDetection

export const ColabLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="colab-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M14.25.18l.9.2.73.26.59.3.45.32.34.34.25.34.16.33.1.3.04.26.02.2-.01.13V8.5l-.05.63-.13.55-.21.46-.26.38-.3.31-.33.25-.35.19-.35.14-.33.1-.3.07-.26.04-.21.02H8.77l-.69.05-.59.14-.5.22-.41.27-.33.32-.27.35-.2.36-.15.37-.1.35-.07.32-.04.27-.02.21v3.06H3.17l-.21-.03-.28-.07-.32-.12-.35-.18-.36-.26-.36-.36-.35-.46-.32-.59-.28-.73-.21-.88-.14-1.05-.05-1.23.06-1.22.16-1.04.24-.87.32-.71.36-.57.4-.44.42-.33.42-.24.4-.16.36-.1.32-.05.24-.01h.16l.06.01h8.16v-.83H6.18l-.01-2.75-.02-.37.05-.34.11-.31.17-.28.25-.26.31-.23.38-.2.44-.18.51-.15.58-.12.64-.1.71-.06.77-.04.84-.02 1.27.05zm-6.3 1.98l-.23.33-.08.41.08.41.23.34.33.22.41.09.41-.09.33-.22.23-.34.08-.41-.08-.41-.23-.33-.33-.22-.41-.09-.41.09zm13.09 3.95l.28.06.32.12.35.18.36.27.36.35.35.47.32.59.28.73.21.88.14 1.04.05 1.23-.06 1.23-.16 1.04-.24.86-.32.71-.36.57-.4.45-.42.33-.42.24-.4.16-.36.09-.32.05-.24.02-.16-.01h-8.22v.82h5.84l.01 2.76.02.36-.05.34-.11.31-.17.29-.25.25-.31.24-.38.2-.44.17-.51.15-.58.13-.64.09-.71.07-.77.04-.84.01-1.27-.04-1.07-.14-.9-.2-.73-.25-.59-.3-.45-.33-.34-.34-.25-.34-.16-.33-.1-.3-.04-.25-.02-.2.01-.13v-5.34l.05-.64.13-.54.21-.46.26-.38.3-.32.33-.24.35-.2.35-.14.33-.1.3-.06.26-.04.21-.02.13-.01h5.84l.69-.05.59-.14.5-.21.41-.28.33-.32.27-.35.2-.36.15-.36.1-.35.07-.32.04-.28.02-.21V6.07h2.09l.14.01.21.03zm-6.47 14.25l-.23.33-.08.41.08.41.23.33.33.23.41.08.41-.08.33-.23.23-.33.08-.41-.08-.41-.23-.33-.33-.23-.41-.08-.41.08z" />
    </svg>
    Colabで試す
  </a>;

<ColabLink url="https://colab.research.google.com/drive/1ywdzcZKPmynih1GuGyCWB4Brf5Jj7xRY?usp=sharing" />

[PaddleDetection](https://github.com/PaddlePaddle/PaddleDetection) は、[PaddlePaddle](https://github.com/PaddlePaddle/Paddle) をベースにした、エンドツーエンドの物体検出開発キットです。ネットワークコンポーネント、データ拡張、損失関数などの設定可能なモジュールを用いて、さまざまな一般的な物体の検出、インスタンスセグメンテーション、キーポイントのトラッキングと検出を行います。

PaddleDetection には、トレーニングおよび検証の全メトリクスに加え、モデル チェックポイントとそれに対応するメタデータをログする W\&B インテグレーションが組み込まれています。

PaddleDetection の `WandbLogger` は、トレーニング中にトレーニングおよび評価メトリクスを W\&B にログするとともに、モデル チェックポイントもログします。

[`COCO2017` データセットのサブセットで YOLOX モデルを PaddleDetection に統合する方法を紹介した W\&B のブログ記事を読む](https://wandb.ai/manan-goel/PaddleDetectionYOLOX/reports/Object-Detection-with-PaddleDetection-and-W-B--VmlldzoyMDU4MjY0)。

<div id="sign-up-and-create-an-api-key">
  ## サインアップしてAPIキーを作成する
</div>

APIキーは、お使いのマシンをW\&Bに対して認証するために使用します。APIキーはユーザーのプロフィールから発行できます。

<Note>
  より手早く行うには、[User Settings](https://wandb.ai/settings) に直接アクセスしてAPIキーを作成してください。新しく作成したAPIキーはすぐにコピーし、パスワードマネージャーなどの安全な場所に保存してください。
</Note>

1. 右上にあるユーザーのプロフィールアイコンをクリックします。
2. **User Settings** を選択し、**API Keys** セクションまでスクロールします。

<div id="install-the-wandb-library-and-log-in">
  ## `wandb` ライブラリをインストールしてログインする
</div>

`wandb` ライブラリをローカル環境にインストールしてログインするには、次の手順に従います。

<Tabs>
  <Tab title="コマンドライン">
    1. `WANDB_API_KEY` [環境変数](/ja/models/track/environment-variables/) に APIキーを設定します。

       ```bash theme={null}
       export WANDB_API_KEY=<your_api_key>
       ```

    2. `wandb` ライブラリをインストールし、ログインします。

       ```shell theme={null}
       pip install wandb

       wandb login
       ```
  </Tab>

  <Tab title="Python">
    ```bash theme={null}
    pip install wandb
    ```

    ```python theme={null}
    import wandb
    wandb.login()
    ```
  </Tab>

  <Tab title="Python notebook">
    ```notebook theme={null}
    !pip install wandb

    import wandb
    wandb.login()
    ```
  </Tab>
</Tabs>

<div id="activate-the-wandblogger-in-your-training-script">
  ## トレーニングスクリプトで `WandbLogger` を有効にする
</div>

<Tabs>
  <Tab title="コマンドライン">
    [PaddleDetection](https://github.com/PaddlePaddle/PaddleDetection/) の `train.py` に引数を指定して wandb を使用するには、次のようにします。

    * `--use_wandb` フラグを追加します
    * 最初の wandb 引数の前には `-o` を付ける必要があります (指定は 1 回だけで十分です)
    * 各引数には `"wandb-"` プレフィックスを付ける必要があります。たとえば、[`wandb.init()`](/ja/models/ref/python/functions/init) に渡す引数には `wandb-` プレフィックスを付けます

    ```shell theme={null}
    python tools/train.py 
        -c config.yml \ 
        --use_wandb \
        -o \ 
        wandb-project=MyDetector \
        wandb-entity=MyTeam \
        wandb-save_dir=./logs
    ```
  </Tab>

  <Tab title="`config.yml`">
    `config.yml` ファイルの `wandb` キーの下に wandb の引数を追加します。

    ```
    wandb:
      project: MyProject
      entity: MyTeam
      save_dir: ./logs
    ```

    `train.py` ファイルを実行すると、W\&B ダッシュボードへのリンクが生成されます。

    <Frame>
      <img src="https://mintcdn.com/wb-21fd5541-docs-hivemind-launch/zScEGRJKnI_Vuqe8/images/integrations/paddledetection_wb_dashboard.png?fit=max&auto=format&n=zScEGRJKnI_Vuqe8&q=85&s=acfa2bacacde3b99781c49c77e6df124" alt="W&Bダッシュボード" width="2754" height="1340" data-path="images/integrations/paddledetection_wb_dashboard.png" />
    </Frame>
  </Tab>
</Tabs>

<div id="feedback-or-issues">
  ## フィードバックや問題
</div>

W\&B インテグレーション についてフィードバックや問題がある場合は、[PaddleDetection GitHub](https://github.com/PaddlePaddle/PaddleDetection) で issue を登録するか、<a href="mailto:support@wandb.com">[support@wandb.com](mailto:support@wandb.com)</a> までメールでお問い合わせください。
