skops icon indicating copy to clipboard operation
skops copied to clipboard

Published 20 hours ago • verified publisher icon skops-dev

RFC make init create a minimal working README.md file

Open adrinjalali opened this issue 2 years ago • 3 comments

The inference and the widget would only work if the metadata section of the README file is present. Should we create an empty modelcard with the necessary sections for those backends to work by default when the user calls hub_utils.init?

adrinjalali avatar Aug 23 '22 12:08 adrinjalali

I think since init already creates files, it would not hurt to create a minimal README.md. If users want to add a proper model card, it wouldn't prevent them from doing that.

BenjaminBossan avatar Aug 23 '22 13:08 BenjaminBossan

Hi! I could try help with this issue. I am aware that hub_utils.init initializes a local repository with the model file and a configuration file that is used to generate the model card. Then we can use the save() method from the Card class to genereate a README.md file. Could you give me a few pointers on how to get started if you are still considering this issue? Thanks!

jucamohedano avatar Oct 26 '22 16:10 jucamohedano

That sounds about right @jucamohedano . One simply needs to generate an empty README file. You can start a PR and we can help you there.

adrinjalali avatar Oct 28 '22 10:10 adrinjalali