facebookincubator / submitit

Python 3.8+ toolbox for submitting jobs to Slurm
MIT License
1.3k stars 125 forks source link

Documentation of `executor.update_parameters` arguments #1735

Open JoeZiminski opened 1 year ago

JoeZiminski commented 1 year ago

Thanks for making this excellent tool! It works basically out of the box and has proved extremely useful.

Apologies if I am missing something obvious, but it would be great to have a full list of the arguments executor.update_parameters(timeout_min=1, slurm_partition="dev") accepts. I always end up flailing about looking through examples and source code until I find the name of a parameter I want to pass / if it is supported. Maybe there is a better way I'm missing!

yinkaaiwu commented 1 year ago

I agree very much, although I feel that the keywords here are the keyword list of slurm([https://slurm.schedmd.com/sbatch.html]), but I often encounter warnings that I am not using the keywords properly, and I don't know if it is triggered by slurm or submitit. I hope the submitit devs can add a little clarification in the README.