Add Weights and Biases Logger #427

drozzy · 2021-08-27T00:04:18Z

This fixes #426.

Summary of changes

I renamed BasicLogger to TensorboardLogger and updated references everywhere.
I did NOT change the logging api, since I didn't want to mess stuff up. I am not sure what the right signature for write should be. I just wanted to make it work and not break stuff.
I fixed the imports/exports. Double check the utils/__init__.py please.
I added wandb as a dependency in setup. Perhaps it can only be added as a test-time dependency?
I ran all the pep/type/unit tests. All passed except one failed test (I'm not sure if it was failing before, but I can't see how I would have broken it):

test/modelbased/test_psrl.py::test_psrl reward threshold: 3400
FAILED
FAILED test/modelbased/test_psrl.py::test_psrl - KeyError: 'rew'

I get these errors for docstrings and I've no idea how to fix them:

tianshou/utils/logger/wandb.py:8 in public class `WandBLogger`:
        D208: Docstring is over-indented
tianshou/utils/logger/wandb.py:8 in public class `WandBLogger`:
        D209: Multi-line docstring closing quotes should be on a separate line

All other doc tests pass.

P.S.: As a side note, the unit tests take a really long time to run.

Trinkle23897 · 2021-08-29T15:39:15Z

I renamed BasicLogger to TensorboardLogger and updated references everywhere.

better to keep BasicLogger for compatibility, I'll fix that

drozzy · 2021-08-29T17:48:29Z

I renamed BasicLogger to TensorboardLogger and updated references everywhere.

better to keep BasicLogger for compatibility, I'll fix that

I find BaseLogger BasicLogger naming confusing a bit. But maybe we can do it in another release or something.

Trinkle23897 · 2021-08-29T17:50:28Z

I know, I mean

class BasicLogger(TensorboardLogger):
  def __init__(self, *args, **kwargs):
    warnings.warn("better to use TensorboardLogger")
    super().__init__(*args, **kwargs)

drozzy · 2021-08-29T18:44:47Z

Oooh i see, good idea!

Also, for this I usually see people put something like "Deprecated: use TensorboardLogger instead"

Trinkle23897 · 2021-08-29T18:54:09Z

In [1]: from tianshou.utils import BasicLogger

