Improve README with Quick Start guide and Graphviz installation steps#1527
Improve README with Quick Start guide and Graphviz installation steps#1527Aditya-Deshwal23 wants to merge 7 commits intoapache:mainfrom
Conversation
|
@Aditya-Deshwal23 can you rebase the branch please? |
Aditya-Deshwal23
force-pushed
the
improve-readme-quickstart
branch
from
1f90f9a to
88e85a3
Compare
@skrawcz Rebased the branch as requested. Please review again. |
|
Hi @skrawcz, I’ve rebased the branch and addressed the feedback. Could you please take another look when you get a chance? Thanks! |
docs: update python version to 3.9+ Co-authored-by: Stefan Krawczyk <stefan@dagworks.io>
docs: add LLM workflows mention Co-authored-by: Stefan Krawczyk <stefan@dagworks.io>
|
Hi @skrawcz, I’ve addressed the requested changes and pushed the updates, including the Quick Start improvements and formatting fixes. |
Aditya-Deshwal23
left a comment
Aditya-Deshwal23
left a comment
There was a problem hiding this comment.
updated to use builder pattern and verified example runs correctly
| # pip install sf-hamilton | ||
|
|
||
| # Step 2: Define your functions (nodes in the DAG) | ||
| def A() -> int: |
There was a problem hiding this comment.
do you mean someone should write a file? I think this only works if someone writes a file. This wont work in a notebook or REPL, right?
|
|
||
| dr = ( | ||
| driver.Builder() | ||
| .with_modules(__name__) |
There was a problem hiding this comment.
this doesn't work. I don't know how you ran this to make this work.
with_modules(self, *modules: ModuleType) -> "Builder":
takes a module, not a string.
I don't think so. Can you show it running? |
2 participants
Summary
Added a Quick Start section and improved Graphviz installation instructions in the README.
Motivation
The current README is comprehensive but lacks a minimal working example for beginners.
This change helps new users quickly understand how to use Apache Hamilton with a simple example.
Changes
Impact
Improves onboarding experience for new users and reduces setup friction.