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

Add examples and documentation for implementing new matchers and metrics #99

Open
msschwartz21 opened this issue Nov 1, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@msschwartz21
Copy link
Collaborator

msschwartz21 commented Nov 1, 2023

We had this listed in our project board from a while ago. Is this something that we would want to prioritize for the version 1 milestone?

@msschwartz21 msschwartz21 converted this from a draft issue Nov 1, 2023
@msschwartz21 msschwartz21 added the documentation Improvements or additions to documentation label Nov 1, 2023
@cmalinmayor
Copy link
Collaborator

Yes I think so! I'm adding it to the v1.0 milestone

@cmalinmayor cmalinmayor added this to the Version 1.0 milestone Nov 1, 2023
@cmalinmayor
Copy link
Collaborator

In the future, we want developers of new metrics to also add:

  • benchmarking
  • page in documentation for their metrics
  • tests with a variety of graphs (that we provide)

We should note this in the developer documentation, and perhaps in a PR template for new features

@msschwartz21
Copy link
Collaborator Author

Note: explain that other types of detections could be incorporated as long as the loader and matcher work together. Once the matching is established, downstream metrics shouldn't care about the type of detection.

@msschwartz21
Copy link
Collaborator Author

As discussed in #129, improve documentation of the intended meaning of missing flags.

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
Status: No status
Development

No branches or pull requests

2 participants