Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates telephone example #145

Merged
merged 1 commit into from
Apr 9, 2024
Merged

Updates telephone example #145

merged 1 commit into from
Apr 9, 2024

Conversation

skrawcz
Copy link
Contributor

@skrawcz skrawcz commented Apr 7, 2024

To make it a top-level example.

Simplifies it a little and splits out the two implementations to make the code simpler to look at.

Adds an example hook to save images locally.

Changes

  • examples folder for image-telephone

How I tested this

  • locally

Notes

  • we can have the blog post link to the simple example here too.

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

@skrawcz skrawcz force-pushed the update_telephone_example branch from 3337df8 to e7541ce Compare April 7, 2024 22:49
@skrawcz skrawcz requested a review from elijahbenizzy April 7, 2024 22:49
Copy link
Contributor

@elijahbenizzy elijahbenizzy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, two points:

  1. We should make it more clear why we're showing this example (the other examples are (a) something they'll want to do or (b) something they'll recognize, this is something that is just for fun, but teaches something interesting
  2. We should clarify when we use the Hamilton integration and when we don't, two different paths is going to confuse people.

examples/image-telephone/README.md Outdated Show resolved Hide resolved
examples/image-telephone/application.py Show resolved Hide resolved
examples/image-telephone/application.py Show resolved Hide resolved
examples/image-telephone/application.py Outdated Show resolved Hide resolved
@skrawcz skrawcz force-pushed the update_telephone_example branch 3 times, most recently from 76279ad to c4de7a4 Compare April 9, 2024 06:04
To make it a top-level example.

Simplifies it a little and splits out the two implementations
to make the code simpler to look at.

Adds integrations to be skipped for validation for now.
Proper fix would be to mark directories as example ones
and only validate those...

Adds an example hook to save images locally.
@skrawcz skrawcz force-pushed the update_telephone_example branch from c4de7a4 to 7d528ef Compare April 9, 2024 06:15
@skrawcz skrawcz merged commit db457a4 into main Apr 9, 2024
7 checks passed
@skrawcz skrawcz deleted the update_telephone_example branch April 9, 2024 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants