pytorch-image-models icon indicating copy to clipboard operation
pytorch-image-models copied to clipboard

[FEATURE] Refactor ReadMe

Open ParagEkbote opened this issue 10 months ago • 3 comments

Is your feature request related to a problem? Please describe. I think we can refactor the ReadMe and make it a bit simple and decluttered. Firstly, we could add the library logo and reorder the sections such as keeping the introduction, getting started and feature sections to the top and move other sections below. Could you please let me know and I will be happy to contribute with a PR.

timm2

cc: @rwightman

Additional context The following projects can be considered for reference:

https://github.com/huggingface/diffusers

https://github.com/huggingface/transformers

ParagEkbote avatar Jan 11 '25 19:01 ParagEkbote

Gentle ping

cc: @rwightman

ParagEkbote avatar Jan 19 '25 16:01 ParagEkbote

@ParagEkbote README could use some tweaking but not aiming to make it cookie cutter of the others. There is a TOC for quick jumping. Right now it's not a priority though as I'm trying to work through quite a few large changes so probably makes sense to wait until the dust settles...

rwightman avatar Jan 21 '25 17:01 rwightman

@rwightman Please free to ping me when it's the time to do so.

ParagEkbote avatar Jan 21 '25 17:01 ParagEkbote