Skip to content

Add dataset setup instructions to root and subfolder READMEs#190

Open
Ganglet wants to merge 1 commit intoML4SCI:mainfrom
Ganglet:fix-readme-dataset-setup
Open

Add dataset setup instructions to root and subfolder READMEs#190
Ganglet wants to merge 1 commit intoML4SCI:mainfrom
Ganglet:fix-readme-dataset-setup

Conversation

@Ganglet
Copy link
Copy Markdown

@Ganglet Ganglet commented Mar 20, 2026

Fixes #180

Added dataset setup documentation to help new users get started:

  • Root README: Added section 2.1 "Dataset Setup" with download links
    for all four model datasets (Model I–IV) from DeepLenseSim, plus
    expected directory structure
  • Classification Transformers subfolder: Added Model III specific
    download links, image specs, and directory layout

Tested by following the instructions as a first-time contributor to verify clarity.

Addresses ML4SCI#180 by adding:
- Dataset download links for Models I-IV from DeepLenseSim
- Expected directory structure for .npy files
- Setup instructions in both root README and Classification Transformers subfolder README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README lacks clear dataset setup instructions for new users

1 participant