composer icon indicating copy to clipboard operation
composer copied to clipboard

Document difference between *Hparams and associated class

Open growlix opened this issue 3 years ago • 1 comments

We should explicitly describe the difference between usage scenarios for Hparams objects vs the classes they end up instantiating (e.g. TQDMLogger vs. TQDMLoggerHparams). I think the right place to do this is probably in every *Hparams docstring. I am thinking something like:

*Hparams is used to instantiate * via YAML configs instead of calling it directly.

but I might be missing something because I'm not an expert.

growlix avatar Feb 17 '22 01:02 growlix

Need to add a YAHP tutorial, and then we can link in each docstring to the yahp tutorial.

ravi-mosaicml avatar Feb 24 '22 21:02 ravi-mosaicml

YAHP is gone :)

mvpatel2000 avatar Nov 03 '22 03:11 mvpatel2000