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

Adding documentation for new metrics #368

Merged
merged 9 commits into from
Jul 4, 2023
Merged

Adding documentation for new metrics #368

merged 9 commits into from
Jul 4, 2023

Conversation

denproc
Copy link
Collaborator

@denproc denproc commented Jun 30, 2023

Closes #366

Proposed Changes

  • Added DSS to Functions and Modules
  • Added SR-SIM to Functions and Modules
  • Added CLIP-IQA to Modules and Readme
  • Removed old documentation deployment pipeline cd-documentation.yml

Final results can be inspected here.

@codecov
Copy link

codecov bot commented Jun 30, 2023

Codecov Report

Merging #368 (794630c) into master (c26ce7c) will increase coverage by 0.06%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #368      +/-   ##
==========================================
+ Coverage   90.63%   90.70%   +0.06%     
==========================================
  Files          36       36              
  Lines        2871     2871              
==========================================
+ Hits         2602     2604       +2     
+ Misses        269      267       -2     
Flag Coverage Δ
unittests 90.70% <100.00%> (+0.06%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
piq/clip_iqa.py 100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

@denproc denproc requested review from snk4tr and zakajd and removed request for snk4tr June 30, 2023 15:47
snk4tr
snk4tr previously approved these changes Jul 1, 2023
Copy link
Contributor

@snk4tr snk4tr left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!
One tiny thing that I noticed while reading resulting docs: CLIP-IQA actually expects only 4D tensors as discussed in #348, while the docstring here says that 3D tensors are also allowed. Could you fix that please?
LGTM otherwise, let's merge!

@sonarcloud
Copy link

sonarcloud bot commented Jul 1, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@denproc denproc requested a review from snk4tr July 1, 2023 16:56
@denproc denproc merged commit 81ac1e0 into master Jul 4, 2023
8 checks passed
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.

Update documentation to include all available metrics and measures.
2 participants