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

Add readme.md into the Kitfile / ModelKit #84

Open
bmicklea opened this issue Mar 8, 2024 · 0 comments
Open

Add readme.md into the Kitfile / ModelKit #84

bmicklea opened this issue Mar 8, 2024 · 0 comments
Labels
enhancement New feature or request ModelKit Topics related to ModelKit next-sprint

Comments

@bmicklea
Copy link
Contributor

bmicklea commented Mar 8, 2024

Describe the problem your feature would solve
It can sometimes be difficult to understand what a model is meant to be used for and what datasets are / why they were included.

Describe the solution you'd like
A readme included in the ModelKit would make it easy for the Kitfile producer and consumer to understand the context for the ModelKit and the assets it is packaging.

Describe alternatives you've considered
Descriptions in the Kitfile are okay, but are either very short and keep the Kitfile readable, or are very long and wreck the readability.

Additional context
[none]

@bmicklea bmicklea added enhancement New feature or request ModelKit Topics related to ModelKit labels Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ModelKit Topics related to ModelKit next-sprint
Projects
None yet
Development

No branches or pull requests

1 participant