hamilton
hamilton copied to clipboard
[good first issue - beginner] Ensure all examples have a jupyter notebook to present the example
Is your feature request related to a problem? Please describe. A lot of DS want a notebook to get started with, not a python script -- these can be too intimidating.
Describe the solution you'd like We should make sure our examples all have a jupyter notebook to mirror the "run.py" file. That way people can see how things are exercised and then they can use a notebook to try things out.
E.g. we want each example to have a notebook kind of like the hello world example.
Extra instructions
- Claim an example.
- Some example might not be applicable for a notebook -- if so we should just note it and move on.
Examples to check off from the /examples folder
- [ ] airflow
- [ ] async
- [x] caching_nodes (claimed @alti-tude)
- [x] dask (claimed @bryangalindo )
- [ ] #1122 (@eoagyen )
- [ ] data_quality
- [ ] dbt
- [ ] feature_engineering_multiple_contexts (claimed @benhhack )
- [x] hello_world
- [x] lineage
- [ ] LLM_Workflows
- [ ] model_examples
- [x] numpy (claimed @AnupJoseph )
- [x] polars (claimed @bryangalindo )
- [x] prefect (claimed @flaviassantos )
- [ ] ray
- [ ] reusing_functions
- [x] scikit-learn (claimed @AnupJoseph )
- [ ] spark
Hi! Is anyone working on this? Can I claim the numpy and scikit-learn portions of this task?
Hi! Is anyone working on this? Can I claim the numpy and scikit-learn portions of this task?
Sure. I'll assign your name to them.
@AnupJoseph thanks for those two! Let me know if you want to claim more, or if you want something a little "harder".
@AnupJoseph thanks for those two! Let me know if you want to claim more, or if you want something a little "harder".
Welcome! I'll take up some of the other examples as I get the time
Hi @skrawcz. I would like to claim caching_nodes
and lineage
examples if no one is working on those.
I would like to claim caching_nodes and lineage examples if no one is working on those.
Yep -- actually it seems like lineage
is already done (my bad). But caching_nodes
isn't. So will add you to caching_nodes
and feel free to pick another one.
I'm open to taking any of the below. Thanks!
- polars
- dask
- dbt
- airflow
- spark
@bryangalindo let me give you polars.
@alti-tude any updates on your end? Need any help?
@skrawcz I'm working on the Dask example instead since the Polars example doesn't have a run.py module (unless I missed it or someone is hiding it in a shelf 😄). I confirmed a run.py module exists in examples/dask/hello_world.
@skrawcz I'm working on the Dask example instead since the Polars example doesn't have a run.py module (unless I missed it or someone is hiding it in a shelf 😄). I confirmed a run.py module exists in examples/dask/hello_world.
Ah yeah -- it might be called my_script.py
. Just a naming difference. If you look at the code it should look fairly similar. No worries.
@skrawcz I'm working on the Dask example instead since the Polars example doesn't have a run.py module (unless I missed it or someone is hiding it in a shelf 😄). I confirmed a run.py module exists in examples/dask/hello_world.
Ah yeah -- it might be called
my_script.py
. Just a naming difference. If you look at the code it should look fairly similar. No worries.
Ah thanks for pointing that out. I can continue working on the Polars example. Thanks @skrawcz!
@skrawcz I can take the feature_engineering_multiple_contexts
@skrawcz i can take the ray example
@skrawcz can I take prefect?
@skrawcz can I take model_examples and LLM_workflows? I am going through the code anyway, I might as well fix a notebook for them :) thanks
@skrawcz can I take the data_loaders?
@skrawcz can I take the data_loaders?
Sure! Please comment on #1122 and I can assign it that way.