Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: "user guide" section cleanup #826

Merged
merged 2 commits into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/how-tos/cache-nodes.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
======================
Cache Node Computation
Caching results
======================

Sometimes it is convenient to cache intermediate nodes. This is especially useful during development.
Expand Down
2 changes: 1 addition & 1 deletion docs/how-tos/cli-reference.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hamilton CLI
# Command line interface

This page covers the Hamilton CLI. It is built directly from the CLI, but note that the command `hamilton --help` always provide the most accurate documentation.

Expand Down
20 changes: 9 additions & 11 deletions docs/how-tos/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
==============
How To Guides
User Guide
==============

This portion of the documentation goes over the set of common examples for Hamilton usage, so you can apply
Expand All @@ -8,18 +8,16 @@ directory. If there's an example you want but don't see, reach out or open an is


.. toctree::
load-data
use-without-pandas
use-in-jupyter-notebook
run-data-quality-checks
scale-up
use-for-training-models
use-with-dbt
use-online
load-data
use-for-feature-engineering
ml-training
llm-workflows
run-data-quality-checks
use-hamilton-for-lineage
use-hamilton-for-llm-workflows
cache-nodes
scale-up
microservice
wrapping-driver
cli-reference
pre-commit-hooks
cache-nodes
custom-driver
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# How to use Hamilton for LLM Workflows
# LLM workflows

Hamilton is great for describing dataflows, and a lot of "actions" you want
an "agent" to perform can be described as one, e.g. create an embedding
Expand Down
2 changes: 1 addition & 1 deletion docs/how-tos/load-data.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
==================
zilto marked this conversation as resolved.
Show resolved Hide resolved
Load External Data
Loading data
==================

While we've been injecting data in from the driver in previous examples, Hamilton functions are fully capable of loading their own data.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
==============================
Run Hamilton in a Microservice
Microservice
==============================

While we've mainly been discussing running Hamilton in a batch environment, it can easily be used
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
===============================
Use Hamilton for Model Training
Model training
===============================

As Hamilton is a generic library for representing dataflows in pandas, it can be used for a wide array of tasks.
Expand Down
2 changes: 1 addition & 1 deletion docs/how-tos/pre-commit-hooks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hamilton pre-commit
# pre-commit hooks
## Use pre-commit hooks for safer Hamilton code changes

This page gives an introduction to pre-commit hooks and how to use custom hooks to validate your Hamilton code.
Expand Down
2 changes: 1 addition & 1 deletion docs/how-tos/run-data-quality-checks.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
=======================
Run Data Quality Checks
Data quality
=======================

Hamilton comes with data quality included out of the box.
Expand Down
2 changes: 1 addition & 1 deletion docs/how-tos/scale-up.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
=====================
Run Hamilton at Scale
Scaling computation
=====================

Hamilton enables a variety of tools for allowing you to scale your data processing by integrating with third-party libraries.
Expand Down
2 changes: 1 addition & 1 deletion docs/how-tos/use-for-feature-engineering.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
==========================================
Use Hamilton for Feature Engineering
Feature engineering
==========================================

Hamilton's roots are in time-series offline feature engineering. But it can be used for any type of feature engineering:
Expand Down
2 changes: 1 addition & 1 deletion docs/how-tos/use-in-jupyter-notebook.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Using Hamilton in a notebook
# Jupyter notebooks

There are two main ways to use Hamilton in a notebook.

Expand Down
14 changes: 0 additions & 14 deletions docs/how-tos/use-without-pandas.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

Should I define my own Driver?
Wrapping the Driver
------------------------------

The APIs that the Hamilton Driver is built on, are considered internal. So it is possible for you to define your own
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
=====================
Use Hamilton with DBT
dbt
=====================

If you're familiar with DBT, you likely noticed that it can fill a similar role to Hamilton. What DBT does for SQL
Expand Down
10 changes: 9 additions & 1 deletion docs/integrations/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,19 @@ This section showcases how Hamilton integrates with popular frameworks.
fastapi
ibis/index
streamlit
dbt
Airflow <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/airflow>
Amazon Web Services <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/aws>
Burr <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/LLM_Workflows/image_telephone>
Dagster <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/dagster>
Dask <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/dask>
dbt <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/dbt>
Feast <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/feast>
Metaflow <https://github.com/outerbounds/hamilton-metaflow>
Pandera <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/data_quality/pandera>
Plotly <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/plotly>
Polars <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/polars>
Prefect <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/prefect>
Ray <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/ray>
Slack <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/slack>
Spark <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/spark>
Vaex <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/vaex>