dei-blade-template

A project template to run experiments on the DEI's Blade cluster

Getting Started

1. Install copier: pipx install copier
2. Copy this template: copier copy gh:CSCPadova/dei-blade-template your-project-name --trust
3. Personalize the project as you want

Project Structure

The project is structured as follows:

template
├── .copier-answers.yml      # variables used to fill the template
├── .editorconfig            # editor configuration
├── .gitattributes
├── .gitignore
├── .pre-commit-config.yaml  # pre-commit configuration
├── LICENSE
├── log
│   ├── err                  # where to store stderr logs
│   └── out                  # where to store stdout logs
├── Makefile
├── pyproject.toml           # python project configuration
├── README.md
├── slurm
│   ├── infer.sh             # script to run inference on the cluster
│   └── train.sh             # script to run training on the cluster
└── src
    └── {{ project_name }}
        ├── infer.py
        ├── __init__.py
        ├── __main__.py
        ├── model.py
        └── train.py

• .copier-answers.yml: this file contains the variables used to fill the template, do not modify it manually unless you know what you are doing
• .editorconfig: this is a well-known configuration file that helps developers define and maintain consistent coding styles between different editors and IDEs
• .gitattributes: this file is used to define attributes for paths in the repository
• .gitignore: this file is used to specify intentionally untracked files to ignore
• .pre-commit-config.yaml: this file is used to configure pre-commit, a framework for managing and maintaining multi-language pre-commit hooks
• LICENSE: this file contains the license of the project, by default it is set to MIT
• log: this directory contains the logs of the experiments
• Makefile: this file contains the commands to run the experiments
• pyproject.toml: this file contains the configuration of the python project
• README.md: this file contains the instructions to run the experiments
• slurm: this directory contains the scripts to run the experiments on the Blade cluster
• src: this directory contains the source code of the project

Aknowledgements

This project template is based on the following open-source projects:

• git
• editorconfig
• pre-commit
• python
• slurm
• make
• copier
• uv

License

This project template is licensed under the MIT License - see the LICENSE file for details, please note that the generated project will inherit this license.