diff --git a/docs/how-tos/cache-nodes.rst b/docs/how-tos/cache-nodes.rst index 33738e41d..043754ddb 100644 --- a/docs/how-tos/cache-nodes.rst +++ b/docs/how-tos/cache-nodes.rst @@ -1,5 +1,5 @@ ====================== -Cache Node Computation +Caching results ====================== Sometimes it is convenient to cache intermediate nodes. This is especially useful during development. diff --git a/docs/how-tos/cli-reference.md b/docs/how-tos/cli-reference.md index b140a09a2..342e1bbcb 100644 --- a/docs/how-tos/cli-reference.md +++ b/docs/how-tos/cli-reference.md @@ -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. diff --git a/docs/how-tos/index.rst b/docs/how-tos/index.rst index a528f3a5d..56e22f457 100644 --- a/docs/how-tos/index.rst +++ b/docs/how-tos/index.rst @@ -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 @@ -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 diff --git a/docs/how-tos/use-hamilton-for-llm-workflows.md b/docs/how-tos/llm-workflows.md similarity index 97% rename from docs/how-tos/use-hamilton-for-llm-workflows.md rename to docs/how-tos/llm-workflows.md index d7a1f29ef..1992903c8 100644 --- a/docs/how-tos/use-hamilton-for-llm-workflows.md +++ b/docs/how-tos/llm-workflows.md @@ -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 diff --git a/docs/how-tos/load-data.rst b/docs/how-tos/load-data.rst index 2e22cfc32..1e2fe1351 100644 --- a/docs/how-tos/load-data.rst +++ b/docs/how-tos/load-data.rst @@ -1,5 +1,5 @@ ================== -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. diff --git a/docs/how-tos/use-online.rst b/docs/how-tos/microservice.rst similarity index 95% rename from docs/how-tos/use-online.rst rename to docs/how-tos/microservice.rst index 177ae616e..bbf90eada 100644 --- a/docs/how-tos/use-online.rst +++ b/docs/how-tos/microservice.rst @@ -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 diff --git a/docs/how-tos/use-for-training-models.rst b/docs/how-tos/ml-training.rst similarity index 96% rename from docs/how-tos/use-for-training-models.rst rename to docs/how-tos/ml-training.rst index fe4674577..be0289f07 100644 --- a/docs/how-tos/use-for-training-models.rst +++ b/docs/how-tos/ml-training.rst @@ -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. diff --git a/docs/how-tos/pre-commit-hooks.md b/docs/how-tos/pre-commit-hooks.md index 780105285..52b868fa8 100644 --- a/docs/how-tos/pre-commit-hooks.md +++ b/docs/how-tos/pre-commit-hooks.md @@ -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. diff --git a/docs/how-tos/run-data-quality-checks.rst b/docs/how-tos/run-data-quality-checks.rst index 536380f7f..52d2a5e21 100644 --- a/docs/how-tos/run-data-quality-checks.rst +++ b/docs/how-tos/run-data-quality-checks.rst @@ -1,5 +1,5 @@ ======================= -Run Data Quality Checks +Data quality ======================= Hamilton comes with data quality included out of the box. diff --git a/docs/how-tos/scale-up.rst b/docs/how-tos/scale-up.rst index ebf26fab8..a7d28df95 100644 --- a/docs/how-tos/scale-up.rst +++ b/docs/how-tos/scale-up.rst @@ -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. diff --git a/docs/how-tos/use-for-feature-engineering.rst b/docs/how-tos/use-for-feature-engineering.rst index 9fceadf2c..08ada96b0 100644 --- a/docs/how-tos/use-for-feature-engineering.rst +++ b/docs/how-tos/use-for-feature-engineering.rst @@ -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: diff --git a/docs/how-tos/use-in-jupyter-notebook.md b/docs/how-tos/use-in-jupyter-notebook.md index dd3b1e062..7c4d23e2d 100644 --- a/docs/how-tos/use-in-jupyter-notebook.md +++ b/docs/how-tos/use-in-jupyter-notebook.md @@ -1,4 +1,4 @@ -# Using Hamilton in a notebook +# Jupyter notebooks There are two main ways to use Hamilton in a notebook. diff --git a/docs/how-tos/use-without-pandas.rst b/docs/how-tos/use-without-pandas.rst deleted file mode 100644 index b00c839c3..000000000 --- a/docs/how-tos/use-without-pandas.rst +++ /dev/null @@ -1,14 +0,0 @@ -=========================== -Use Hamilton without Pandas -=========================== - -As we made clear earlier, Making use of Hamilton does not require that you utilize Pandas. -Not only can hamilton functions output any valid python object, but Hamilton also naturally integrates -with a few dataframe libraries. - -In this example, we rebuild the hello_world example using the `polars `_ library. - -https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/polars. - -Note that we are currently working on other examples, including one for pyspark -(Hamilton already has native `pandas-on-spark `_ support). diff --git a/docs/how-tos/custom-driver.rst b/docs/how-tos/wrapping-driver.rst similarity index 97% rename from docs/how-tos/custom-driver.rst rename to docs/how-tos/wrapping-driver.rst index 4fc628897..f63d2459e 100644 --- a/docs/how-tos/custom-driver.rst +++ b/docs/how-tos/wrapping-driver.rst @@ -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 diff --git a/docs/how-tos/use-with-dbt.rst b/docs/integrations/dbt.rst similarity index 96% rename from docs/how-tos/use-with-dbt.rst rename to docs/integrations/dbt.rst index 7d96b9b39..61abaf917 100644 --- a/docs/how-tos/use-with-dbt.rst +++ b/docs/integrations/dbt.rst @@ -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 diff --git a/docs/integrations/index.rst b/docs/integrations/index.rst index 831ddaf17..7fb9aaafb 100644 --- a/docs/integrations/index.rst +++ b/docs/integrations/index.rst @@ -9,11 +9,19 @@ This section showcases how Hamilton integrates with popular frameworks. fastapi ibis/index streamlit + dbt Airflow + Amazon Web Services + Burr + Dagster Dask - dbt Feast + Metaflow Pandera + Plotly + Polars Prefect Ray + Slack Spark + Vaex