Improve get_file_size efficiency for .npy files #1439
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pgunn
reviewed
Dec 13, 2024
caiman/base/movies.py
Outdated
| elif version == (2, 0): | ||
| shape, _, _ = np.lib.format.read_array_header_2_0(f) | ||
| else: | ||
| raise ValueError(f"Unsupported .npy file version: {version}. Update this code to handle it.") |
There was a problem hiding this comment.
"this code" -> "caiman.base.movies.get_file_size()"
|
Generally looks good! |
|
I've tested this code a bit and it looks good; this is a part of the numpy API I haven't played around with much. |
|
Thanks for the contribution, both this and the preceding diff! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Currently,
caiman.bsae.movies.get_file_sizerequires reading an entire.npyfile into memory to infer its shape. This update modifies the function to read only the file header, greatly improving runtime efficiency.Fixed #1431
Fixes # (issue)
Type of change
Branching
Has your PR been tested?
If you're fixing a bug or introducing a new feature it is recommended you run the tests by typing
caimanmanager testand
caimanmanager demotestprior to submitting your pull request.
Please describe any additional tests that you ran to verify your changes. If they are fast you can also
include them in the folder 'caiman/tests/
and name themtest_***.py` so they can be included in our lists of tests.No additional tests were added, as the change modifies internal behavior without introducing new user-facing functionality or regressions. Existing test coverage should adequately validate this change.