Metadata-Version: 2.1
Name: slune-lib
Version: 0.0.1
Summary: A package for performing hyperparameter tuning with the SLURM scheduling system.
Home-page: https://github.com/h-aze/slune
Author: Henry Bourne
Author-email: hwbourne@gmail.com
License: MIT
Platform: UNKNOWN
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: argparse
Requires-Dist: os
Requires-Dist: pandas
Requires-Dist: subprocess

# slune (slurm + tune!)
A super simplistic way to perform hyperparameter tuning on a cluster using SLURM. Will submit a seperate job script for each run in the tuning and store metrics in a csv and then allow you to easily query for the best hyperparamters based on metric.

Currently very much in early stages, first things still to do:
- Add ability to read results, currently can only submit jobs and log metrics during tuning.
- Refine class structure, ie. subclassing, making sure classes have essential methods, what are the essential methods and attributes? etc.
- Refine package structure and sort out github actions like test coverage, running tests etc.
- Add interfacing with SLURM to check for and re-submit failed jobs etc. 
- Add more tests and documentation.
- Add some more subclasses for saving job results in different ways and for different tuning methods. 
Although the idea for this package is to keep it ultra bare-bones and make it easy for the user to mod and add things themselves to their liking.

To run tests use:
```bash
python -m unittest discover -s . -p 'test_*.py' 
```

