Skip to content

Commit

Permalink
Merge pull request #912 from OptimalScale/yizhenjia-readme-upd
Browse files Browse the repository at this point in the history
[doc] Add wandb setup guide
  • Loading branch information
research4pan authored Oct 25, 2024
2 parents b8efbcf + f7a51df commit efac11e
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,31 @@ conda install mpi4py
bash install.sh
```

> [!TIP]
> We use WandB to track and visualize the training process by default. Before running the training scripts, users may need to log in to WandB using the command:
>```bash
>wandb login
>```
> For detailed instructions, refer to the [WandB Quickstart Guide](https://docs.wandb.ai/quickstart/). Step 1 (registration) and Step 2 (login using your WandB API key) should be sufficient to set up your environment.
>
> <details><summary>Disabling wandb</summary>
>
> One can disable wandb by either:
>
> 1. Adding environment variable before running the training command.
>
>```bash
>export WANDB_MODE=disabled
>```
>
> 2. OR, specifying the integrations to report the results and logs to. In the training script, add:
>
>```bash
>--report_to none \
>```
>
> </details>
### Prepare Dataset
Please refer to our [doc](https://optimalscale.github.io/LMFlow/examples/DATASETS.html).
Expand Down

0 comments on commit efac11e

Please sign in to comment.