Skip to content

Commit 7c19838

Browse files
skrawczskrawcz
committed
Fixing docs
1 parent 919ccc2 commit 7c19838

9 files changed

Lines changed: 25 additions & 25 deletions

File tree

‎docs/code-comparisons/dagster.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Dataflow definition
8888
:align: left
8989

9090
+------------------------------------------------------------+----------------------------------------------------------+
91-
| Apache Hamilton | Dagster |
91+
| Apache Hamilton | Dagster |
9292
+============================================================+==========================================================+
9393
| .. literalinclude:: _dagster_snippets/hamilton_dataflow.py | .. literalinclude:: _dagster_snippets/dagster_dataflow.py|
9494
| | |
@@ -125,7 +125,7 @@ Dataflow execution
125125
:align: left
126126

127127
+-------------------------------------------------------------+------------------------------------------------------------+
128-
| Apache Hamilton | Dagster |
128+
| Apache Hamilton | Dagster |
129129
+=============================================================+============================================================+
130130
| .. literalinclude:: _dagster_snippets/hamilton_execution.py | .. literalinclude:: _dagster_snippets/dagster_execution.py |
131131
| | |

‎docs/code-comparisons/kedro.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Imperative (``Kedro``) vs. declarative (``Apache Hamilton``) leads to significan
3030
:align: left
3131

3232
+---------------------------------------------------------+------------------------------------------------------------+
33-
| Kedro (imperative) | Apache Hamilton (declarative) |
33+
| Kedro (imperative) | Apache Hamilton (declarative) |
3434
+=========================================================+============================================================+
3535
| .. literalinclude:: _kedro_snippets/kedro_definition.py | .. literalinclude:: _kedro_snippets/hamilton_definition.py |
3636
| | |
@@ -50,7 +50,7 @@ With ``Apache Hamilton``, you pass the module containing all functions from **St
5050
:align: left
5151

5252
+---------------------------------------------------------+------------------------------------------------------------+
53-
| Kedro (imperative) | Apache Hamilton (declarative) |
53+
| Kedro (imperative) | Apache Hamilton (declarative) |
5454
+=========================================================+============================================================+
5555
| .. literalinclude:: _kedro_snippets/kedro_assemble.py | .. literalinclude:: _kedro_snippets/hamilton_assemble.py |
5656
| | |
@@ -84,7 +84,7 @@ For comparable side-by-side code, we can dig into ``Kedro`` and use the ``Sequen
8484
:align: left
8585

8686
+---------------------------------------------------------+------------------------------------------------------------+
87-
| Kedro (imperative) | Apache Hamilton (declarative) |
87+
| Kedro (imperative) | Apache Hamilton (declarative) |
8888
+=========================================================+============================================================+
8989
| .. literalinclude:: _kedro_snippets/kedro_execution.py | .. literalinclude:: _kedro_snippets/hamilton_execution.py |
9090
| | |

‎docs/code-comparisons/langchain.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ A simple joke example
2525
:align: left
2626

2727
+-----------------------------------------------------------+----------------------------------------------------------+-------------------------------------------------------------+
28-
| Apache Hamilton | Vanilla | LangChain |
28+
| Apache Hamilton | Vanilla | LangChain |
2929
+===========================================================+==========================================================+=============================================================+
3030
| .. literalinclude:: langchain_snippets/hamilton_invoke.py | .. literalinclude:: langchain_snippets/vanilla_invoke.py | .. literalinclude:: langchain_snippets/lcel_invoke.py |
3131
| | | |
@@ -49,7 +49,7 @@ Note: you could use @config.when to include both streamed and non-streamed versi
4949
:align: left
5050

5151
+-------------------------------------------------------------+------------------------------------------------------------+---------------------------------------------------------------+
52-
| Apache Hamilton | Vanilla | LangChain |
52+
| Apache Hamilton | Vanilla | LangChain |
5353
+=============================================================+============================================================+===============================================================+
5454
| .. literalinclude:: langchain_snippets/hamilton_streamed.py | .. literalinclude:: langchain_snippets/vanilla_streamed.py | .. literalinclude:: langchain_snippets/lcel_streamed.py |
5555
| | | |
@@ -74,7 +74,7 @@ e.g. Ray, Dask, etc. We use multi-threading here.
7474
:align: left
7575

7676
+-------------------------------------------------------------+------------------------------------------------------------+---------------------------------------------------------------+
77-
| Apache Hamilton | Vanilla | LangChain |
77+
| Apache Hamilton | Vanilla | LangChain |
7878
+=============================================================+============================================================+===============================================================+
7979
| .. literalinclude:: langchain_snippets/hamilton_batch.py | .. literalinclude:: langchain_snippets/vanilla_batch.py | .. literalinclude:: langchain_snippets/lcel_batch.py |
8080
| | | |
@@ -99,7 +99,7 @@ is that you need to use the async Apache Hamilton Driver.
9999
:align: left
100100

101101
+-------------------------------------------------------------+------------------------------------------------------------+---------------------------------------------------------------+
102-
| Apache Hamilton | Vanilla | LangChain |
102+
| Apache Hamilton | Vanilla | LangChain |
103103
+=============================================================+============================================================+===============================================================+
104104
| .. literalinclude:: langchain_snippets/hamilton_async.py | .. literalinclude:: langchain_snippets/vanilla_async.py | .. literalinclude:: langchain_snippets/lcel_async.py |
105105
| | | |
@@ -125,7 +125,7 @@ that uses the different OpenAI model.
125125
:align: left
126126

127127
+------------------------------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------+
128-
| Apache Hamilton | Vanilla | LangChain |
128+
| Apache Hamilton | Vanilla | LangChain |
129129
+==================================================================+=================================================================+===============================================================+
130130
| .. literalinclude:: langchain_snippets/hamilton_completion.py | .. literalinclude:: langchain_snippets/vanilla_completion.py | .. literalinclude:: langchain_snippets/lcel_completion.py |
131131
| | | |
@@ -152,7 +152,7 @@ to use Anthropic.
152152
:align: left
153153

154154
+------------------------------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------+
155-
| Apache Hamilton | Vanilla | LangChain |
155+
| Apache Hamilton | Vanilla | LangChain |
156156
+==================================================================+=================================================================+===============================================================+
157157
| .. literalinclude:: langchain_snippets/hamilton_anthropic.py | .. literalinclude:: langchain_snippets/vanilla_anthropic.py | .. literalinclude:: langchain_snippets/lcel_anthropic.py |
158158
| | | |
@@ -178,7 +178,7 @@ printing.
178178
:align: left
179179

180180
+------------------------------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------+
181-
| Apache Hamilton | Vanilla | LangChain |
181+
| Apache Hamilton | Vanilla | LangChain |
182182
+==================================================================+=================================================================+===============================================================+
183183
| .. literalinclude:: langchain_snippets/hamilton_logging.py | .. literalinclude:: langchain_snippets/vanilla_logging.py | .. literalinclude:: langchain_snippets/lcel_logging.py |
184184
| | | |
@@ -197,7 +197,7 @@ opinion it's better to be explicit about it.
197197
:align: left
198198

199199
+------------------------------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------+
200-
| Apache Hamilton | Vanilla | LangChain |
200+
| Apache Hamilton | Vanilla | LangChain |
201201
+==================================================================+=================================================================+===============================================================+
202202
| .. literalinclude:: langchain_snippets/hamilton_fallbacks.py | .. literalinclude:: langchain_snippets/vanilla_fallbacks.py | .. literalinclude:: langchain_snippets/lcel_fallbacks.py |
203203
| | | |

‎docs/concepts/best-practices/function-naming.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You don't need to get this right the first time -- search and replace is really
1212
is something to converge thinking on!
1313

1414
It enables you to define your Apache Hamilton dataflow
15-
-----------------------------------------------
15+
------------------------------------------------------
1616

1717
As the name of a hamilton function defines the name of the created artifact, naming is vital to a readable, extensible
1818
hamilton codebase. Names must mean something:

‎docs/concepts/best-practices/migrating-to-hamilton.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
=====================
1+
=============================
22
Migrating to Apache Hamilton
3-
=====================
3+
=============================
44

55
Here are two suggestions for helping you migrate to Apache Hamilton
66

‎docs/get-started/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ It allows you to:
1919

2020

2121
Get started with Apache Hamilton locally
22-
-------------------------------------
22+
----------------------------------------
2323
The following section of the docs will teach you how to install Apache Hamilton and get started with your own project.
2424

2525
.. toctree::

‎docs/hamilton-ui/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
===========
1+
===================
22
Apache Hamilton UI
3-
===========
3+
===================
44

55
Reference
66
---------

‎docs/hamilton-ui/ui.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Then, navigate to the project page (dashboard/projects), in the running UI, and
157157
Remember the project ID -- you'll use it for the next steps.
158158

159159
Existing Apache Hamilton Code
160-
----------------------
160+
------------------------------------
161161
Add the following adapter to your code if you have existing Apache Hamilton code:
162162

163163
.. code-block:: python
@@ -183,7 +183,7 @@ Then run your DAG, and follow the links in the logs! Note that the link is corre
183183
the local mode -- if you're on postgres it links to 8241 (but you'll want to follow it to 8241).
184184

185185
I need some Apache Hamilton code to run
186-
--------------------------------
186+
----------------------------------------------
187187
If you don't have Apache Hamilton code to run this with, you can run Apache Hamilton UI example under `examples/hamilton_ui <https://github.com/apache/hamilton/tree/main/examples/hamilton_ui>`_:
188188

189189
.. code-block:: bash

‎docs/how-tos/use-for-feature-engineering.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Here is a sketch of the above pattern:
5252
5353
5454
Apache Hamilton Example
55-
^^^^^^^^^^^^^^^^
55+
^^^^^^^^^^^^^^^^^^^^^^^
5656
We do not provide a specific example here, since most of the examples in the examples folder fall under this category.
5757
Some examples to browse:
5858

@@ -96,7 +96,7 @@ Here's a sketch of how you might use Apache Hamilton in conjunction with a Kafka
9696

9797

9898
Apache Hamilton Example
99-
^^^^^^^^^^^^^^^^
99+
^^^^^^^^^^^^^^^^^^^^^^^
100100
Currently we don't have a streaming example. But we are working on it. We direct users to look at the online example
101101
for now, since conceptually from a modularity stand point, things would be set up in a similar way.
102102

@@ -120,7 +120,7 @@ the `@config.*` decorator, to help you segment your feature computation dataflow
120120
We skip showing a sketch of structure here, and invite you to look at the examples below.
121121

122122
Apache Hamilton Example
123-
^^^^^^^^^^^^^^^^
123+
^^^^^^^^^^^^^^^^^^^^^^^
124124
We direct users to look at `Feature engineering in multiple contexts <https://github.com/apache/hamilton/tree/main/examples/feature_engineering/feature_engineering_multiple_contexts>`__
125125
that currently describes two scenarios around how you could incorporate Apache Hamilton into an online web-service, and have
126126
it aligned with your batch offline processes. Note, these examples should give you the high level first principles
@@ -139,6 +139,6 @@ FAQ
139139
----
140140

141141
Q. Can I use Apache Hamilton for feature engineering with Feast?
142-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
142+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
143143
Yes, you can use Apache Hamilton with Feast. See our [Feast example](https://github.com/apache/hamilton/tree/main/examples/feast) and accompanying [blog post](https://blog.dagworks.io/p/featurization-integrating-hamilton). Typically people use Apache Hamilton on the offline side to compute features that then
144144
get pushed to Feast. For the online side it varies as to how to integrate the two.

0 commit comments

Comments
 (0)