1
Fork 0
This repository has been archived on 2026-08-15. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
2026SEL3-project-Brittle_St.../README.md

41 lines
782 B
Markdown

# Brittle Star
## Usage
### UV
To set up the UV module, you can run the following command:
```bash
uv sync --frozen
```
example command:
```bash
uv run src/train.py --model_name my_model --epochs 50 --batch_size 32
```
## HPC Integration
To run training on the VSC HPC (Ghent Tier 2):
### Setup
Run the installation script once on a login node. This sets up a virtual environment in `$VSC_DATA` with the required system modules (JAX, Flax, WandB) and lightweight dependencies.
```bash
bash scripts/hpc_install.sh
```
### Smoke Test
Verify everything runs on a compute node:
```bash
python src/train.py --config configs/hpc_smoke_test.yaml
```
### Submitting Jobs
Submit long-running experiments via the provided Slurm script:
```bash
sbatch scripts/hpc_train.slurm
```