Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Machine learning model template #7
Teams are hesitant to release their machine learning code open source as they feel it's not as simple as other application code. It would be nice if we had a succinct template to
This stems from my talks with MacroEyes and Har Zindagi. They both are wary about releasing their machine learning models as they might be used improperly or not understood correctly. I think we could really provide a useful resource that hasn't been used beyond more than one project yet.
I think a great outcome for this would be a README template or at very least a how to use document you can embed in the repository/documentation. Something easily accessible like a markdown file
Here's an initial pass, pulling from the above paper.
Basic information about the model.
Use cases that were envisioned during development.
Factors could include demographic or phenotypic groups, environmental conditions, technical attributes, or others.
Metrics should be chosen to reflect potential real-world impacts of the model.
Details on the dataset(s) used for the quantitative analyses in the card.
May not be possible to provide in practice. When possible, this section should mirror Evaluation Data. If such detail is not possible, minimal allowable information should be provided here, such as details of the distribution over various factors in the training datasets.
Caveats and Recommendations