Docstrings and Code Comments

From The Foundation for Best Practices in Machine Learning
Technical Best Practices > Product Traceability > Docstrings and Code Comments

Docstrings and Code Comments

Control

Document in each function the author of code, purpose of code, input, Output, and improvements to be made. Document the source of inputs and potentially a short business description of data used.


Aim

To (a) ensure Model clarity as to technical progress; and (b) highlight associated risks in the Product Lifecycle.


Additional Information