From a3011cd86af2b215f940fe8fc83bdacb9a4c093e Mon Sep 17 00:00:00 2001 From: Howuhh Date: Wed, 19 Jul 2023 17:06:17 +0300 Subject: [PATCH] note about reports --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48293538..05a5063c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,6 +91,9 @@ parameters: ``` Then proceed as usual. Create wandb sweep with `wandb sweep sweep_config.yaml`, then run agents with `wandb agent `. +Based on the results, you will need to make wandb reports to make it easier for other users to understand. +You can use any of the already existing ones as an example (see [README.md](README.md)). + ### Checklist - [ ] Issue about new algorithm is open @@ -98,4 +101,4 @@ Then proceed as usual. Create wandb sweep with `wandb sweep sweep_config.yaml`, - [ ] PR has passed all the tests - [ ] Evidence that implementation reproduces original results is provided - [ ] Configs with the best hyperparameters for all datasets are added to the `configs/contrib` -- [ ] Logs for best hyperparameters are submitted to our wandb organization +- [ ] Logs and reports for best hyperparameters are submitted to our wandb organization