Improve README documentation with clearer usage instructions#9
Open
Asadp3406 wants to merge 1 commit intoML4SCI:mainfrom
Open
Improve README documentation with clearer usage instructions#9Asadp3406 wants to merge 1 commit intoML4SCI:mainfrom
Asadp3406 wants to merge 1 commit intoML4SCI:mainfrom
Conversation
- Add comprehensive README for Non_local_Jet_Classification project - Enhance Graph_Representation_Learning README with detailed setup and troubleshooting - Restructure Physics_Informed_NN README for better readability - Add troubleshooting section to main README with common issues and solutions - Include runtime estimates, expected outputs, and performance tips - Standardize README structure across all projects for consistency Addresses issue ML4SCI#7: Improve README with clearer usage and execution instructions
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.
Improve README Documentation for Better Usability
Fixes #7
Changes Made
This PR significantly improves the documentation across all project READMEs to help new contributors reproduce workflows more easily:
Main README (
README.md)Individual Project READMEs
Non-local Jet Classification - Created complete README from scratch
Graph Representation Learning - Major enhancement
Physics-Informed Neural Networks - Restructured for clarity
🧪 Testing
📋 Checklist
This addresses the need for clearer usage and execution instructions mentioned in issue #7, making it much easier for new contributors to get started with any of the GENIE projects.