updated README #963
Merged
updated README #963
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
skrawcz
reviewed
Jun 14, 2024
skrawcz
reviewed
Jun 14, 2024
skrawcz
reviewed
Jun 14, 2024
skrawcz
reviewed
Jun 14, 2024
skrawcz
reviewed
Jun 14, 2024
skrawcz
approved these changes
Jun 14, 2024
elijahbenizzy
approved these changes
Jun 16, 2024
README.md
Outdated
|
|
||
| # Hamilton | ||
| With Hamilton, write a directed acyclic graph (DAG) of data transformations using regular Python functions. You don't even need to `import hamilton`! It uses the function name and parameters to resolve the graph. As shown below, functions specify their dependencies, resulting in readable code that can always be visualized. |
There was a problem hiding this comment.
Reiterate the tagline in the first sentence -- provides value
README.md
Outdated
|
|
||
| from hamilton import driver | ||
| - **Low-friction dev to prod**. Use `@config.when()` to modify your DAG between execution environments instead of error-prone `if/else` feature flags. The notebook extension prevents the pain of migrating code from a notebook to a Python module. |
There was a problem hiding this comment.
Order is off -- put higher value ones first (effective collaboration + low-friction dev-to-prod)
There was a problem hiding this comment.
I had it this way because it enabled me to link in order:
- functions and nodes
- Driver definition
- function modifiers
There was a problem hiding this comment.
Don't think ordered linking is important -- we want to order it by clear attainable value IMO
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Significant changes to README sections. Feel free to discuss things that should be:
Changes
How I tested this
Notes
Checklist