Add instructions to enable W&B logging (#18546)

Signed-off-by: Mohammed Yasin <32206511+Y-T-G@users.noreply.github.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Mohammed Yasin 2025-01-06 21:11:34 +08:00 committed by GitHub
parent 00aefd795c
commit 41065957f3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -44,6 +44,9 @@ To install the required packages, run:
```bash ```bash
# Install the required packages for Ultralytics YOLO and Weights & Biases # Install the required packages for Ultralytics YOLO and Weights & Biases
pip install -U ultralytics wandb pip install -U ultralytics wandb
# Enable W&B logging for Ultralytics
yolo settings wandb=True
``` ```
For detailed instructions and best practices related to the installation process, be sure to check our [YOLO11 Installation guide](../quickstart.md). While installing the required packages for YOLO11, if you encounter any difficulties, consult our [Common Issues guide](../guides/yolo-common-issues.md) for solutions and tips. For detailed instructions and best practices related to the installation process, be sure to check our [YOLO11 Installation guide](../quickstart.md). While installing the required packages for YOLO11, if you encounter any difficulties, consult our [Common Issues guide](../guides/yolo-common-issues.md) for solutions and tips.
@ -108,16 +111,16 @@ Before diving into the usage instructions for YOLO11 model training with Weights
!!! tip "Enable or Disable Weights & Biases" !!! tip "Enable or Disable Weights & Biases"
If you want to enable or disable Weights & Biases logging, you can use the `wandb` command. By default, Weights & Biases logging is enabled. If you want to enable or disable Weights & Biases logging in Ultralytics, you can use the `yolo settings` command. By default, Weights & Biases logging is disabled.
=== "CLI" === "CLI"
```bash ```bash
# Enable Weights & Biases logging # Enable Weights & Biases logging
wandb enabled yolo settings wandb=True
# Disable Weights & Biases logging # Disable Weights & Biases logging
wandb disabled yolo settings wandb=False
``` ```
### Understanding the Output ### Understanding the Output
@ -170,6 +173,7 @@ To integrate Weights & Biases with Ultralytics YOLO11:
```bash ```bash
pip install -U ultralytics wandb pip install -U ultralytics wandb
yolo settings wandb=True
``` ```
2. Log in to your Weights & Biases account: 2. Log in to your Weights & Biases account:
@ -220,13 +224,13 @@ The dashboard offers insights into your model's training process, allowing you t
Yes, you can disable W&B logging using the following command: Yes, you can disable W&B logging using the following command:
```bash ```bash
wandb disabled yolo settings wandb=True
``` ```
To re-enable logging, use: To re-enable logging, use:
```bash ```bash
wandb enabled yolo settings wandb=False
``` ```
This allows you to control when you want to use W&B logging without modifying your training scripts. This allows you to control when you want to use W&B logging without modifying your training scripts.