docs: add dataset instructions and generation guide#140
Open
Shrishagk wants to merge 1 commit intoML4SCI:mainfrom
Open
docs: add dataset instructions and generation guide#140Shrishagk wants to merge 1 commit intoML4SCI:mainfrom
Shrishagk wants to merge 1 commit intoML4SCI:mainfrom
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
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.
Summary
This PR improves the repository documentation by explaining how to obtain the datasets required to run the notebooks in
DeepLense_Gravitational_Lens_Classification_Transformers_Dhruv_SrivastavaprojectCurrently the notebooks fail because the datasets and folder structure are not described, and new users cannot determine whether the issue is code-related or missing data.
Changes
Added dataset format explanations
Added expected directory structures for each experiment
Added instructions to generate datasets using DeepLenseSim
Clarified dataloader generation workflow
Why this is needed
Without these instructions:
Notebooks throw FileNotFoundError
Users cannot reproduce results
It is unclear that datasets must be generated externally
This PR makes the project reproducible for new contributors.
Type of Change
Documentation improvement (no code changes)
Testing
Verified that a new user can now understand:
Where the data comes from
How to generate it
Where to place it
Why dataloader files are missing