Docs: explain configuration and dataset flow in DeepLense SSL #110
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a detailed docstring explaining the purpose and flow of the ssltrain.py script for self-supervised learning on gravitational lensing images.
Added comments to clarify the steps for loading configuration, computing dataset statistics, and initializing SSL training methods.
Adds a beginner-friendly guide describing dataset structure, indices usage, configuration flow, common setup issues, and a recommended quick sanity-check configuration for the SSL pipeline.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a beginner-friendly documentation page explaining how configuration
files, dataset paths, and indices are used in the DeepLense SSL pipeline.
It covers:
indices.pklThis documentation is intended to reduce setup friction, improve reproducibility,
and help first-time contributors run the SSL pipeline correctly before launching
long experiments.
No training or model logic is modified.