Skip to content

Commit 40b0f84

Browse files
committed
Update docs for with_columns
Add docs for new with_columns implementations.
1 parent 7002e5d commit 40b0f84

File tree

4 files changed

+27
-7
lines changed

4 files changed

+27
-7
lines changed

docs/reference/decorators/with_columns.rst

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,35 @@
22
with_columns
33
=======================
44

5-
Pandas
6-
--------------
5+
We support the `with_columns` operation that appends the results as new columns to the original dataframe for several libraries:
76

8-
We have a ``with_columns`` option to run operations on columns of a Pandas dataframe and append the results as new columns.
7+
Pandas
8+
-----------------------
99

1010
**Reference Documentation**
1111

1212
.. autoclass:: hamilton.plugins.h_pandas.with_columns
1313
:special-members: __init__
1414

1515

16+
Polar (Eager)
17+
-----------------------
18+
19+
**Reference Documentation**
20+
21+
.. autoclass:: hamilton.plugins.h_polars.with_columns
22+
:special-members: __init__
23+
24+
25+
Polars (Lazy)
26+
-----------------------
27+
28+
**Reference Documentation**
29+
30+
.. autoclass:: hamilton.plugins.h_polars_lazyframe.with_columns
31+
:special-members: __init__
32+
33+
1634
PySpark
1735
--------------
1836

examples/pandas/with_columns/README

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
We show the ability to use the familiar `with_columns` from either `pyspark` or `polars` on a Pandas dataframe.
44

5-
To see the example look at the notebook.
5+
To see the example look at the [notebook](notebook.ipynb).
66

77
![image info](./dag.png)

examples/polars/with_columns/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Using with_columns with Polars
22

3-
We show the ability to use the familiar `with_columns` from `polars`. Supported for both `pl.DataFrame` and `pl.LazyFrame`.
3+
We show the ability to use the familiar `with_columns` from `polars`. Supported for both: `pl.DataFrame` and `pl.LazyFrame`.
44

5-
To see the example look at the notebook.
5+
To see the example look at the [notebook](notebook.ipynb).
66

77
![image info](./DAG_DataFrame.png)
88
![image info](./DAG_lazy.png)

hamilton/function_modifiers/README

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# with_columns_base
22

3-
Documenting the current design flow for the `with_columns` decorator. It belongs to the `NodeInjector` lifecycle.
3+
Documenting the current design flow for the `with_columns` decorator.
4+
5+
For now, it belongs to the `NodeInjector` lifecycle since it still runs the decorated function as a node but injects the dataframe with columns appended columns as one of the parameters.
46

57
The `with_columns` consists of three parts that are represented in the corresponding three abstract methods in `with_columns_base`:
68

0 commit comments

Comments
 (0)