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

Adds image to spark example README #736

Merged
merged 1 commit into from
Mar 5, 2024
Merged

Conversation

skrawcz
Copy link
Collaborator

@skrawcz skrawcz commented Mar 5, 2024

To make it clearer what's going on when people
land in the directory.

Changes

  • readme for the example

How I tested this

  • locally

Notes

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.

Ellipsis 🚀 This PR description was created by Ellipsis for commit 93ba908.

Summary:

This PR enhances the documentation of the spark example in the Hamilton library by adding a visual representation of the dataflow process to the README file.

Key points:

  • Added an image to the README.md file in the examples/LLM_Workflows/scraping_and_chunking/spark directory.
  • The image provides a visual representation of the dataflow process that the example code will run.

Generated with ❤️ by ellipsis.dev

To make it clearer what's going on when people
land in the directory.
@skrawcz skrawcz merged commit 92650cf into main Mar 5, 2024
0 of 5 checks passed
@skrawcz skrawcz deleted the update_spark_example_readme branch March 5, 2024 07:46
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

❌ Changes requested.

  • Reviewed the entire pull request up to 93ba908
  • Looked at 17 lines of code in 1 files
  • Took 1 minute and 25 seconds to review
More info
  • Skipped 0 files when reviewing.
  • Skipped posting 0 additional comments because they didn't meet confidence threshold of 50%.

Workflow ID: wflow_AjYhfxYqhzdP0rom


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. We'll respond in a few minutes. Learn more here.

@@ -24,6 +24,11 @@ Otherwise:
python spark_pipeline.py
```

This is what it'll run:
![pipeline](pipeline.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

The image pipeline.png is referenced here, but it is not included in the PR. Please make sure to add it to the repository in the correct location.

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.

1 participant