merge old commit and add to readme

nikopj · Jul 12, 2023 · e796692 · e796692
2 parents ffaecaa + e73665d
commit e796692
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,3 +3,8 @@
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://nikopj.github.io/SSIMLoss.jl/stable/)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://nikopj.github.io/SSIMLoss.jl/dev/)
 [![Build Status](https://github.com/nikopj/SSIMLoss.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/nikopj/SSIMLoss.jl/actions/workflows/CI.yml?query=branch%3Amain)
+
+A differentiable [Structural Similarity Index Measure](https://en.wikipedia.org/wiki/Structural_similarity) for neural
+network training. `SSIMLoss.ssim` is tested against
+[ImageQualityIndexes.jl](https://github.com/JuliaImages/ImageQualityIndexes.jl)
+for correctness.