docs: add local dataset setup guide to README (#180)#204
Open
DhruvrajSinhZala24 wants to merge 1 commit intoML4SCI:mainfrom
Open
docs: add local dataset setup guide to README (#180)#204DhruvrajSinhZala24 wants to merge 1 commit intoML4SCI:mainfrom
DhruvrajSinhZala24 wants to merge 1 commit intoML4SCI:mainfrom
Conversation
Adds download steps, expected directory layout, and quickstart commands.
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
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.
Related Issues
Description
This pull request introduces a new section to the repository
README.mdcontaining detailed instructions for obtaining and organizing the simulated datasets locally.The lack of clear dataset setup guidance was identified as a barrier for new contributors to properly initialize the environment. These additions directly address that gap by providing concrete download steps, the expected directory structure, and quickstart commands for both training and evaluation.
Changes Included
README.md.DeepLenseSim.data/Model_*directory layout for proper data ingestion by the models.