Skip to content

Instantly share code, notes, and snippets.

@razhangwei

razhangwei/notebook_style.md

Last active December 3, 2024 17:28
Show Gist options
  • Save razhangwei/86449f49eceed0673a05ebd049fae74f to your computer and use it in GitHub Desktop.
Save razhangwei/86449f49eceed0673a05ebd049fae74f to your computer and use it in GitHub Desktop.
Download ZIP
Good Styles for Jupyter notebook
Raw
notebook_style.md

Typical good structure:

  • Title
    • Overview.
  • Table of Contents
  • Roadmap
  • Setup
  • Configuration
  • Data Loading
  • Evaluation Function
  • Results Analysis

Notes:

  • We should decouple the config from code; so put config into a google sheat and load from there.

For magics command such as %load_ext autoreload, add # pragma: uncomment to the front %load_ext autoreload %autoreload 2

Additional tips

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment