augraphy icon indicating copy to clipboard operation
augraphy copied to clipboard

Documentation Update

Open amitbcp opened this issue 3 years ago • 6 comments

Problem Faced : While using the repo, it took some time to go through all the available augmentations and there examples as many markdowns don't have sample results, and many Colab's examples throw and error due to code changes in the repo

PR : This PR will update all the existing augmentations with examples and Colab, while adding any missing augmentation as well

Currently only a sample addition was done to test the setup and PR

@proofconstruction @kwcckw @jboarman let me know if it will be helpful, they I can go ahead and update the augmentation usage accordingly

amitbcp avatar Jun 19 '22 11:06 amitbcp

Problem Faced : While using the repo, it took some time to go through all the available augmentations and there examples as many markdowns don't have sample results, and many Colab's examples throw and error due to code changes in the repo

PR : This PR will update all the existing augmentations with examples and Colab, while adding any missing augmentation as well

Currently only a sample addition was done to test the setup and PR

@proofconstruction @kwcckw @jboarman let me know if it will be helpful, they I can go ahead and update the augmentation usage accordingly

Sorry some of the docs are not updated yet, but i think it might be too memory consuming if we add example images for all augmentations. At this moment, i think it's good to just update those docs.

kwcckw avatar Jun 19 '22 13:06 kwcckw

@kwcckw cool, will do that. though we can also push images to LFS if space is a concern, as the images are not more than 50-100Kb

will update the Colab and notes till then

amitbcp avatar Jun 20 '22 03:06 amitbcp

@kwcckw cool, will do that. though we can also push images to LFS if space is a concern, as the images are not more than 50-100Kb

will update the Colab and notes till then

Thanks ! For now i think just updating the colab will be good. But are you able to edit the colab files in the doc?

kwcckw avatar Jun 22 '22 06:06 kwcckw

@kwcckw no if I edit the existing Colab and save, it will save a new copy. So I am updating Colab with the new notebook links as I test them

amitbcp avatar Jun 22 '22 08:06 amitbcp

@kwcckw no if I edit the existing Colab and save, it will save a new copy. So I am updating Colab with the new notebook links as I test them

I see, could you share me those links once they are updated? I will go through them first and update them accordingly.

kwcckw avatar Jun 22 '22 08:06 kwcckw

sure

amitbcp avatar Jun 22 '22 09:06 amitbcp

@amitbcp Hi there ... I really want to be able to merge in your PR. Can you pull in the latest version from the dev branch and resolve conflicts so that we can close out this PR?

If you are not available for that, let me know and we can close out this PR if you prefer.

jboarman avatar Feb 18 '23 22:02 jboarman

@jboarman sorry for the long delay. Let me complete this PR within this week. Thanks for the heads

amitbcp avatar Feb 20 '23 03:02 amitbcp

@amitbcp If you are able to resolve this conflict by Monday, I'd love to include you as an official contributor. Otherwise, I will close this PR at that time.

jboarman avatar Mar 11 '23 19:03 jboarman

@jboarman sorry for the delay. I am closing this ticket as all of changes in the repo have made the docs to .rst and the new docs are updated with the correct examples eliminating the Colab Notebooks

amitbcp avatar Mar 12 '23 12:03 amitbcp