polaris.Step.set_resources

Step.set_resources(cpus_per_task=None, min_cpus_per_task=None, ntasks=None, min_tasks=None, cores=None, min_cores=None, may_span_nodes=None, openmp_threads=None, memory=None, min_memory=None, gpus=None, min_gpus=None, gpus_per_task=None, min_gpus_per_task=None)[source]

Update the resources for the subtask. This can be done within init, setup() or runtime_setup() of this step, or init, configure() or run() for the task that this step belongs to.

Parameters:

  • cpus_per_task (int, optional) – the number of cores per task the step would ideally use. If fewer cores per node are available on the system, the step will run on all available cores as long as this is not below min_cpus_per_task

  • min_cpus_per_task (int, optional) – the number of cores per task the step requires. If the system has fewer than this number of cores per node, the step will fail

  • ntasks (int, optional) – the number of tasks the step would ideally use. If too few cores are available on the system to accommodate the number of tasks and the number of cores per task, the step will run on fewer tasks as long as as this is not below min_tasks

  • min_tasks (int, optional) – the number of tasks the step requires. If the system has too few cores to accommodate the number of tasks and cores per task, the step will fail

  • cores (int, optional) – the number of cores the step needs in total

  • min_cores (int, optional) – the number of cores the step needs in order to run at all

  • may_span_nodes (bool, optional) – whether the step’s cores and GPUs may be drawn from more than one node

  • openmp_threads (int, optional) – the number of OpenMP threads to use

  • memory (int, optional) – the amount of memory in MB the step would ideally be given

  • min_memory (int, optional) – the amount of memory in MB the step needs in order to run at all

  • gpus (int, optional) – the number of GPUs the step would ideally use, as a total for the step rather than a count per task

  • min_gpus (int, optional) – the number of GPUs the step requires, again as a total

  • gpus_per_task (int, optional) –

    the number of GPUs per task the step would ideally use

    Deprecated since version 1.1.0: Use gpus instead

  • min_gpus_per_task (int, optional) –

    the number of GPUs per task the step requires

    Deprecated since version 1.1.0: Use min_gpus instead