Inital user docs for video player AB#17082 #580
Conversation
tmiller-msft
commented
Feb 14, 2019
tmiller-msft
commented
- Initial user docs for video player
| @@ -28,6 +28,9 @@ VoTT helps facilitate an end-to-end machine learning pipeline: | |||
| <!-- command: `markdown-toc -i README.md`--> | |||
|
|
|||
| <!-- toc --> | |||
| - [VoTT (Visual Object Tagging Tool)](#vott-visual-object-tagging-tool) | |||
There was a problem hiding this comment.
Hmm.. I didn't add this, why did it show up here?
There was a problem hiding this comment.
i had a similar problem... some extension I was using in VSCode understands the auto-generated toc comments and when I save the markdown, it re-gens the toc. I usually end up stripping it out, using another editor.
Not sure if anyone else is seeing similar behavior. annoying enough that maybe we should just leave it in.
Codecov Report
@@ Coverage Diff @@
## v2 #580 +/- ##
=======================================
Coverage 86.57% 86.57%
=======================================
Files 119 119
Lines 3397 3397
Branches 584 584
=======================================
Hits 2941 2941
Misses 456 456Continue to review full report at Codecov.
|
|
LGTM - I like the annotations in the image. |
README.md
Outdated
|
|
||
| In addition to the normal video playback controls, there are two extra pairs of buttons. | ||
|
|
||
| On the left, there are the previous and next frame buttons. Clicking these will pause the video, and move to the next appropriate frame as determined by the project settings. For example, if the project settings have a frame extraction rate of 1, these buttons will cause the video to be moved back or forward 1 second, where if the frame extraction rate was 10, the video will be moved back or forward a tenth of a second. |
There was a problem hiding this comment.
3rd sentence: "…,while if the frame extraction rate is 10, …"
README.md
Outdated
|
|
||
| On the right, there are the previous and next tagged frame buttons. Clicking these will pause the video and move to the next or previous frame that has a previously tagged region on it, if a tagged frame exists. | ||
|
|
||
| Colored lines will also be visible along the video's timeline. These indicate the video frames that have been already been visited. A yellow line denotes a frame that has been visited only, while a green line denotes a frame that has been both visited and tagged. The bars can be clicked for quick navigation to the indicated frame. |
There was a problem hiding this comment.
2nd sentence, typo: "...frames that have already been visited"
4th sentence: "The colored lines can be clicked..."
It sounds repetitive to keep saying colored lines, but I think it's clearer.
README.md
Outdated
|
|
||
| Colored lines will also be visible along the video's timeline. These indicate the video frames that have been already been visited. A yellow line denotes a frame that has been visited only, while a green line denotes a frame that has been both visited and tagged. The bars can be clicked for quick navigation to the indicated frame. | ||
|
|
||
| The timeline can also be used to manually scrub through the video to an arbitrary point, though the project settings for frame extraction rate are always obeyed. Pausing the video will move to the closest frame according to this project setting. This way, a very low frame extraction rate (say 1 frame per second) can be set for sections of the video known to contain few taggable items, and a much higher frame extraction rate, such as 30 frames per second, to allow fine-grained control. |
There was a problem hiding this comment.
3rd sentence: "such as 1 frame per second"
Sorry to be so pedantic.
