DOC Autogeneration of getting started code #132
Conversation
merveenoyan
requested review from
adrinjalali and
BenjaminBossan
and removed request for
adrinjalali
|
Model card created from this branch, the code is automatically generated: https://huggingface.co/merve/test-code-generation |
Co-authored-by: Benjamin Bossan <BenjaminBossan@users.noreply.github.com>
|
@BenjaminBossan I think it looks a bit ugly and our example already includes metadata from config file so that's why I wanted to remove it (it will be a duplication if we add that too). |
|
Yes, I'm aware that in the example, it doesn't make sense. What I meant is to document it some other place so that users have a chance of discovering it (as is, the only way to discover the feature is by reading the template). If we can assume, however, that the vast majority of users create the section automatically, then maybe it's not necessary. |
|
@adrinjalali what do you suggest? |
|
I think since w/o the config file people won't really would know what to do with the model file, it's safe to assume the config file is there, especially for an example in the skops library, which generates that file. |
skops/card/_model_card.py
Outdated
| f"import pickle\nwith open({model_file}, 'rb') as file:\n clf =" | ||
| " pickle.load(file)" |
There was a problem hiding this comment.
I think we can also add a predict example here, with the data available in the config file.
There was a problem hiding this comment.
Addressed. new version of card: https://huggingface.co/merve/test-code-generation
|
@adrinjalali done, new model card: https://huggingface.co/merve/test-code-generation |
There was a problem hiding this comment.
That looks gorgeous, thanks for giving an example one on the Hug @merveenoyan , it really does help with the review.
adrinjalali
changed the title
This PR solves #126.
I also made a fixture out of metadata creation from config file so that it can be used repeatedly. Let me know if this is not good.