-
Notifications
You must be signed in to change notification settings - Fork 182
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation in tutorial is out of date #334
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
The documentation doesn't reflect a recent refactoring of the code where utils.classifcation_dataloader was moved to data.classification_loader.py. This whole documentation section doesn't really reflect that the config management has been moved to hydra. Following along the tutorial results in various errors.
https://github.com/vturrisi/solo-learn/blob/main/docs/source/tutorials/overview.rst
To Reproduce
Copy-paste or link a bash script that reproduces the bug.
produces the following stack trace
Versions
Please report the versions of the packages that you have installed (especially PyTorch and PyTorchLightning) and the version of solo-learn that you are running.
Ubuntu 20.04.6 LTS, Driver Version: 530.30.02, CUDA Version: 12.1, Python 3.9.0
Additional comments
These kind of documentation bugs can be quite frustrating for new users. The documentation for this project is pretty good, but the change to using the hydra config is not very clear. Can I suggest using something like Sphinx's
doctest
to make sure the docs stay up to date?https://sphinx-tutorial.readthedocs.io/step-3/
Also I didn't know how to adjust the example at the bottom of the overview.rst using
python3 main_pretrain.py
to use the hydra cli parameter update notation.The text was updated successfully, but these errors were encountered: