Improved README with a Quick Start, Dataset Setup and Project Usage G…#187
Open
vnzhere wants to merge 2 commits intoML4SCI:mainfrom
Open
Improved README with a Quick Start, Dataset Setup and Project Usage G…#187vnzhere wants to merge 2 commits intoML4SCI:mainfrom
vnzhere wants to merge 2 commits intoML4SCI:mainfrom
Conversation
Author
|
Hi! Just following up on this PR. |
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.
Description
This PR improves the project documentation by updating the main README.md. The goal is to streamline the onboarding process for new contributors and researchers using the DeepLense repository.
Key Changes
Quick Start Guide: Added a step-by-step section to get the environment running quickly.
Dataset Setup: Detailed instructions on how to acquire and organize the necessary data for the models.
Project Usage: Clear examples of how to run the main scripts/notebooks within the repository.
Motivation
As part of my GSoC contribution, I noticed that the initial setup could be more intuitive for newcomers. These additions aim to reduce the "time-to-first-run" for anyone diving into the codebase.
Checklist
[x] My code follows the style guidelines of this project.
[x] I have performed a self-review of my own code.
[x] I have commented my code, particularly in hard-to-understand areas.
[x] My changes generate no new warnings.