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

improve documentation #912

Merged
merged 2 commits into from
Oct 16, 2021
Merged

improve documentation #912

merged 2 commits into from
Oct 16, 2021

Conversation

slhck
Copy link
Contributor

@slhck slhck commented Oct 15, 2021

  • Create an index page for all documentation pages
  • Clean up README.md to reference documentation overview, from where people can find all docs
  • Harmonize Markdown headings in all individual pages
  • Add dedicated page for core metrics
  • Add NEG to model page
  • Harmonize naming of Markdown documents
  • Move PDFs to separate directories
  • Fix a few spelling errors, broken HTTP(S) links etc.

This somewhat fixes #125

Comment on lines +17 to +21
### ADM

ADM was previously named Detail Loss Metric (DLM), described in S. Li, F. Zhang, L. Ma, and K. Ngan, “Image Quality Assessment by Separately Evaluating Detail Losses and Additive Impairments,” IEEE Transactions on Multimedia, vol. 13, no. 5, pp. 935–949, Oct. 2011.

DLM is an image quality metric based on the rationale of separately measuring the loss of details which affects the content visibility, and the redundant impairment which distracts viewer attention. The original metric combines both DLM and additive impairment measure (AIM) to yield a final score. In VMAF, only the DLM part is added as an elementary metric. Particular care was taken for special cases, such as black frames, where numerical calculations for the original formulation break down.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't too sure about this one, and I'm missing some details here (no pun intended). Please add accordingly.

PS: I took the liberty of quoting from the blog post here. If this is an issue, I can rephrase.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:)

This is actually pretty accurate. Thanks for the great effort. I'll take a detailed look and the rest of the modifications.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well it's a verbatim copy from the Netflix blog post. Hence my PS — but if it's fine for you, it's fine for me!

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does ADM stand for?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ADM was a historical name for DLM and AIM combined.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So ADM = AIM DLM metric?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

We probably should clean up the codebase to avoid the confusion. Added this to my todo list.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess a better description in the documentation would be enough. If you change the name of the metric it might cause problems or confusion down the road, since people will already be used to it, and there might be scripts parsing the name of the indicator etc.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair point. Let me think about this further.

- Create an index page for all documentation pages
- Clean up README.md to reference documentation overview, from where people can find all docs
- Harmonize Markdown headings in all individual pages
- Add dedicated page for core metrics
- Add NEG to model page
- Harmonize naming of Markdown documents
- Move PDFs to separate directories
- Fix a few spelling errors, broken HTTP(S) links etc.
@slhck slhck force-pushed the improve-documentation branch from 82d2285 to 609aa8e Compare October 15, 2021 12:21
@li-zhi li-zhi merged commit 400fe79 into Netflix:master Oct 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Link to references describing elementary metrics
3 participants