Refactor video writer to use imageio instead of skvideo #1900
Conversation
WalkthroughThe recent changes enhance video handling in the application by replacing the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ExportClip
participant VideoWriter
User->>ExportClip: Initiate export
ExportClip->>VideoWriter: Check for ffmpeg availability
VideoWriter-->>ExportClip: Return availability status
alt ffmpeg available
ExportClip->>VideoWriter: Encode video with imageio
else ffmpeg not available
ExportClip->>User: Fallback to AVI using OpenCV
end
VideoWriter->>ExportClip: Confirm encoding completion
ExportClip-->>User: Export finished
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- sleap/gui/dialogs/export_clip.py (1 hunks)
- sleap/io/videowriter.py (4 hunks)
Additional context used
Ruff
sleap/io/videowriter.py
144-144:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
Additional comments not posted (4)
sleap/gui/dialogs/export_clip.py (1)
14-23: LGTM! Transition toffmpegviaimageiois clear.The changes correctly update the logic and user messages to reflect the use of
ffmpegthroughimageio, aligning with the PR objectives.sleap/io/videowriter.py (3)
15-15: Importimageio.v2is necessary for new functionality.The import of
imageio.v2is required for the updated video writing functionality.
36-55: Robust transition toimageioforffmpegchecks.The
safe_builderandcan_use_ffmpegmethods correctly transition the dependency check fromskvideotoimageio, ensuring robust functionality.
Line range hint
120-173:VideoWriterImageioclass implementation is sound.The class effectively utilizes
imageiofor video writing, aligning with the refactor objectives. The methods are correctly implemented.Tools
Ruff
144-144:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #1900 +/- ##
===========================================
+ Coverage 73.30% 74.47% +1.16%
===========================================
Files 134 135 +1
Lines 24087 24791 +704
===========================================
+ Hits 17658 18462 +804
+ Misses 6429 6329 -100 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (7)
- environment.yml (1 hunks)
- environment_mac.yml (1 hunks)
- environment_no_cuda.yml (1 hunks)
- sleap/gui/commands.py (1 hunks)
- sleap/gui/dialogs/export_clip.py (1 hunks)
- sleap/io/videowriter.py (4 hunks)
- tests/io/test_videowriter.py (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- sleap/gui/dialogs/export_clip.py
Additional context used
Ruff
sleap/io/videowriter.py
100-100:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
Additional comments not posted (11)
environment_mac.yml (1)
15-15: Addimageio-ffmpegdependency for video processing.The addition of
imageio-ffmpegis appropriate for enabling video processing withimageio. This aligns with the PR objectives to transition fromskvideotoimageio.environment_no_cuda.yml (1)
16-16: Addimageio-ffmpegdependency for video processing.The addition of
imageio-ffmpegis consistent with the changes in other environment files, supporting video processing withimageio.environment.yml (1)
15-15: Addimageio-ffmpegdependency for video processing.The addition of
imageio-ffmpegis necessary for video processing withimageio, aligning with the PR objectives to replaceskvideo.tests/io/test_videowriter.py (3)
Line range hint
5-19: Test functiontest_video_writeris well-structured.The function correctly tests the
VideoWriterby ensuring it writes a video file successfully.
Line range hint
22-36: Test functiontest_cv_video_writeris well-structured.The function correctly tests the
VideoWriterOpenCVby ensuring it writes a video file successfully.
44-67: Comprehensive test forVideoWriterImageio.The function thoroughly tests video writing and verifies attributes like height, width, fps, filename, crf, and preset.
sleap/io/videowriter.py (4)
36-37: Update tosafe_buildermethod is appropriate.The method now correctly uses
VideoWriterImageiowhenffmpegis available, aligning with the refactoring objectives.
Line range hint
76-120: Initialization logic forVideoWriterImageiois well-structured.The constructor initializes necessary attributes and sets up the
imageiowriter with appropriate parameters.Tools
Ruff
100-100:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
126-129: Methodsadd_frameandcloseare correctly implemented.The
add_framemethod usesappend_data, and theclosemethod ensures proper closure of the writer.
42-55: Verifycan_use_ffmpegmethod functionality.The method attempts to import
imageio_ffmpegand check its version, which is a valid approach to determineffmpegavailability.Verification successful
can_use_ffmpegmethod is functioning correctly and integrated properly.The method is used to check for
ffmpegavailability and conditionally adjust functionality, such as user messages, video writer selection, and file naming. The codebase uses it appropriately to ensure smooth operations based onffmpegpresence.
sleap/gui/dialogs/export_clip.py: Determines the message about video encoding.sleap/io/videowriter.py: Chooses betweenVideoWriterImageioandVideoWriterOpenCV.sleap/gui/commands.py: Influences default output filename.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the `can_use_ffmpeg` method functionality by checking for `imageio_ffmpeg` usage. # Test: Search for usage of `can_use_ffmpeg` across the codebase. ast-grep --lang python --pattern $'VideoWriter.can_use_ffmpeg()'Length of output: 291
Script:
#!/bin/bash # Description: Gather context around the usage of `can_use_ffmpeg` in the identified files. # Get context around the usage in sleap/gui/dialogs/export_clip.py rg -A 5 -B 5 'VideoWriter.can_use_ffmpeg()' sleap/gui/dialogs/export_clip.py # Get context around the usage in sleap/io/videowriter.py rg -A 5 -B 5 'VideoWriter.can_use_ffmpeg()' sleap/io/videowriter.py # Get context around the usage in sleap/gui/commands.py rg -A 5 -B 5 'VideoWriter.can_use_ffmpeg()' sleap/gui/commands.pyLength of output: 1365
sleap/gui/commands.py (1)
1332-1333: Update toaskfunction logic is appropriate.The function now defaults to
.aviwhenffmpegis available, aligning with the transition fromskvideo.Also applies to: 1335-1335
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- sleap/io/videowriter.py (4 hunks)
Additional context used
Ruff
sleap/io/videowriter.py
100-100:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
Additional comments not posted (6)
sleap/io/videowriter.py (6)
15-15: Import statement forimageio.v2is necessary.The addition of
imageio.v2is appropriate for replacingskvideowithimageio.
36-37: Changes tosafe_buildermethod are appropriate.The method now correctly checks for
ffmpegavailability and usesVideoWriterImageioif available.
42-55: Changes tocan_use_ffmpegmethod are correct.The method now checks for
imageio_ffmpegavailability, which is essential for usingimageio.
Line range hint
76-120:
Introduction ofVideoWriterImageioclass is well-implemented.The class effectively uses
imageioto handle video writing, replacing the deprecatedskvideo.Tools
Ruff
100-100:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
125-126:add_framemethod implementation is correct.The method uses
append_datato add frames, which aligns withimageiousage.
129-129:closemethod implementation is appropriate.The method ensures the writer is properly closed, which is crucial for resource management.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
sleap/io/videowriter.py (1)
36-38: Use logging instead of print.Replace
- print("USING IMAGEIO") + import logging + logging.info("USING IMAGEIO")
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- sleap/gui/commands.py (1 hunks)
- sleap/io/videowriter.py (4 hunks)
Additional context used
Ruff
sleap/io/videowriter.py
101-101:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
Additional comments not posted (4)
sleap/io/videowriter.py (3)
15-15: Import Approved:imageio.v2.The import of
imageio.v2is necessary for the transition fromskvideotoimageio.
Line range hint
77-130: Implementation Approved:VideoWriterImageio.The
VideoWriterImageioclass is well-implemented, leveragingimageiofor video writing.Tools
Ruff
101-101:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
43-56: Remove unused importimageio_ffmpeg.The import statement for
imageio_ffmpegis not used in the code and should be removed to clean up the imports.- import imageio_ffmpeg as ffmpegLikely invalid or redundant comment.
sleap/gui/commands.py (1)
1332-1335: Logic and Comment Change Approved.The logic for determining the default output filename is appropriate, and the comment change improves readability.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- sleap/gui/dialogs/export_clip.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- sleap/gui/dialogs/export_clip.py
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tests/io/test_videowriter.py (2 hunks)
Additional context used
Ruff
tests/io/test_videowriter.py
2-2:
cv2imported but unusedRemove unused import:
cv2(F401)
Additional comments not posted (3)
tests/io/test_videowriter.py (3)
Line range hint
6-19:
LGTM!The test for
VideoWriteris well-structured and ensures functionality.Tools
Ruff
2-2:
cv2imported but unusedRemove unused import:
cv2(F401)
Line range hint
22-35:
LGTM!The test for
VideoWriterOpenCVis well-structured and ensures functionality.Tools
Ruff
2-2:
cv2imported but unusedRemove unused import:
cv2(F401)
45-68: LGTM!The test for
VideoWriterImageiois comprehensive and ensures both functionality and attribute verification.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- sleap/io/videowriter.py (4 hunks)
- tests/io/test_videowriter.py (2 hunks)
Additional context used
Ruff
sleap/io/videowriter.py
101-101:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
Additional comments not posted (5)
tests/io/test_videowriter.py (2)
45-69: LGTM! Comprehensive test for AVI writing.The test function effectively verifies the functionality of
VideoWriterImageiofor AVI format, ensuring all critical attributes are checked.
71-101: LGTM! Effective test for handling odd-sized frames.The test function ensures that
VideoWriterImageiocorrectly processes frames with non-standard dimensions, maintaining expected attributes.sleap/io/videowriter.py (3)
Line range hint
77-119:
Ensure correct initialization and parameter usage.The
VideoWriterImageioclass is well-implemented, leveragingimageiofor video writing. Ensure that all parameters, such ascrfandpreset, are correctly utilized and documented.Tools
Ruff
101-101:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
101-101: Remove unused import:imageio_ffmpeg.The import statement for
imageio_ffmpegis not used directly in the code and should be removed to clean up the imports.- import imageio_ffmpeg as ffmpegLikely invalid or redundant comment.
Tools
Ruff
101-101:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
36-38: Ensureffmpegavailability check is robust.The
safe_buildermethod now usescan_use_ffmpegto decide on the writer implementation. Ensure thatffmpegis correctly detected in all environments.Verification successful
can_use_ffmpegfunction is robustly implemented.The
can_use_ffmpegfunction insleap/io/videowriter.pycorrectly handlesImportErrorand checks for theffmpegversion, ensuring reliable detection offfmpegavailability.
- Located in
sleap/io/videowriter.pyScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that `can_use_ffmpeg` correctly detects `ffmpeg` availability. # Test: Check for `ffmpeg` detection logic in the codebase. Expect: Correct handling of `ImportError` and version check. ast-grep --lang python --pattern $'def can_use_ffmpeg() { try { import imageio_ffmpeg as ffmpeg } catch ImportError { return False } try { $_ = ffmpeg.get_ffmpeg_version() if $_ { return True } } catch Exception { return False } return False }'Length of output: 964
Script:
#!/bin/bash # Description: Verify that `can_use_ffmpeg` correctly detects `ffmpeg` availability. # Corrected Test: Check for `ffmpeg` detection logic in the codebase. Expect: Correct handling of `ImportError` and version check. ast-grep --lang python --pattern $'def can_use_ffmpeg():\n try:\n import imageio_ffmpeg as ffmpeg\n except ImportError:\n return False\n try:\n version = ffmpeg.get_ffmpeg_version()\n if version:\n return True\n except Exception:\n return False\n return False\n'Length of output: 312
Script:
#!/bin/bash # Description: Search for the `can_use_ffmpeg` function in the codebase. # Use `rg` to search for the function definition across the repository. rg 'def can_use_ffmpeg' -A 10Length of output: 654
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tests/io/test_videowriter.py (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- tests/io/test_videowriter.py
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (1)
sleap/io/videowriter.py (1)
102-102: Clarify the necessity of theimageio_ffmpegimport.The import statement for
imageio_ffmpegis flagged as unused, but it is necessary for checking theffmpegversion. Ensure this is documented to avoid confusion.# Import necessary for checking ffmpeg version import imageio_ffmpeg as ffmpegTools
Ruff
102-102:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- sleap/io/videowriter.py (4 hunks)
Additional context used
Ruff
sleap/io/videowriter.py
102-102:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
Additional comments not posted (2)
sleap/io/videowriter.py (2)
129-129: LGTM! Ensure proper resource management inclose.The
closemethod correctly closes the writer. Ensure that this is called in all code paths to prevent resource leaks.
126-126: Ensure color conversion consistency inadd_frame.The
add_framemethod converts BGR to RGB if specified. Ensure that this behavior aligns with the expected input format forimageio.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- sleap/io/videowriter.py (4 hunks)
Additional context used
Ruff
sleap/io/videowriter.py
100-100:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
Additional comments not posted (6)
sleap/io/videowriter.py (6)
36-37: LGTM! Safe builder logic is sound.The
safe_buildermethod correctly checks forffmpegavailability and defaults toVideoWriterOpenCVif not available.
42-55: Ensure robust exception handling incan_use_ffmpeg.The current implementation uses a broad
Exceptioncatch, which can obscure specific errors. Consider catching more specific exceptions to improve error handling.- except Exception: + except (ImportError, AttributeError):
93-118: Consider parameter validation in__init__.The constructor of
VideoWriterImageioinitializes several parameters. Adding validation for these parameters (e.g., non-negative dimensions, valid FPS) could prevent runtime errors.if height <= 0 or width <= 0: raise ValueError("Height and width must be positive integers.") if fps <= 0: raise ValueError("FPS must be a positive number.")Tools
Ruff
100-100:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
123-124: LGTM! Frame addition logic is correct.The
add_framemethod correctly handles BGR to RGB conversion and appends frames usingimageio.
127-127: LGTM! Writer closure is correctly implemented.The
closemethod correctly closes theimageiowriter.
100-100: Retain necessary importimageio_ffmpeg.The import statement for
imageio_ffmpegis necessary for checkingffmpegavailability in thecan_use_ffmpegmethod.Tools
Ruff
100-100:
imageio_ffmpegimported but unusedRemove unused import:
imageio_ffmpeg(F401)
eberrigan
deleted the
elizabeth/Refactor-VideoWriter-to-use-imageio-instead-of-skvideo
branch
* Remove no-op code from #1498 * Add options to set background color when exporting video (#1328) * implement #921 * simplified form / refractor * Add test function and update cli docs * Improve test function to check background color * Improve comments * Change background options to lowercase * Use coderabbitai suggested `fill` --------- Co-authored-by: Shrivaths Shyam <[email protected]> Co-authored-by: Liezl Maree <[email protected]> * Increase range on batch size (#1513) * Increase range on batch size * Set maximum to a factor of 2 * Set default callable for `match_lists_function` (#1520) * Set default for `match_lists_function` * Move test code to official tests * Check using expected values * Allow passing in `Labels` to `app.main` (#1524) * Allow passing in `Labels` to `app.main` * Load the labels object through command * Add warning when unable to switch back to CPU mode * Replace (broken) `--unrag` with `--ragged` (#1539) * Fix unrag always set to true in sleap-export * Replace unrag with ragged * Fix typos * Add function to create app (#1546) * Refactor `AddInstance` command (#1561) * Refactor AddInstance command * Add staticmethod wrappers * Return early from set_visible_nodes * Import DLC with uniquebodyparts, add Tracks (#1562) * Import DLC with uniquebodyparts, add Tracks * add tests * correct tests * Make the hdf5 videos store as int8 format (#1559) * make the hdf5 video dataset type as proper int8 by padding with zeros * add gzip compression * Scale new instances to new frame size (#1568) * Fix typehinting in `AddInstance` * brought over changes from my own branch * added suggestions * Ensured google style comments --------- Co-authored-by: roomrys <[email protected]> Co-authored-by: sidharth srinath <[email protected]> * Fix package export (#1619) Add check for empty videos * Add resize/scroll to training GUI (#1565) * Make resizable training GUI and add adaptive scroll bar * Set a maximum window size --------- Co-authored-by: Liezl Maree <[email protected]> * support loading slp files with non-compound types and str in metadata (#1566) Co-authored-by: Liezl Maree <[email protected]> * change inference pipeline option to tracking-only (#1666) change inference pipeline none option to tracking-only * Add ABL:AOC 2023 Workshop link (#1673) * Add ABL:AOC 2023 Workshop link * Trigger website build * Graceful failing with seeking errors (#1712) * Don't try to seek to faulty last frame on provider initialization * Catch seeking errors and pass * Lint * Fix IndexError for hdf5 file import for single instance analysis files (#1695) * Fix hdf5 read for single instance analysis files * Add test * Small test files * removing unneccessary fixtures * Replace imgaug with albumentations (#1623) What's the worst that could happen? * Initial commit * Fix augmentation * Update more deps requirements * Use pip for installing albumentations and avoid reinstalling OpenCV * Update other conda envs * Fix out of bounds albumentations issues and update dependencies (#1724) * Install albumentations using conda-forge in environment file * Conda install albumentations * Add ndx-pose to pypi requirements * Keep out of bounds points * Black * Add ndx-pose to conda install in environment file * Match environment file without cuda * Ordered dependencies * Add test * Delete comments * Add conda packages to mac environment file * Order dependencies in pypi requirements * Add tests with zeroes and NaNs for augmentation * Back * Black * Make comment one line * Add todo for later * Black * Update to new TensorFlow conda package (#1726) * Build conda package locally * Try 2.8.4 * Merge develop into branch to fix dependencies * Change tensorflow version to 2.7.4 in where conda packages are used * Make tensorflow requirements in pypi looser * Conda package has TensorFlow 2.7.0 and h5py and numpy installed via conda * Change tensorflow version in `environment_no_cuda.yml` to test using CI * Test new sleap/tensorflow package * Reset build number * Bump version * Update mac deps * Update to Arm64 Mac runners * pin `importlib-metadata` * Pin more stuff on mac * constrain `opencv` version due to new qt dependencies * Update more mac stuff * Patches to get to green * More mac skipping --------- Co-authored-by: Talmo Pereira <[email protected]> Co-authored-by: Talmo Pereira <[email protected]> * Fix CI on macosx-arm64 (#1734) * Build conda package locally * Try 2.8.4 * Merge develop into branch to fix dependencies * Change tensorflow version to 2.7.4 in where conda packages are used * Make tensorflow requirements in pypi looser * Conda package has TensorFlow 2.7.0 and h5py and numpy installed via conda * Change tensorflow version in `environment_no_cuda.yml` to test using CI * Test new sleap/tensorflow package * Reset build number * Bump version * Update mac deps * Update to Arm64 Mac runners * pin `importlib-metadata` * Pin more stuff on mac * constrain `opencv` version due to new qt dependencies * Update more mac stuff * Patches to get to green * More mac skipping * Re-enable mac tests * Handle GPU re-init * Fix mac build CI * Widen tolerance for movenet correctness test * Fix build ci * Try for manual build without upload * Try to reduce training CI time * Rework actions * Fix miniforge usage * Tweaks * Fix build ci * Disable manual build * Try merging CI coverage * GPU/CPU usage in tests * Lint * Clean up * Fix test skip condition * Remove scratch test --------- Co-authored-by: eberrigan <[email protected]> * Add option to export to CSV via sleap-convert and API (#1730) * Add csv as a format option * Add analysis to format * Add csv suffix to output path * Add condition for csv analysis file * Add export function to Labels class * delete print statement * lint * Add `analysis.csv` as parametrize input for `sleap-convert` tests * test `export_csv` method added to `Labels` class * black formatting * use `Path` to construct filename * add `analysis.csv` to cli guide for `sleap-convert` --------- Co-authored-by: Talmo Pereira <[email protected]> * Only propagate Transpose Tracks when propagate is checked (#1748) Fix always-propagate transpose tracks issue * View Hyperparameter nonetype fix (#1766) Pass config getter argument to fetch hyperparameters * Adding ragged metadata to `info.json` (#1765) Add ragged metadata to info.json file * Add batch size to GUI for inference (#1771) * Fix conda builds (#1776) * test conda packages in a test environment as part of CI * do not test sleap import using conda build * use github environment variables to define build path for each OS in the matrix and add print statements for testing * figure out paths one OS at a time * github environment variables work in subsequent steps not current step * use local builds first * print env info * try simple environment creation * try conda instead of mamba * fix windows build path * fix windows build path * add comment to reference pull request * remove test stage from conda build for macs and test instead by creating the environment in a workflow * test workflow by pushing to current branch * test conda package on macos runner * Mac build does not need nvidia channel * qudida and albumentations are conda installed now * add comment with original issue * use python 3.9 * use conda match specifications syntax * make print statements more readable for troubleshooting python versioning * clean up build file * update version for pre-release * add TODO * add tests for conda packages before uploading * update ci comments and branches * remove macos test of pip wheel since python 3.9 is not supported by setup-python action * Upgrade build actions for release (#1779) * update `build.yml` so it matches updates from `build_manual.yml` * test `build.yml` without uploading * test again using build_manual.yml * build pip wheel with Ubuntu and turn off caching so build.yml exactly matches build_manual.yml * `build.yml` on release only and upload * testing caching * `use-only-tar-bz2: true` makes environment unsolvable, change it back * Update .github/workflows/build_manual.yml Co-authored-by: Liezl Maree <[email protected]> * Update .github/workflows/build.yml Co-authored-by: Liezl Maree <[email protected]> * bump pre-release version * fix version for pre-release * run build and upload on release! * try setting `CACHE_NUMBER` to 1 with `use-only-tar-bz2` set to true * increasing the cache number to reset the cache does work when `use-only-tar-bz2` is set to true * publish and upload on release only --------- Co-authored-by: Liezl Maree <[email protected]> * Add ZMQ support via GUI and CLI (#1780) * Add ZMQ support via GUI and CLI, automatic port handler, separate utils module for the functions * Change menu name to match deleting predictions beyond max instance (#1790) Change menu and function names * Fix website build and remove build cache across workflows (#1786) * test with build_manual on push * comment out caching in build manual * remove cache step from builad manual since environment resolves when this is commented out * comment out cache in build ci * remove cache from build on release * remove cache from website build * test website build on push * add name to checkout step * update checkout to v4 * update checkout to v4 in build ci * remove cache since build ci works without it * update upload-artifact to v4 in build ci * update second chechout to v4 in build ci * update setup-python to v5 in build ci * update download-artifact to v4 in build ci * update checkout to v4 in build ci * update checkout to v4 in website build * update setup-miniconda to v3.0.3 in website build * update actions-gh-pages to v4 in website build * update actions checkout and setup-python in ci * update checkout action in ci to v4 * pip install lxml[html_clean] because of error message during action * add error message to website to explain why pip install lxml[html_clean] * remove my branch for pull request * Bump to 1.4.1a1 (#1791) * bump versions to 1.4.1a1 * we can change the version on the installation page since this will be merged into the develop branch and not main * Fix windows conda package upload and build ci (#1792) * windows OS is 2022 not 2019 on runner * upload windows conda build manually but not pypi build * remove comment and run build ci * change build manual back so that it doesn't upload * remove branch from build manual * update installation docs for 1.4.1a1 * Fix zmq inference (#1800) * Ensure that we always pass in the zmq_port dict to LossViewer * Ensure zmq_ports has correct keys inside LossViewer * Use specified controller and publish ports for first attempted addresses * Add test for ports being set in LossViewer * Add max attempts to find unused port * Fix find free port loop and add for controller port also * Improve code readablility and reuse * Improve error message when unable to find free port * Set selected instance to None after removal (#1808) * Add test that selected instance set to None after removal * Set selected instance to None after removal * Add `InstancesList` class to handle backref to `LabeledFrame` (#1807) * Add InstancesList class to handle backref to LabeledFrame * Register structure/unstructure hooks for InstancesList * Add tests for the InstanceList class * Handle case where instance are passed in but labeled_frame is None * Add tests relevant methods in LabeledFrame * Delegate setting frame to InstancesList * Add test for PredictedInstance.frame after complex merge * Add todo comment to not use Instance.frame * Add rtest for InstasnceList.remove * Use normal list for informative `merged_instances` * Add test for copy and clear * Add copy and clear methods, use normal lists in merge method * Bump to v1.4.1a2 (#1835) bump to 1.4.1a2 * Updated trail length viewing options (#1822) * updated trail length optptions * Updated trail length options in the view menu * Updated `prefs` to include length info from `preferences.yaml` * Added trail length as method of `MainWindow` * Updated trail length documentation * black formatting --------- Co-authored-by: Keya Loding <[email protected]> * Handle case when no frame selection for trail overlay (#1832) * Menu option to open preferences directory and update to util functions to pathlib (#1843) * Add menu to view preferences directory and update to pathlib * text formatting * Add `Keep visualizations` checkbox to training GUI (#1824) * Renamed save_visualizations to view_visualizations for clarity * Added Delete Visualizations button to the training pipeline gui, exposed del_viz_predictions config option to the user * Reverted view_ back to save_ and changed new training checkbox to Keep visualization images after training. * Fixed keep_viz config option state override bug and updated keep_viz doc description * Added test case for reading training CLI argument correctly * Removed unnecessary testing code * Creating test case to check for viz folder * Finished tests to check CLI argument reading and viz directory existence * Use empty string instead of None in cli args test * Use keep_viz_images false in most all test configs (except test to override config) --------- Co-authored-by: roomrys <[email protected]> * Allowing inference on multiple videos via `sleap-track` (#1784) * implementing proposed code changes from issue #1777 * comments * configuring output_path to support multiple video inputs * fixing errors from preexisting test cases * Test case / code fixes * extending test cases for mp4 folders * test case for output directory * black and code rabbit fixes * code rabbit fixes * as_posix errors resolved * syntax error * adding test data * black * output error resolved * edited for push to dev branch * black * errors fixed, test cases implemented * invalid output test and invalid input test * deleting debugging statements * deleting print statements * black * deleting unnecessary test case * implemented tmpdir * deleting extraneous file * fixing broken test case * fixing test_sleap_track_invalid_output * removing support for multiple slp files * implementing talmo's comments * adding comments * Add object keypoint similarity method (#1003) * Add object keypoint similarity method * fix max_tracking * correct off-by-one error * correct off-by-one error * Generate suggestions using max point displacement threshold (#1862) * create function max_point_displacement, _max_point_displacement_video. Add to yaml file. Create test for new function . . . will need to edit * remove unnecessary for loop, calculate proper displacement, adjusted tests accordingly * Increase range for displacement threshold * Fix frames not found bug * Return the latter frame index * Lint --------- Co-authored-by: roomrys <[email protected]> * Added Three Different Cases for Adding a New Instance (#1859) * implemented paste with offset * right click and then default will paste the new instance at the location of the cursor * modified the logics for creating new instance * refined the logic * fixed the logic for right click * refined logics for adding new instance at a specific location * Remove print statements * Comment code * Ensure that we choose a non nan reference node * Move OOB nodes to closest in-bounds position --------- Co-authored-by: roomrys <[email protected]> * Allow csv and text file support on sleap track (#1875) * initial changes * csv support and test case * increased code coverage * Error fixing, black, deletion of (self-written) unused code * final edits * black * documentation changes * documentation changes * Fix GUI crash on scroll (#1883) * Only pass wheelEvent to children that can handle it * Add test for wheelEvent * Fix typo to allow rendering videos with mp4 (Mac) (#1892) Fix typo to allow rendering videos with mp4 * Do not apply offset when double clicking a `PredictedInstance` (#1888) * Add offset argument to newInstance and AddInstance * Apply offset of 10 for Add Instance menu button (Ctrl + I) * Add offset for docks Add Instance button * Make the QtVideoPlayer context menu unit-testable * Add test for creating a new instance * Add test for "New Instance" button in `InstancesDock` * Fix typo in docstring * Add docstrings and typehinting * Remove unused imports and sort imports * Refactor video writer to use imageio instead of skvideo (#1900) * modify `VideoWriter` to use imageio with ffmpeg backend * check to see if ffmpeg is present * use the new check for ffmpeg * import imageio.v2 * add imageio-ffmpeg to environments to test * using avi format for now * remove SKvideo videowriter * test `VideoWriterImageio` minimally * add more documentation for ffmpeg * default mp4 for ffmpeg should be mp4 * print using `IMAGEIO` when using ffmpeg * mp4 for ffmpeg * use mp4 ending in test * test `VideoWriterImageio` with avi file extension * test video with odd size * remove redundant filter since imageio-ffmpeg resizes automatically * black * remove unused import * use logging instead of print statement * import cv2 is needed for resize * remove logging * Use `Video.from_filename` when structuring videos (#1905) * Use Video.from_filename when structuring videos * Modify removal_test_labels to have extension in filename * Use | instead of + in key commands (#1907) * Use | instead of + in key commands * Lint * Replace QtDesktop widget in preparation for PySide6 (#1908) * Replace to-be-depreciated QDesktopWidget * Remove unused imports and sort remaining imports * Remove unsupported |= operand to prepare for PySide6 (#1910) Fixes TypeError: unsupported operand type(s) for |=: 'int' and 'Option' * Use positional argument for exception type (#1912) traceback.format_exception has changed it's first positional argument's name from etype to exc in python 3.7 to 3.10 * Replace all Video structuring with Video.cattr() (#1911) * Remove unused AsyncVideo class (#1917) Remove unused AsyncVideo * Refactor `LossViewer` to use matplotlib (#1899) * use updated syntax for QtAgg backend of matplotlib * start add features to `MplCanvas` to replace QtCharts features in `LossViewer` (untested) * remove QtCharts imports and replace with MplCanvas * remove QtCharts imports and replace with MplCanvas * start using MplCanvas in LossViwer instead of QtCharts (untested) * use updated syntax * Uncomment all commented out QtChart * Add debug code * Refactor monitor to use LossViewer._init_series method * Add monitor only debug code * Add methods for setting up axes and legend * Add the matplotlib canvas to the widget * Resize axis with data (no log support yet) * Try using PathCollection for "batch" * Get "batch" plotting with ax.scatter (no log support yet) * Add log support * Add a _resize_axis method * Modify init_series to work for ax.plot as well * Use matplotlib to plot epoch_loss line * Add method _add_data_to_scatter * Add _add_data_to_plot method * Add docstring to _resize_axes * Add matplotlib plot for val_loss * Add matplotlib scatter for val_loss_best * Avoid errors with setting log scale before any positive values * Add x and y axes labels * Set title (removing html tags) * Add legend * Adjust positioning of plot * Lint * Leave MplCanvas unchanged * Removed unused training_monitor.LossViewer * Resize fonts * Move legend outside of plot * Add debug code for montitor aesthetics * Use latex formatting to bold parts of title * Make axes aesthetic * Add midpoint grid lines * Set initial limits on x and y axes to be 0+ * Ensure x axis minimum is always resized to 0+ * Adjust plot to account for plateau patience title * Add debug code for plateau patience title line * Lint * Set thicker line width * Remove unused import * Set log axis on initialization * Make tick labels smaller * Move plot down a smidge * Move ylabel left a bit * Lint * Add class LossPlot * Refactor LossViewer to use LossPlot * Remove QtCharts code * Remove debug codes * Allocate space for figure items based on item's size * Refactor LossPlot to use underscores for internal methods * Ensure y_min, y_max not equal Otherwise we get an unnecessary teminal message: UserWarning: Attempting to set identical bottom == top == 3.0 results in singular transformations; automatically expanding. self.axes.set_ylim(y_min, y_max) --------- Co-authored-by: roomrys <[email protected]> Co-authored-by: roomrys <[email protected]> * Refactor `LossViewer` to use underscores for internal method names (#1919) Refactor LossViewer to use underscores for internal method names * Manually handle `Instance.from_predicted` structuring when not `None` (#1930) * Use `tf.math.mod` instead of `%` (#1931) * Option for Max Stride to be 128 (#1941) Co-authored-by: Max Weinberg <[email protected]> * Add discussion comment workflow (#1945) * Add a bot to autocomment on workflow * Use github markdown warning syntax * Add a multiline warning * Change happy coding to happy SLEAPing Co-authored-by: Talmo Pereira <[email protected]> --------- Co-authored-by: roomrys <[email protected]> Co-authored-by: Talmo Pereira <[email protected]> * Add comment on issue workflow (#1946) * Add workflow to test conda packages (#1935) * Add missing imageio-ffmpeg to meta.ymls (#1943) * Update installation docs 1.4.1 (#1810) * [wip] Updated installation docs * Add tabs for different OS installations * Move installation methods to tabs * Use tabs.css * FIx styling error (line under last tab in terminal hint) * Add installation instructions before TOC * Replace mamba with conda * Lint * Find good light colors not switching when change dark/light themes * Get color scheme switching with dark/light toggle button * Upgrade website build dependencies * Remove seemingly unneeded dependencies from workflow * Add myst-nb>=0.16.0 lower bound * Trigger dev website build * Fix minor typo in css * Add miniforge and one-liner installs for package managers --------- Co-authored-by: roomrys <[email protected]> Co-authored-by: Talmo Pereira <[email protected]> * Add imageio dependencies for pypi wheel (#1950) Add imagio dependencies for pypi wheel Co-authored-by: roomrys <[email protected]> * Do not always color skeletons table black (#1952) Co-authored-by: roomrys <[email protected]> * Remove no module named work error (#1956) * Do not always color skeletons table black * Remove offending (possibly unneeded) line that causes the no module named work error to print in terminal * Remove offending (possibly unneeded) line that causes the no module named work error to print in terminal * Remove accidentally added changes * Add (failing) test to ensure menu-item updates with state change * Reconnect callback for menu-item (using lambda) * Add (failing) test to ensure menu-item updates with state change Do not assume inital state * Reconnect callback for menu-item (using lambda) --------- Co-authored-by: roomrys <[email protected]> * Add `normalized_instance_similarity` method (#1939) * Add normalize function * Expose normalization function * Fix tests * Expose object keypoint sim function * Fix tests * Handle skeleton decoding internally (#1961) * Reorganize (and add) imports * Add (and reorganize) imports * Modify decode_preview_image to return bytes if specified * Implement (minimally tested) replace_jsonpickle_decode * Add support for using idx_to_node map i.e. loading from Labels (slp file) * Ignore None items in reduce_list * Convert large function to SkeletonDecoder class * Update SkeletonDecoder.decode docstring * Move decode_preview_image to SkeletonDecoder * Use SkeletonDecoder instead of jsonpickle in tests * Remove unused imports * Add test for decoding dict vs tuple pystates * Handle skeleton encoding internally (#1970) * start class `SkeletonEncoder` * _encoded_objects need to be a dict to add to * add notebook for testing * format * fix type in docstring * finish classmethod for encoding Skeleton as a json string * test encoded Skeleton as json string by decoding it * add test for decoded encoded skeleton * update jupyter notebook for easy testing * constraining attrs in dev environment to make sure decode format is always the same locally * encode links first then encode source then target then type * save first enconding statically as an input to _get_or_assign_id so that we do not always get py/id * save first encoding statically * first encoding is passed to _get_or_assign_id * use first_encoding variable to determine if we should assign a py/id * add print statements for debugging * update notebook for easy testing * black * remove comment * adding attrs constraint to show this passes for certain attrs version only * add import * switch out jsonpickle.encode * oops remove import * can attrs be unconstrained? * forgot comma * pin attrs for testing * test Skeleton from json, template, with symmetries, and template * use SkeletonEncoder.encode * black * try removing None values in EdgeType reduced * Handle case when nodes are replaced by integer indices from caller * Remove prototyping notebook * Remove attrs pins * Remove sort keys (which flips the neccessary ordering of our py/ids) * Do not add extra indents to encoded file * Only append links after fully encoded (fat-finger) * Remove outdated comment * Lint --------- Co-authored-by: Talmo Pereira <[email protected]> Co-authored-by: roomrys <[email protected]> * Pin ndx-pose<0.2.0 (#1978) * Pin ndx-pose<0.2.0 * Typo * Sort encoded `Skeleton` dictionary for backwards compatibility (#1975) * Add failing test to check that encoded Skeleton is sorted * Sort Skeleton dictionary before encoding * Remove unused import * Disable comment bot for now * Fix COCO Dataset Loading for Invisible Keypoints (#2035) Update coco.py # Fix COCO Dataset Loading for Invisible Keypoints ## Issue When loading COCO datasets, keypoints marked as invisible (flag=0) are currently skipped and later placed randomly within the instance's bounding box. However, in COCO format, these keypoints may still have valid coordinate information that should be preserved (see toy_dataset for expected vs. current behavior). ## Changes Modified the COCO dataset loading logic to: - Check if invisible keypoints (flag=0) have non-zero coordinates - If coordinates are (0,0), skip the point (existing behavior) - If coordinates are not (0,0), create the point at those coordinates but mark it as not visible - Maintain existing behavior for visible (flag=2) and labeled * Lint * Add tracking score as seekbar header options (#2047) * Add `tracking_score` as a constructor arg for `PredictedInstance` * Add `tracking_score` to ID models * Add fixture with tracking scores * Add tracking score to seekbar header * Add bonsai guide for sleap docs (#2050) * [WIP] Add bonsai guide page * Add more information to the guide with images * add branch for website build * Typos * fix links * Include suggestions * Add more screenshots and refine the doc * Remove branch from website workflow * Completed documentation edits from PR made by reviewer + review bot. --------- Co-authored-by: Shrivaths Shyam <[email protected]> Co-authored-by: Liezl Maree <[email protected]> * Don't mark complete on instance scaling (#2049) * Add check for instances with track assigned before training ID models (#2053) * Add menu item for deleting instances beyond frame limit (#1797) * Add menu item for deleting instances beyond frame limit * Add test function to test the instances returned * typos * Update docstring * Add frame range form * Extend command to use frame range --------- Co-authored-by: Talmo Pereira <[email protected]> * Highlight instance box on hover (#2055) * Make node marker and label sizes configurable via preferences (#2057) * Make node marker and label sizes configurable via preferences * Fix test * Enable touchpad pinch to zoom (#2058) * Fix import PySide2 -> qtpy (#2065) * Fix import PySide2 -> qtpy * Remove unnecessary print statements. * Add channels for pip conda env (#2067) * Add channels for pypi conda env * Trigger dev website build * Separate the video name and its filepath columns in `VideoTablesModel` (#2052) * add option to show video names with filepath * add doc * new feature added successfully * delete unnecessary code * remove attributes from video object * Update dataviews.py * remove all properties * delete toggle option * remove video show * fix the order of the columns * remove options * Update sleap/gui/dataviews.py Co-authored-by: Liezl Maree <[email protected]> * Update sleap/gui/dataviews.py Co-authored-by: Liezl Maree <[email protected]> * use pathlib instead of substrings * Update dataviews.py Co-authored-by: Liezl Maree <[email protected]> * Use Path instead of pathlib.Path and sort imports and remove unused imports * Use item.filename instead of getattr --------- Co-authored-by: Liezl Maree <[email protected]> * Make status bar dependent on UI mode (#2063) * remove bug for dark mode * fix toggle case --------- Co-authored-by: Liezl Maree <[email protected]> * Bump version to 1.4.1 (#2062) * Bump version to 1.4.1 * Trigger conda/pypi builds (no upload) * Trigger website build * Add dev channel to installation instructions --------- Co-authored-by: Talmo Pereira <[email protected]> * Add -c sleap/label/dev channel for win/linux - also trigger website build --------- Co-authored-by: Scott Yang <[email protected]> Co-authored-by: Shrivaths Shyam <[email protected]> Co-authored-by: getzze <[email protected]> Co-authored-by: Lili Karashchuk <[email protected]> Co-authored-by: Sidharth Srinath <[email protected]> Co-authored-by: sidharth srinath <[email protected]> Co-authored-by: Talmo Pereira <[email protected]> Co-authored-by: KevinZ0217 <[email protected]> Co-authored-by: Elizabeth <[email protected]> Co-authored-by: Talmo Pereira <[email protected]> Co-authored-by: eberrigan <[email protected]> Co-authored-by: vaibhavtrip29 <[email protected]> Co-authored-by: Keya Loding <[email protected]> Co-authored-by: Keya Loding <[email protected]> Co-authored-by: Hajin Park <[email protected]> Co-authored-by: Elise Davis <[email protected]> Co-authored-by: gqcpm <[email protected]> Co-authored-by: Andrew Park <[email protected]> Co-authored-by: roomrys <[email protected]> Co-authored-by: MweinbergUmass <[email protected]> Co-authored-by: Max Weinberg <[email protected]> Co-authored-by: DivyaSesh <[email protected]> Co-authored-by: Felipe Parodi <[email protected]> Co-authored-by: croblesMed <[email protected]>
Description
skvideois no longer supported and results in a syntax error with newer versions of python (>3.7). We are updating all of our dependencies--see Update to Python 3.10 and SLEAP v1.5.0 #1841.imageio.v2with an ffmpeg backend instead.VideoWriteris re-written and tested to useimageio.v2.VideoWriter.safe_builderchecks ifffmpegis available. It should be since now we installimageio-ffmpegin the environment.VideoWriterImageio. This test should always pass sinceimageio-ffmpegis now in the test environment.safe_buildermethod is tested. It should always useimageionow thatimageio-ffmpegis in the environment.was removed from
output_paramssinceimagio-ffmpegalready resizes : "WARNING:imageio_ffmpeg:IMAGEIO FFMPEG_WRITER WARNING: input image is not divisible by macro_block_size=16, resizing from (406, 720) to (416, 720) to ensure video compatibility with most codecs and players. To prevent resizing, make your input image divisible by the macro_block_size or set the macro_block_size to 1 (risking incompatibility)."imagio-ffmpegresizes automatically correctly for videos with odd number of pixels for height and width.imagio.v2full documentation is not easy to find.The writing parameters are here for convenience from "\miniforge\pkgs\imageio-2.34.2-pyh12aca89_0\site-packages\imageio\plugins"
"""
Parameters for writing
fps : scalar
The number of frames per second. Default 10.
codec : str
the video codec to use. Default 'libx264', which represents the
widely available mpeg4. Except when saving .wmv files, then the
defaults is 'msmpeg4' which is more commonly supported for windows
quality : float | None
Video output quality. Default is 5. Uses variable bit rate. Highest
quality is 10, lowest is 0. Set to None to prevent variable bitrate
flags to FFMPEG so you can manually specify them using output_params
instead. Specifying a fixed bitrate using 'bitrate' disables this
parameter.
bitrate : int | None
Set a constant bitrate for the video encoding. Default is None causing
'quality' parameter to be used instead. Better quality videos with
smaller file sizes will result from using the 'quality' variable
bitrate parameter rather than specifying a fixed bitrate with this
parameter.
pixelformat: str
The output video pixel format. Default is 'yuv420p' which most widely
supported by video players.
input_params : list
List additional arguments to ffmpeg for input file options (i.e. the
stream that imageio provides).
output_params : list
List additional arguments to ffmpeg for output file options.
(Can also be provided as
ffmpeg_paramsfor backwards compatibility)Example ffmpeg arguments to use only intra frames and set aspect ratio:
['-intra', '-aspect', '16:9']
ffmpeg_log_level: str
Sets ffmpeg output log level. Default is "warning".
Values can be "quiet", "panic", "fatal", "error", "warning", "info"
"verbose", or "debug". Also prints the FFMPEG command being used by
imageio if "info", "verbose", or "debug".
macro_block_size: int
Size constraint for video. Width and height, must be divisible by this
number. If not divisible by this number imageio will tell ffmpeg to
scale the image up to the next closest size
divisible by this number. Most codecs are compatible with a macroblock
size of 16 (default), some can go smaller (4, 8). To disable this
automatic feature set it to None or 1, however be warned many players
can't decode videos that are odd in size and some codecs will produce
poor results or fail. See https://en.wikipedia.org/wiki/Macroblock.
audio_path : str | None
Audio path of any audio that needs to be written. Defaults to nothing,
so no audio will be written. Please note, when writing shorter video
than the original, ffmpeg will not truncate the audio track; it
will maintain its original length and be longer than the video.
audio_codec : str | None
The audio codec to use. Defaults to nothing, but if an audio_path has
been provided ffmpeg will attempt to set a default codec.
Types of changes
Does this address any currently open issues?
[list open issues here]
Outside contributors checklist
Thank you for contributing to SLEAP!
❤️
Summary by CodeRabbit
Summary by CodeRabbit
New Features
imageiofor AVI file support.VideoWriterImageioclass to improve video writing functionality.Bug Fixes
ffmpeg, clarifying encoding options.Tests
VideoWriterImageioclass, ensuring robustness in video writing processes.