⚡️ Throttle aCompCor_cosine_filter

[shnizzedy]

Fixes

Fixes #2057 by @shnizzedy

Description

• Add "throttle" parameter to Nodes, estimating all available memory when applied.
• Set throttle=True for aCompCor_cosine_filter Node.
• Test memory throttling with both multiproc plugins.
• ⚡️ Throttle calc_ants_warp, cal_DVARS and all cosine_filters #2081

Tests

C-PAC/CPAC/pipeline/test/test_nipype_pipeline_engine.py

Lines 62 to 85 in 3e8c441

	@pytest.mark.parametrize("plugin", [LegacyMultiProcPlugin, MultiProcPlugin])
	@pytest.mark.parametrize("throttle", [True, False])
	def test_throttle(plugin: type, throttle: bool) -> None:
	"""Test Node throttling."""
	small_estimate = 0.0003
	cosfilter_node = Node(
	Function(
	input_names=["input_image_path", "timestep"],
	output_names=["cosfiltered_img"],
	function=cosine_filter,
	as_module=True,
	),
	name="aCompCor_cosine_filter",
	mem_gb=small_estimate,
	throttle=throttle,
	)
	wf = Workflow(name="aCompCor_cosine_filter_wf")
	wf.add_nodes([cosfilter_node])
	plugin(plugin_args={"raise_insufficient": False})._prerun_check(wf._graph)
	if throttle:
	assert cosfilter_node.mem_gb > small_estimate
	assert cosfilter_node.mem_gb <= get_system_total_memory_gb()
	else:
	assert cosfilter_node.mem_gb == small_estimate

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the develop branch of the repository.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added tests for the changes I made (if applicable).
• I updated the changelog.
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.