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 information about metrics #318

Open
snk4tr opened this issue Jun 8, 2022 · 0 comments
Open

Add information about metrics #318

snk4tr opened this issue Jun 8, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@snk4tr
Copy link
Contributor

snk4tr commented Jun 8, 2022

Is your feature request related to a problem? Please describe.
All metrics have important characteristics such as:

  • Possible input values (e.g. [0, 1] or [1, 255])
  • Outputs range (e.g [-1, 1] or [0, +inf])
  • Symmetry:f(x, y) = f(y, x)
  • Additional information that we gained while working with the library (e.g. VSI has an actual dynamic range of [0.95, 1.0] instead of [0, 1]

Currently, no such information is added to the existing metrics.

Describe the solution you'd like

  1. Add the required information in notes section of docstrings of all metrics in the library.
  2. Move the notes section up in the readthedocs documentation so it is more visible to a user.

Additional context
Related and partially triggered by discussions on #315

@snk4tr snk4tr added the documentation Improvements or additions to documentation label Jun 8, 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

3 participants