From f0605e3725ff3c28cebe66f47761922e32936329 Mon Sep 17 00:00:00 2001 From: Jannis Klinkenberg <j.klinkenberg@itc.rwth-aachen.de> Date: Wed, 19 Mar 2025 14:39:18 +0100 Subject: [PATCH] filled first README.md with content --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index acc74af..1a895c9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ -# Examples for HPC cluster usage +# Examples for HPC cluster usage at RWTH Aachen University -... coming soon ... +This repository contains a collection of examples, best practices, and guidelines for effectively using the High-Performance Computing (HPC) cluster at RWTH Aachen University. Whether you are new to HPC or an experienced user, you will find useful scripts, job submission templates, performance tuning tips, and troubleshooting advice. + +For general help, documentation, and trainings please refer to the following pages: +- [RWTH HPC user documentation](https://www.itc.rwth-aachen.de/hpc-doc) +- [RWTH HPC consultation hour](https://blog.rwth-aachen.de/itc-events/en/hpc-consultation-hour/) +- [HPC wiki](https://hpc-wiki.info) +- [HPC trainings](https://blog.rwth-aachen.de/itc-events) +- [RWTH technical support](mailto:servicedesk@itc.rwth-aachen.de) + +## What can you find here? + +| Folder | Description | +|--------|-------------| +| [generic-job-scripts](generic-job-scripts) | General-purpose job submission scripts (our current workload is Slurm) for various workloads, including CPU and GPU-based computations. | +| [pytorch](pytorch) | Example scripts and best practices for running PyTorch workloads on an HPC cluster, including distributed training and GPU utilization. | +| [scikit-learn](scikit-learn) | HPC-friendly examples of using Scikit-Learn, including job submission scripts for machine learning model training. | +| [tensorflow](tensorflow) | TensorFlow job scripts and performance optimization techniques for running deep learning models on CPUs and GPUs in an HPC environment. | \ No newline at end of file -- GitLab