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.

Sign up for GitHub

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

Jump to bottom

document signal detector functions in the knowledgebase #199

Open
zachll opened this issue Jan 26, 2024 · 2 comments
Open

document signal detector functions in the knowledgebase #199

zachll opened this issue Jan 26, 2024 · 2 comments
Assignees
@mackgalante
Labels
documentation Improvements or additions to documentation

Comments

@zachll
Copy link
Member

zachll commented Jan 26, 2024 •
edited
Loading

Problem: The PFKB does not specify any details about signal detector functions that are used in the pipeline

Proposed solution:

  • create a top-level motivating information detectors folder in the PFKB
  • create a readme file for each detector group
  • for trends, describe concepts that are consistent with PSDO definitions
  • Add details about monotonicity, duration, and positive/negative trend values for the team to review
  • Describe annotations as they are currently implemented, and include links to code in the PFP repo
  • Consider adding existing description for related vignettes
@zachll
Copy link
Member Author

zachll commented Mar 6, 2024

Documentation in PFKB can follow work in #313 in the pipeline repository:https://github.com/orgs/Display-Lab/projects/5/views/1?pane=issue&itemId=55279476

@zachll zachll changed the title document trend-related annotations in the knowledgebase document trend signal detector function in the knowledgebase Mar 6, 2024
@faridseifi faridseifi added the documentation Improvements or additions to documentation label Apr 5, 2024
@faridseifi
Copy link
Contributor

Peter will take a first pass at documenting the Achievement and Loss detectors.

@faridseifi faridseifi changed the title document trend signal detector function in the knowledgebase document signal detector functions in the knowledgebase Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mackgalante mackgalante

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@zachll @faridseifi @mackgalante