You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
To Reproduce
Copy-paste or link a bash script that reproduces the bug.
from solo.utils.classification_dataloader import prepare_data as prepare_data_classification
# and some utilities to perform data loading for the method itself, including augmentation pipelines
from solo.utils.pretrain_dataloader import (
prepare_dataloader,
prepare_datasets,
prepare_n_crop_transform,
prepare_transform,
)
produces the following stack trace
$ python3 my_custom_trainer.py
home/matt/miniconda3/envs/solo-learn/lib/python3.9/site-packages/pl_bolts/models/self_supervised/amdim/amdim_module.py:35: UnderReviewWarning: The feature generate_power_seq is currently marked under review. The compatibility with other Lightning projects is not guaranteed and API may change at any time. The API and functionality may change without warning in future releases. More details: https://lightning-bolts.readthedocs.io/en/latest/stability.html
"lr_options": generate_power_seq(LEARNING_RATE_CIFAR, 11),
/home/matt/miniconda3/envs/solo-learn/lib/python3.9/site-packages/pl_bolts/models/self_supervised/amdim/amdim_module.py:93: UnderReviewWarning: The feature FeatureMapContrastiveTask is currently marked under review. The compatibility with other Lightning projects is not guaranteed and API may change at any time. The API and functionality may change without warning in future releases. More details: https://lightning-bolts.readthedocs.io/en/latest/stability.html
contrastive_task: Union[FeatureMapContrastiveTask] = FeatureMapContrastiveTask("01, 02, 11"),
/home/matt/miniconda3/envs/solo-learn/lib/python3.9/site-packages/pl_bolts/losses/self_supervised_learning.py:234: UnderReviewWarning: The feature AmdimNCELoss is currently marked under review. The compatibility with other Lightning projects is not guaranteed and API may change at any time. The API and functionality may change without warning in future releases. More details: https://lightning-bolts.readthedocs.io/en/latest/stability.html
self.nce_loss = AmdimNCELoss(tclip)
/home/matt/miniconda3/envs/solo-learn/lib/python3.9/site-packages/pl_bolts/datamodules/experience_source.py:18: UnderReviewWarning: The feature warn_missing_pkg is currently marked under review. The compatibility with other Lightning projects is not guaranteed and API may change at any time. The API and functionality may change without warning in future releases. More details: https://lightning-bolts.readthedocs.io/en/latest/stability.html
warn_missing_pkg("gym")
Traceback (most recent call last):
File "/home/matt/phd/solo-learn/my_custom_trainer.py", line 13, in <module>
from solo.utils.classification_dataloader import prepare_data as prepare_data_classification
ModuleNotFoundError: No module named 'solo.utils.classification_dataloader'
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:
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: