keras-unet-collection icon indicating copy to clipboard operation
keras-unet-collection copied to clipboard

Published 20 hours ago • verified publisher icon yingkaisha

Docs improvement

Open andreped opened this issue 1 year ago • 0 comments

Love the project!

I have tested it a while back but when I came back to the project yesterday I had a hard time remembering if it was hosted on PyPI or not from the README. When checking the README I failed to spot how to install, which is the first line here.

To make it easier for the user, I would recommend separating the installation and the Usage sections and write:

pip install keras-unet-collection

instead of just pip install keras-unet-collection, which I believe is more standard and easier for the reader to see. In the README installation, I also reminded the user that the project is hosted on the PyPI.

When making the PR, I also noticed some minor inconsistencies and SSIM not being properly defined. I made adjustments for that as well.

You can see how the final README looks in my fork here.

andreped avatar Feb 22 '23 08:02 andreped