README lacks clear dataset setup instructions for new users #180
Description
Problem
New users or contributors may find it difficult to run the project because the repository README does not clearly explain how to download, prepare, and place the required datasets.
Current Situation
Although the repository contains scripts for training and evaluation, it is not immediately clear:
• Where the dataset should be downloaded from
• Where the dataset should be placed in the project directory
• What the expected folder structure should look like
• Whether any preprocessing is required before running the training scripts
This can make the setup process confusing for first-time contributors.
Suggested Improvement
Add a Dataset Setup section in the README that explains:
• Where to download the dataset
• The expected directory structure (for example data/<dataset_name>/)
• Any preprocessing or configuration steps required before running the training scripts
Benefits
• Makes the repository easier for new contributors to use
• Improves documentation quality
• Reduces setup issues and questions from users
Additional Context
Clear dataset setup instructions would greatly improve the onboarding experience for researchers and contributors who want to experiment with the DeepLense models.