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

Prepare RTDIP demo #43

Closed
luccalb opened this issue Nov 13, 2024 · 6 comments
Closed

Prepare RTDIP demo #43

luccalb opened this issue Nov 13, 2024 · 6 comments
Assignees

Comments

@luccalb
Copy link

luccalb commented Nov 13, 2024

User Story

  1. As an AMOS PO
  2. I want to demo our RTDIP components in a visually appealing way
  3. So that people who are unfamiliar with the project get an idea of what it does

Additional context

  • We (the POs) will have to demo the project on "mid-project review" (27.11.2024) and on AMOS demo day (05.02.2025)
  • One way to make the demo visually appealing could be to plot some data before and after transformation by our components in a Jupyter notebook

Acceptance Criteria

  • There exists a demo folder in the repository
  • The repository contains a script/jupyter notebook that can be executed
  • In the demo the RTDIP library is imported, the same way a real RTDIP engineer would do it
  • The data source is free of choice (doesn't have to be Shells data) but should be directly available, either checked into the repository or through a private link
  • During the demo plots are shown, not only logs or dataframes are printed out, to make it visually appealing and easier to understand for project outsiders
  • Make it as easy as possible for a non-technical PO, ideally just "one click"

Definition of Done

  • Test cases have been created and are running successfully
  • Documentation for the new component was added
  • Github Actions are running without errors
@luccalb luccalb converted this from a draft issue Nov 13, 2024
@luccalb luccalb changed the title Visually appealing way to demo RTDIP Prepare RTDIP demo Nov 13, 2024
@Timm638
Copy link

Timm638 commented Nov 13, 2024

@sanalmert @luccalb
What software are you using to view Phython Notebooks?

@luccalb
Copy link
Author

luccalb commented Nov 13, 2024 via email

@Timm638 Timm638 self-assigned this Nov 13, 2024
@Timm638 Timm638 linked a pull request Nov 18, 2024 that will close this issue
@Timm638
Copy link

Timm638 commented Nov 19, 2024

@luccalb @sanalmert
I've drafted up the plots for all components and put it into the notebook located in the respective branch.
Are the plots okay for the upcoming demo? Or should I change something?

@luccalb
Copy link
Author

luccalb commented Nov 22, 2024

@Timm638 @chris-1187 Could you add the ARIMA, and data imputation to the demo as well? I think they are our most "impressive" components.

@Timm638
Copy link

Timm638 commented Nov 25, 2024

I finished adding both showcases to the demo.

@luccalb luccalb moved this from In Progress to Awaiting Review in amos2024ws01-feature-board Nov 25, 2024
@luccalb
Copy link
Author

luccalb commented Nov 25, 2024

@FelipeTrost I think linear regression is the only component missing in the demo now. It's not a must, but would definitely be cool to show :)

@luccalb luccalb moved this from In Progress to Awaiting Review in amos2024ws01-feature-board Nov 27, 2024
@sanalmert sanalmert moved this from Awaiting Review to Product Backlog in amos2024ws01-feature-board Nov 27, 2024
@sanalmert sanalmert moved this from Product Backlog to Awaiting Review in amos2024ws01-feature-board Nov 27, 2024
@github-project-automation github-project-automation bot moved this from Awaiting Review to Feature Archive in amos2024ws01-feature-board Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Feature Archive
Development

Successfully merging a pull request may close this issue.

3 participants