Skip to content

Explicitly document that skip relaxations are counted separately but the metrics reflect the relaxed counts #279

Description

@DragaDoncila

Description

We decided that when computing metrics for relaxed skip edges, we annotate the counts separately, but summary metrics e.g. precision or recall use the most relaxed count available. We need to make sure we explicitly document this:

  • in each metric description
  • in the skip edges section
  • in the metric API docstrings

Topics

  • Documentation update

  • Track Errors

  • Metrics

Priority

  • This is an essential feature
  • Nice to have
  • Future idea

Are you interested in contributing?

  • Yes! 🎉
  • No 🙁

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    📝 documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions