hamilton icon indicating copy to clipboard operation
hamilton copied to clipboard

[good first issue - beginner] Ensure all examples have a jupyter notebook to present the example

Open skrawcz opened this issue 1 year ago • 18 comments

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

  1. Claim an example.
  2. 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

skrawcz avatar Aug 01 '23 05:08 skrawcz

Hi! Is anyone working on this? Can I claim the numpy and scikit-learn portions of this task?

AnupJoseph avatar Aug 04 '23 04:08 AnupJoseph

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.

skrawcz avatar Aug 04 '23 05:08 skrawcz

@AnupJoseph thanks for those two! Let me know if you want to claim more, or if you want something a little "harder".

skrawcz avatar Aug 12 '23 06:08 skrawcz

@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

AnupJoseph avatar Aug 14 '23 03:08 AnupJoseph

Hi @skrawcz. I would like to claim caching_nodes and lineage examples if no one is working on those.

alti-tude avatar Aug 17 '23 09:08 alti-tude

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.

skrawcz avatar Aug 17 '23 21:08 skrawcz

I'm open to taking any of the below. Thanks!

  • polars
  • dask
  • dbt
  • airflow
  • spark

bryangalindo avatar Sep 07 '23 16:09 bryangalindo

@bryangalindo let me give you polars.

skrawcz avatar Sep 08 '23 04:09 skrawcz

@alti-tude any updates on your end? Need any help?

skrawcz avatar Sep 08 '23 04:09 skrawcz

@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.

bryangalindo avatar Sep 08 '23 23:09 bryangalindo

@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 avatar Sep 09 '23 17:09 skrawcz

@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!

bryangalindo avatar Sep 09 '23 18:09 bryangalindo

@skrawcz I can take the feature_engineering_multiple_contexts

benhhack avatar Sep 12 '23 09:09 benhhack

@skrawcz i can take the ray example

bryangalindo avatar Sep 18 '23 23:09 bryangalindo

@skrawcz can I take prefect?

flaviassantos avatar Sep 29 '23 19:09 flaviassantos

@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

flaviassantos avatar Oct 04 '23 18:10 flaviassantos

@skrawcz can I take the data_loaders?

eoagyen avatar Sep 04 '24 16:09 eoagyen

@skrawcz can I take the data_loaders?

Sure! Please comment on #1122 and I can assign it that way.

skrawcz avatar Sep 04 '24 17:09 skrawcz