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

documentation(wfntp - Activity Index): write a report overview for the activity index metric #60

Open
8 tasks
cnstll opened this issue Sep 2, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@cnstll
Copy link
Contributor

cnstll commented Sep 2, 2022

User Story

As a dev,
I want to have a document on the activity index,
so that I can understand the calculation of the Activity index and have an overview of the metric distribution.

Acceptance Criteria

  • A report of the result about the activity Index obtain via several video is available in a file experiments/activity_index/report_overview/report_overview.md

Report Overview:

  • A section about the data: short description of the list of images (add a screenshot to have an idea of what kind of images we have)
  • A section about the methodology: remind the formular of the activity index, explaination of each measures, and how you plot the result (we used a script blablabla)
  • A section result: mostly graph and some global statistic. We should at least see a scatterplot with point being value of activity index, one color per source (all the point of the activity index of one video is one color).
  • all the output obtained via WF NTP

Definition of Done

  • Product Owner accepts the User Story
  • Acceptance criteria met
  • New data has been dvc push

Defined by CICD:

  • Code reviewed
  • black compliant
  • Unit tests passed
  • Functional tests passed
  • Non-Functional requirements met
@cnstll cnstll added the documentation Improvements or additions to documentation label Sep 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant