Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add max_mem_mb config option to set max memory available (issue #343) #344

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

jaamarks
Copy link
Collaborator

@jaamarks jaamarks commented Oct 3, 2024

What
This PR introduces a new optional workflow parameter for the config.yml called max_mem_mb. Users can set this parameter to specify the maximum amount of memory they can request. When this option is set, the memory allocation will be as follows: {1: max_mem / 3, 2: max_mem / 2, 3: max_mem}. This allocation applies only to certain resource-intensive rules.

Why
We discovered that some memory-intensive rules, such as sample_level_ibd, require a significant amount of memory to execute. Previously, we had a fixed allocation request of {1: 1024 * 4, 2: 1024 * 64, 3: 1024 * 250}. However, some users may have constraints on the amount of memory they can request. This new parameter allows them to specify their available memory, enabling more flexible and efficient memory allocation.

Fixes #343

This commit introduces a ``max_mem_mb`` workflow parameter to the
``config.yml``, similar to the previously added ``max_time_hr`` option.
Users can specify the maximum amount of memory (in MB) that they can
request on their machine.
@jaamarks jaamarks merged commit 0df8110 into NCI-CGR:default Oct 3, 2024
2 checks passed
@jaamarks jaamarks changed the title feat: Add max_mem_mb config option to set max memory available feat: Add max_mem_mb config option to set max memory available (issue #343) Oct 3, 2024
@jaamarks jaamarks changed the title feat: Add max_mem_mb config option to set max memory available (issue #343) feat: Add max_mem_mb config option to set max memory available (issue #343) Oct 3, 2024
@jaamarks jaamarks deleted the issue343-max-mem-mb branch October 3, 2024 20:54
@jaamarks
Copy link
Collaborator Author

jaamarks commented Oct 15, 2024

This PR addresses part of issue #316 and issue #315.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

implement max_mem_mb option in the config file to resolve memory issues withsample_level_ibd rule
1 participant