Fix naming convention for sleap-convert #881
Merged
Conversation
This file contains hidden or 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
Codecov Report
@@ Coverage Diff @@
## develop #881 +/- ##
===========================================
+ Coverage 66.69% 66.73% +0.03%
===========================================
Files 129 129
Lines 21728 21729 +1
===========================================
+ Hits 14492 14500 +8
+ Misses 7236 7229 -7
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
…l/convert_output-path
talmo
approved these changes
Aug 3, 2022
There was a problem hiding this comment.
lgtm
one small suggestion: in the docs <input path> could maybe be <slp path> so it's clear what we mean by input here? Also an example could be good, like:
Path to output file (optional). The analysis format expects an
output path per video in the project. Otherwise, the default
naming convention
<input path>.<video index>_<video filename>.analysis.h5 will be
used for every video without a specified output path. Multiple
outputs can be specified, each preceded by --output.
Example:
> sleap-convert predictions.slp
predictions.000_video.analysis.h5
predictions.001_video.analysis.h5
...
Does that look right?
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
In #768, we added a feature to handle creating analysis files for multi-video projects; however, we also implemented a semi-automatic naming convention which is unintuitive to users.
This PR gives users control over the output path (as it should have always been) and only starts creating default names if no output path is given for a video in the project.
Ex. 3 output names given with 4 videos will generate 1 default name. Output names are mapped to videos based on ordering of names given and video index in the project.
Types of changes
Does this address any currently open issues?
sleap-convert names files with 000.filename #876
Outside contributors checklist
Thank you for contributing to SLEAP!
❤️