In [2]: a=BasicLogger(None)
/home/trinkle/github/tianshou-new/tianshou/utils/logger/tensorboard.py:135: UserWarning: Deprecated soon: BasicLogger has renamed to TensorboardLogger in #427.
  warnings.warn(

Trinkle23897 · 2021-08-29T18:55:29Z

2. I did NOT change the logging api, since I didn't want to mess stuff up. I am not sure what the right signature for write should be. I just wanted to make it work and not break stuff.

I'm refactoring this part now.

Trinkle23897 · 2021-08-29T19:34:34Z

docs/tutorials/cheatsheet.rst

-2. Use ``BasicLogger`` which contains a tensorboard;
-3. To adjust the save frequency, specify ``save_interval`` when initializing BasicLogger.
+2. Use ``TensorboardLogger``;
+3. To adjust the save frequency, specify ``save_interval`` when initializing TensorboardLogger.


Is it possible to resume an experiment with wandb? like #350

I think so, but I've never dealt with it before. I suggest waiting for people who have that specific need to raise an issue.
Because I think to resume it you need to start it differently - and it may be extra complexity not everyone needs.

Trinkle23897 · 2021-08-29T19:37:25Z

tianshou/policy/modelfree/ppo.py

@@ -22,7 +22,7 @@ class PPOPolicy(A2CPolicy):
    :param float dual_clip: a parameter c mentioned in arXiv:1912.09729 Equ. 5,
        where c > 1 is a constant indicating the lower bound.
        Default to 5.0 (set None if you do not want to use it).
-    :param bool value_clip: a parameter mentioned in arXiv:1811.02553 Sec. 4.1.
+    :param bool value_clip: a parameter mentioned in arXiv:1811.02553v3 Sec. 4.1.


codecov-commenter · 2021-08-29T19:52:04Z

Codecov Report

Merging #427 (268ce9d) into master (e4f4f0e) will decrease coverage by 0.13%.
The diff coverage is 91.34%.

@@            Coverage Diff             @@
##           master     #427      +/-   ##
==========================================
- Coverage   94.82%   94.68%   -0.14%     
==========================================
  Files          58       60       +2     
  Lines        3807     3820      +13     
==========================================
+ Hits         3610     3617       +7     
- Misses        197      203       +6

Flag	Coverage Δ
unittests	`94.68% <91.34%> (-0.14%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
tianshou/policy/modelfree/ppo.py	`93.93% <ø> (ø)`
tianshou/utils/logger/wandb.py	`58.33% <58.33%> (ø)`
tianshou/utils/logger/tensorboard.py	`95.12% <95.12%> (ø)`
tianshou/utils/logger/base.py	`95.83% <95.83%> (ø)`
tianshou/utils/__init__.py	`100.00% <100.00%> (ø)`
tianshou/policy/modelfree/trpo.py	`88.52% <0.00%> (-4.92%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e4f4f0e...268ce9d. Read the comment docs.

Trinkle23897 · 2021-08-29T20:00:44Z

Should I add wandb logger test such as https://wandb.ai/tianshou/tianshou-new-test_continuous/runs/3gcpla04?workspace=user-tianshou?

drozzy · 2021-08-30T02:47:31Z

Those runs are not visible to me.
Regarding tests - it's up to you. I'm not really sure how you could test it.

Trinkle23897 · 2021-08-30T02:49:40Z

Okay so plz review my change

tianshou/utils/logger/wandb.py

drozzy · 2021-08-30T02:56:59Z

Looks good to me, I can start using to make sure everything works.

- fix a bug in #427: logger.write should pass a dict - change SubprocVectorEnv to ShmemVectorEnv in atari - increase logger interval for eps

- rename BasicLogger to TensorboardLogger - refactor logger code - add WandbLogger Co-authored-by: Jiayi Weng <trinkle23897@gmail.com>

- fix a bug in thu-ml#427: logger.write should pass a dict - change SubprocVectorEnv to ShmemVectorEnv in atari - increase logger interval for eps

drozzy added 3 commits August 26, 2021 19:36

Flake fixed

971b4b7

Fixing all the tests and install deps

d8a4d16

fix docstring issues

72e8c40

drozzy mentioned this pull request Aug 27, 2021

[Feature] tianshou logger wandb/wandb#2581

Closed

Merge branch 'master' into master

428f8cb

Trinkle23897 and others added 2 commits August 30, 2021 02:07

Merge branch 'master' into master

587dc6f

fix ci

1493cf7

refactor logger to be more concise

268ce9d

Trinkle23897 reviewed Aug 29, 2021

View reviewed changes

drozzy commented Aug 30, 2021

View reviewed changes

tianshou/utils/logger/wandb.py Show resolved Hide resolved

Trinkle23897 linked an issue Aug 30, 2021 that may be closed by this pull request

Trainer relies on Logger for some values #431

Closed

Trinkle23897 approved these changes Aug 30, 2021

View reviewed changes

Trinkle23897 merged commit 8a5e219 into thu-ml:master Aug 30, 2021

Trinkle23897 mentioned this pull request Sep 8, 2021

fix logger.write error in atari script #444

Merged

Trinkle23897 added a commit that referenced this pull request Sep 8, 2021

fix logger.write error in atari script (#444)

e8f8cdf

- fix a bug in #427: logger.write should pass a dict - change SubprocVectorEnv to ShmemVectorEnv in atari - increase logger interval for eps

BFAnas pushed a commit to BFAnas/tianshou that referenced this pull request May 5, 2024

Add Weights and Biases Logger (thu-ml#427)

0004ac6

- rename BasicLogger to TensorboardLogger - refactor logger code - add WandbLogger Co-authored-by: Jiayi Weng <trinkle23897@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Weights and Biases Logger #427

Add Weights and Biases Logger #427

Uh oh!

drozzy commented Aug 27, 2021

Uh oh!

Trinkle23897 commented Aug 29, 2021

Uh oh!

drozzy commented Aug 29, 2021

Uh oh!

Trinkle23897 commented Aug 29, 2021 •

edited

Loading

Uh oh!

drozzy commented Aug 29, 2021

Uh oh!

Trinkle23897 commented Aug 29, 2021

Uh oh!

Trinkle23897 commented Aug 29, 2021

Uh oh!

Trinkle23897 Aug 29, 2021

Uh oh!

drozzy Aug 30, 2021

Uh oh!

Trinkle23897 Aug 29, 2021

Uh oh!

codecov-commenter commented Aug 29, 2021 •

edited

Loading

Uh oh!

Trinkle23897 commented Aug 29, 2021

Uh oh!

drozzy commented Aug 30, 2021

Uh oh!

Trinkle23897 commented Aug 30, 2021

Uh oh!

Uh oh!

drozzy commented Aug 30, 2021

Uh oh!

Uh oh!

Add Weights and Biases Logger #427

Add Weights and Biases Logger #427

Uh oh!

Conversation

drozzy commented Aug 27, 2021

Summary of changes

Uh oh!

Trinkle23897 commented Aug 29, 2021

Uh oh!

drozzy commented Aug 29, 2021

Uh oh!

Trinkle23897 commented Aug 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

drozzy commented Aug 29, 2021

Uh oh!

Trinkle23897 commented Aug 29, 2021

Uh oh!

Trinkle23897 commented Aug 29, 2021

Uh oh!

Trinkle23897 Aug 29, 2021

Choose a reason for hiding this comment

Uh oh!

drozzy Aug 30, 2021

Choose a reason for hiding this comment

Uh oh!

Trinkle23897 Aug 29, 2021

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Aug 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Trinkle23897 commented Aug 29, 2021

Uh oh!

drozzy commented Aug 30, 2021

Uh oh!

Trinkle23897 commented Aug 30, 2021

Uh oh!

Uh oh!

drozzy commented Aug 30, 2021

Uh oh!

Uh oh!

Trinkle23897 commented Aug 29, 2021 •

edited

Loading

codecov-commenter commented Aug 29, 2021 •

edited

Loading