From 2ad076abc9a090bb1e0e790a4c0a8778e3b16b32 Mon Sep 17 00:00:00 2001 From: adityaswian26 Date: Sat, 3 Jan 2026 13:09:21 +0000 Subject: [PATCH] Improve README installation instructions and clarity --- .../README.md | 41 +++++++++---------- 1 file changed, 19 insertions(+), 22 deletions(-) diff --git a/Graph_Representation_Learning_Rushil_Singha/README.md b/Graph_Representation_Learning_Rushil_Singha/README.md index ead8c90..1055e22 100644 --- a/Graph_Representation_Learning_Rushil_Singha/README.md +++ b/Graph_Representation_Learning_Rushil_Singha/README.md @@ -2,7 +2,7 @@ A PyTorch/PyTorch-Geometric implementation of a **graph-based diffusion model** for generating realistic jets from the [JetNet dataset](https://huggingface.co/datasets/jetnet). -This project builds **k-nearest neighbor (kNN) jet graphs**, learns **Chebyshev GCN (ChebNet) embeddings**, trains a **diffusion model in latent space**, and decodes back into particle-level jets. +This model builds **k-nearest neighbor (kNN) jet graphs**, learns **Chebyshev GCN (ChebNet) embeddings**, trains a **diffusion model in latent space**, and decodes generated samples back into particle-level jets. --- @@ -18,37 +18,34 @@ This project builds **k-nearest neighbor (kNN) jet graphs**, learns **Chebyshev ## ⚙️ Installation -Clone the repo and install dependencies: +Clone the ML4Sci GENIE repository and navigate to this project directory : ```bash -git clone https://github.com/your-username/jetnet-graph-diffusion.git -cd jetnet-graph-diffusion - +git clone https://github.com/ML4SCI/GENIE.git +cd GENIE/Graph_Representation_Learning_Rushil_Singha +``` +Install dependencies: +```bash pip install -r requirements.txt +``` +## 🏃 Quick Start + +After installing dependencies, run: -requirements.txt - -numpy==1.24.3 -torch==2.0.0 -torch-geometric -torch-scatter -torch-sparse -torch-cluster -networkx -scikit-learn -jetnet +```bash +python code.py ``` -# This script: +# This script will: -->Encodes jets into latent space +- Encodes jets into latent space -->Runs diffusion training +- Runs diffusion training -->Decodes jets back into particle space +- Decodes jets back into particle space -->Logs evaluation metrics +- Logs evaluation metrics -->Saves visualizations to results/ +- Saves visualizations to results/