Recipe Style Guide (draft) - ibm-granite-community/pm GitHub Wiki

Style guide for Granite Cookbook recipes.

Headers

• H1 (#): The recipe title. Follow this with a plaintext preamble motivating the recipe.
• H2 (##): The section title. Follow this with a plaintext explanation of the purpose of the section.
• H3 (###): The title of a code block. Follow this with a plaintext description of the code.

General Recipe Structure

1. Title
2. Introduction motivating the recipe.
3. Model Setup
4. Pip installs
5. Imports
6. Data Acquisition
7. Data Prep
8. Model Setup
9. Model Execution
10. Useful Links?