Document for the project

[miracleyoo]

Hello okankop!

This is a really impressive repo and it definitely saved me from writing those data augmentation functions. Thanks greatly for the great work!

But I do think it will be even better if you can provide a document, however easy it is. Maybe just add something to explain the input parameters at the bottom of the form in README.md.

Thanks again!

[peachman05]

You can pick some augmentation class that you want in vidaug/augmentors/
For example, if you want to do some translation in your video, you can do like this

seq = va.Sequential([
va.RandomTranslate(x=100,y=100), # 100 is mean move +- 100 pixels
])

[PHDPeter]

I feel the code is well commented if you go in and look at each augmentors file but I kind of agree with @miracleyoo it could be clear. That said the only reason to add more documentation would be to add icing to this very useful cake.