Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC make init create a minimal working README.md file #113

Open
adrinjalali opened this issue Aug 23, 2022 · 3 comments
Open

RFC make init create a minimal working README.md file #113

adrinjalali opened this issue Aug 23, 2022 · 3 comments

Comments

@adrinjalali
Copy link
Member

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?

@BenjaminBossan
Copy link
Collaborator

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.

@jucamohedano
Copy link
Contributor

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!

@adrinjalali
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants