User Guide

This portion of the documentation goes over the set of common examples for Hamilton usage, so you can apply it to your day-to-day work. Each one corresponds to an example in the examples directory. If there’s an example you want but don’t see, reach out or open an issue on github – we’re always looking to add more.

• Jupyter notebooks
  • 1 - Dynamically create modules within your notebook
    • Use Hamilton Jupyter Magic
    • Using ad_hoc_utils to create a temporary module (e.g. use in google colab)
    • Caveat with this approach:
  • 2 - Importing modules into your notebook
    • Step 1 — Install Jupyter & Hamilton
    • Step 2— Set up the files
    • Step 3— The basic process of iteration
  • Pro-tip: You can use ipython magic to autoreload code
  • Pro-tip: You can import functions directly
• Loading data
• Feature engineering
  • Offline Feature Engineering
    • Hamilton Example
  • Streaming Feature Engineering
    • Hamilton Example
  • Online Feature Engineering
    • Hamilton Example
  • Write once, run anywhere blog post:
  • FAQ
    • Q. Can I use Hamilton for feature engineering with Feast?
• Model training
• LLM workflows
• Data quality
• Lineage + Hamilton
  • Common Problems (and therefore questions)
  • What is “Lineage”?
  • Hamilton’s Lineage Capabilities
    • Lineage as Code
    • Reproducibility
    • Auditing and Compliance
    • Troubleshooting and Debugging
    • Collaboration
  • Recipe for using Hamilton’s Lineage Capabilities
  • A script you could write to ask questions of your DAGs
• Caching results
• Scaling computation
• Microservice
• Wrapping the Driver
• Command line interface
  • Installation
  • hamilton (global)
  • hamilton build
  • hamilton diff
  • hamilton version
  • hamilton view
• pre-commit hooks
  • Use pre-commit hooks for safer Hamilton code changes
  • What are pre-commit hooks?
  • Add pre-commit hooks to your project
    • Steps to get started
  • Custom Hamilton pre-commit hooks
    • Checking dataflow definition
    • Checking dataflow paths
  • Add Hamilton pre-commit to your project