photosynthesis-team / piq

Measures and metrics for image2image tasks. PyTorch.
Apache License 2.0
1.32k stars 114 forks source link

Add information about metrics #318

Open snk4tr opened 2 years ago

snk4tr commented 2 years ago

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

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