dependencies

Author: adityaranjan

README.md

@@ -1,10 +1,40 @@
 # Plexus
 
-Plexus is a 3D parallel framework designed for large-scale distributed GNN training.
+Plexus is a 3D parallel framework for large-scale distributed GNN training.
+
+## Dependencies
+
+To use Plexus, you'll need the following dependencies:
+
+* **Python 3.11.7:** It's recommended to use a virtual environment to manage your Python dependencies. You can create one using `venv`:
+
+    ```bash
+    python -m venv <your_env_name>
+    source <your_env_name>/bin/activate
+    ```
+
+* **CUDA 12.4:** If you'll be running Plexus on GPUs, you'll need CUDA 12.4. On systems where modules are used to manage software, you can load it with the following command (this is present in the run script under the examples directory for Perlmutter):
+
+    ```bash
+    module load cudatoolkit/12.4
+    ```
+
+* **NCCL:** The NVIDIA Collective Communications Library (NCCL) is required for multi-GPU communication.  On systems where modules are used (like Perlmutter), you can load it with:
+
+    ```bash
+    module load nccl
+    ```
+
+* **Python Dependencies:** Once your virtual environment is set up, you can install the required Python packages using `pip` and the `requirements.txt` file provided in the repository:
+
+    ```bash
+    pip install -r requirements.txt
+    ```
 
 ## Directory Structure
 
--   **benchmarking**: Contains a serial implementation using PyTorch Geometric (PyG) for validation and testing. Additionally, it includes utilities for benchmarking Sparse Matrix-Matrix Multiplication (SpMM) operations, a key component in GNN computations.
--   **examples**: Offers a practical demonstration of how to leverage Plexus to parallelize a GNN model. This directory includes example scripts for running the parallelized training, as well as utilities for parsing the resulting performance data.
--   **performance**: Houses files dedicated to modeling the performance characteristics of parallel GNN training. This includes models for communication overhead, computation costs (specifically SpMM), and memory utilization.
--   **plexus**: Contains the core logic of the Plexus framework. This includes the parallel implementation of a Graph Convolutional Network (GCN) layer, along with utility functions for dataset preprocessing, efficient data loading, and other essential components for distributed GNN training.
+* **benchmarking**: Contains a serial implementation using PyTorch Geometric (PyG) for validation and testing. Additionally, it includes utilities for benchmarking Sparse Matrix-Matrix Multiplication (SpMM) operations, a key component in GNN computations.
+* **examples**: Offers a practical demonstration of how to leverage Plexus to parallelize a GNN model. This directory includes example scripts for running the parallelized training, as well as utilities for parsing the resulting performance data.
+* **performance**: Houses files dedicated to modeling the performance characteristics of parallel GNN training. This includes models for communication overhead, computation costs (specifically SpMM), and memory utilization.
+* **plexus**: Contains the core logic of the Plexus framework. This includes the parallel implementation of a Graph Convolutional Network (GCN) layer, along with utility functions for dataset preprocessing, efficient data loading, and other essential components for distributed GNN training.
+

requirements.txt

@@ -0,0 +1,5 @@
+axonn==0.2.0
+numpy==2.2.3
+ogb==1.3.6
+torch==2.6.0
+torch_geometric==2.6.1