-
Notifications
You must be signed in to change notification settings - Fork 113
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
Docs for the methods withConcurrentDevices and withMemoryLimit #328
Conversation
Besides, this change adds the function `withoutMemoryLimit` for the TornadoExecutionPlan.
This PR builds on top of the #327. Thus the order to review is |
@@ -259,16 +283,35 @@ public TornadoExecutionPlan withoutProfiler() { | |||
} | |||
|
|||
/** | |||
* Prevents the TornadoExecutionPlan to execute if the I/O buffers exceed the provided limit. | |||
* Set a limit to the amount of memory used on the target hardware accelerator. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sets a limit ...
* Prevents the TornadoExecutionPlan to execute if the I/O buffers exceed the provided limit. | ||
* Set a limit to the amount of memory used on the target hardware accelerator. | ||
* The TornadoVM runtime will check that the current instance of the | ||
* {@link TornadoExecutionPlan} does not exceed the limit that was fixed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed -> specified
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than @mikepapadim 's comments, it looks good to me.
Improvements ~~~~~~~~~~~~~~~~~~ - `#323 <https://github.com/beehive-lab/TornadoVM/pull/323>`_: Set Accelerator Memory Limit per Execution Plan at the API level - `#328 <https://github.com/beehive-lab/TornadoVM/pull/328>`_: Javadoc API to run with concurrent devices and memory limits - `#340 <https://github.com/beehive-lab/TornadoVM/pull/340>`_: New API calls to enable ``threadInfo`` and ``printKernel`` from the Execution Plan API. - `#334 <https://github.com/beehive-lab/TornadoVM/pull/334>`_: Dynamically enable/disable profiler after first run Compatibility ~~~~~~~~~~~~~~~~~~ - `#337 <https://github.com/beehive-lab/TornadoVM/pull/337>`_ : Initial support for Graal and JDK 21.0.2 Bug Fixes ~~~~~~~~~~~~~~~~~~ - `#322 <https://github.com/beehive-lab/TornadoVM/pull/322>`_: Fix duplicate thread-info debug message when the debug option is also enabled. - `#325 <https://github.com/beehive-lab/TornadoVM/pull/325>`_: Set/Get accesses for the ``MatrixVectorFloat4`` type fixed - `#326 <https://github.com/beehive-lab/TornadoVM/pull/326>`_: Fix installation script for running with Python >= 3.12 - `#327 <https://github.com/beehive-lab/TornadoVM/pull/327>`_: Fix Memory Limits for all supported Panama off-heap types. - `#329 <https://github.com/beehive-lab/TornadoVM/pull/329>`_: Fix timers for the dynamic reconfiguration policies - `#330 <https://github.com/beehive-lab/TornadoVM/pull/330>`_: Fix the profiler logs when silent mode is enabled - `#332 <https://github.com/beehive-lab/TornadoVM/pull/332>`_: Fix Batch processing when having multiple task-graphs in a single execution plan.
Description
This PR adds documentation for the functions
withConcurrentDevices
andwithMemoryLimit
.It also adds a new function to disable the memory limit of an execution plan.
Backend/s tested
Mark the backends affected by this PR.
OS tested
Mark the OS where this PR is tested.
Did you check on FPGAs?
If it is applicable, check your changes on FPGAs.
How to test the new patch?