Optimize internal clip_values function #1104
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR partially addresses #862
[ ✏️ Write your summary here. ]
The significant improvement comes from using
np.sum
andnp.clip
directly on the arrays.For memory I used the memory-profiler library. The code I used for benchmarking is copied below. In addition I sorted the imports in the modified files.
Code Setup
Current version
This PR
Testing
I faced an issue when I initialy refactored the code. When we call
float(sum(x))
it produces a TypeError if the array is not 1D. To maintain that behavior, which is asserted in the tests, I added the conditional check in theclip_values
function.References
Reviewer Notes
There are a few more functions that could be refactored in this file but I will open those in a different PR because of the TypeError unit test.
The reason behind the conditional check to raise the TypeError is explained above, basically it is about ensuring that the test expecting a TypeError is still valid, however maybe we could remove that test and accept other array shapes in this function like (1, N) or (N, 1) arrays for example.