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

added Plotly materialization example #544

Merged
merged 2 commits into from
Nov 20, 2023
Merged

added Plotly materialization example #544

merged 2 commits into from
Nov 20, 2023

Conversation

zilto
Copy link
Collaborator

@zilto zilto commented Nov 19, 2023

Added a new example folder plotly with instructions on how to use the previously added materializers found in plotly_extensions . There are a few important practical tips to manage the size of generated HTML files.

Changes

Added a notebook to generate figures with the materializers and a README with notes.

How I tested this

Run the notebook end to end

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.

@zilto zilto requested a review from skrawcz November 19, 2023 21:09
Copy link
Contributor

sweep-ai bot commented Nov 19, 2023

Apply Sweep Rules to your PR?

  • Apply: All new business logic should have corresponding unit tests.
  • Apply: Refactor large functions to be more modular.
  • Apply: Add docstrings to all functions and file headers.

Copy link
Collaborator

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

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

the notebook output seems to indicate an error? did it work?

Otherwise code seems fine.

Fixes up the README and commits a clean notebook.
@skrawcz skrawcz merged commit 3f92861 into main Nov 20, 2023
@skrawcz skrawcz deleted the examples/plotly branch November 20, 2023 06:26
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