Repository: testingautomated-usi/uncertainty-wizard

Issue:
Alias `VariationRatio` is missing
the VariationRatio quantifier misses the corresponding class-name alias, which should be there, according to the docs:

https://uncertainty-wizard.readthedocs.io/en/latest/user_guide_quantifiers.html

Discussion:
codecov[bot]: # [Codecov](https://codecov.io/gh/testingautomated-usi/uncertainty-wizard/pull/152?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi) Report
Base: **94.70**% // Head: **94.70**% // No change to project coverage :thumbsup:
> Coverage data is based on head [(`26ace22`)](https://codecov.io/gh/testingautomated-usi/uncertainty-wizard/pull/152?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi) compared to base [(`d1b0326`)](https://codecov.io/gh/testingautomated-usi/uncertainty-wizard/commit/d1b0326f0dd608edeb7601e0aa38dd9e73ef325d?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi).
> Patch coverage: 100.00% of modified lines in pull request are covered.

> :exclamation: Current head 26ace22 differs from pull request most recent head 479436f. Consider uploading reports for the commit 479436f to get more accurate results

<details><summary>Additional details and impacted files</summary>


```diff
@@           Coverage Diff           @@
##             main     #152   +/-   ##
=======================================
  Coverage   94.70%   94.70%           
=======================================
  Files          27       27           
  Lines         925      925           
=======================================
  Hits          876      876           
  Misses         49       49           
```


| [Impacted Files](https://codecov.io/gh/testingautomated-usi/uncertainty-wizard/pull/152?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi) | Coverage Δ | |
|---|---|---|
| [uncertainty\_wizard/quantifiers/mean\_softmax.py](https://codecov.io/gh/testingautomated-usi/uncertainty-wizard/pull/152?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi#diff-dW5jZXJ0YWludHlfd2l6YXJkL3F1YW50aWZpZXJzL21lYW5fc29mdG1heC5weQ==) | `100.00% <100.00%> (ø)` | |
| [...certainty\_wizard/quantifiers/mutual\_information.py](https://codecov.io/gh/testingautomated-usi/uncertainty-wizard/pull/152?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi#diff-dW5jZXJ0YWludHlfd2l6YXJkL3F1YW50aWZpZXJzL211dHVhbF9pbmZvcm1hdGlvbi5weQ==) | `100.00% <100.00%> (ø)` | |
| [...certainty\_wizard/quantifiers/predictive\_entropy.py](https://codecov.io/gh/testingautomated-usi/uncertainty-wizard/pull/152?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi#diff-dW5jZXJ0YWludHlfd2l6YXJkL3F1YW50aWZpZXJzL3ByZWRpY3RpdmVfZW50cm9weS5weQ==) | `100.00% <100.00%> (ø)` | |
| [uncertainty\_wizard/quantifiers/variation\_ratio.py](https://codecov.io/gh/testingautomated-usi/uncertainty-wizard/pull/152?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi#diff-dW5jZXJ0YWludHlfd2l6YXJkL3F1YW50aWZpZXJzL3ZhcmlhdGlvbl9yYXRpby5weQ==) | `100.00% <100.00%> (ø)` | |

Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi)

</details>

[:umbrella: View full report at Codecov](https://codecov.io/gh/testingautomated-usi/uncertainty-wizard/pull/152?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi).   
:loudspeaker: Do you have feedback about the report comment? [Let us know in this issue](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=testingautomated-usi).


Patch:
diff --git a/uncertainty_wizard/quantifiers/mean_softmax.py b/uncertainty_wizard/quantifiers/mean_softmax.py
index 6c32df0..d8f01f6 100644
--- a/uncertainty_wizard/quantifiers/mean_softmax.py
+++ b/uncertainty_wizard/quantifiers/mean_softmax.py
@@ -17,7 +17,7 @@ class MeanSoftmax(ConfidenceQuantifier):
     # docstr-coverage:inherited
     @classmethod
     def aliases(cls) -> List[str]:
-        return ["mean_softmax", "ensembling", "ms"]
+        return ["mean_softmax", "ensembling", "ms", "MeanSoftmax"]
 
     # docstr-coverage:inherited
     @classmethod
diff --git a/uncertainty_wizard/quantifiers/mutual_information.py b/uncertainty_wizard/quantifiers/mutual_information.py
index adfe725..5a0bc11 100644
--- a/uncertainty_wizard/quantifiers/mutual_information.py
+++ b/uncertainty_wizard/quantifiers/mutual_information.py
@@ -30,7 +30,7 @@ class MutualInformation(UncertaintyQuantifier):
     # docstr-coverage:inherited
     @classmethod
     def aliases(cls) -> List[str]:
-        return ["mutu_info", "mutual_information", "mi"]
+        return ["mutu_info", "mutual_information", "mi", "MutualInformation"]
 
     # docstr-coverage:inherited
     @classmethod
diff --git a/uncertainty_wizard/quantifiers/predictive_entropy.py b/uncertainty_wizard/quantifiers/predictive_entropy.py
index d29c39b..8a26a64 100644
--- a/uncertainty_wizard/quantifiers/predictive_entropy.py
+++ b/uncertainty_wizard/quantifiers/predictive_entropy.py
@@ -44,7 +44,7 @@ class PredictiveEntropy(UncertaintyQuantifier):
     # docstr-coverage:inherited
     @classmethod
     def aliases(cls) -> List[str]:
-        return ["predictive_entropy", "pred_entropy", "PE"]
+        return ["predictive_entropy", "pred_entropy", "PE", "PredictiveEntropy"]
 
     # docstr-coverage:inherited
     @classmethod
diff --git a/uncertainty_wizard/quantifiers/variation_ratio.py b/uncertainty_wizard/quantifiers/variation_ratio.py
index 6083373..aec4c46 100644
--- a/uncertainty_wizard/quantifiers/variation_ratio.py
+++ b/uncertainty_wizard/quantifiers/variation_ratio.py
@@ -30,7 +30,7 @@ class VariationRatio(UncertaintyQuantifier):
     # docstr-coverage:inherited
     @classmethod
     def aliases(cls) -> List[str]:
-        return ["variation_ratio", "vr", "var_ratio"]
+        return ["variation_ratio", "vr", "var_ratio", "VariationRatio"]
 
     # docstr-coverage:inherited
     @classmethod


Test patch:
diff --git a/tests_unit/quantifiers_tests/test_mean_softmax.py b/tests_unit/quantifiers_tests/test_mean_softmax.py
index 02f1cfd..0b03011 100644
--- a/tests_unit/quantifiers_tests/test_mean_softmax.py
+++ b/tests_unit/quantifiers_tests/test_mean_softmax.py
@@ -17,6 +17,8 @@ class TestMeanSoftmax(TestCase):
             isinstance(QuantifierRegistry.find("mean_softmax"), MeanSoftmax)
         )
         self.assertTrue(isinstance(QuantifierRegistry.find("ensembling"), MeanSoftmax))
+        self.assertTrue(isinstance(QuantifierRegistry.find("MS"), MeanSoftmax))
+        self.assertTrue(isinstance(QuantifierRegistry.find("MeanSoftmax"), MeanSoftmax))
 
     def test_is_confidence(self):
         self.assertTrue(MeanSoftmax.is_confidence())
diff --git a/tests_unit/quantifiers_tests/test_mutual_information.py b/tests_unit/quantifiers_tests/test_mutual_information.py
index 7eb2c11..fafc4dc 100644
--- a/tests_unit/quantifiers_tests/test_mutual_information.py
+++ b/tests_unit/quantifiers_tests/test_mutual_information.py
@@ -19,6 +19,10 @@ class TestMutualInformation(TestCase):
         self.assertTrue(
             isinstance(QuantifierRegistry.find("mutu_info"), MutualInformation)
         )
+        self.assertTrue(isinstance(QuantifierRegistry.find("MI"), MutualInformation))
+        self.assertTrue(
+            isinstance(QuantifierRegistry.find("MutualInformation"), MutualInformation)
+        )
 
     def test_is_confidence(self):
         self.assertFalse(MutualInformation.is_confidence())
diff --git a/tests_unit/quantifiers_tests/test_one_shot_classifiers.py b/tests_unit/quantifiers_tests/test_one_shot_classifiers.py
index 85bf274..1b2b6a2 100644
--- a/tests_unit/quantifiers_tests/test_one_shot_classifiers.py
+++ b/tests_unit/quantifiers_tests/test_one_shot_classifiers.py
@@ -63,6 +63,12 @@ class TestPCS(TestCase):
         self.assertTrue(
             isinstance(QuantifierRegistry.find("PCS"), PredictionConfidenceScore)
         )
+        self.assertTrue(
+            isinstance(
+                QuantifierRegistry.find("PredictionConfidenceScore"),
+                PredictionConfidenceScore,
+            )
+        )
         self.assertTrue(
             isinstance(
                 QuantifierRegistry.find("prediction_confidence_score"),
@@ -140,6 +146,7 @@ class TestSoftmax(TestCase):
     def test_string_representation(self):
         self.assertTrue(isinstance(QuantifierRegistry.find("softmax"), MaxSoftmax))
         self.assertTrue(isinstance(QuantifierRegistry.find("max_softmax"), MaxSoftmax))
+        self.assertTrue(isinstance(QuantifierRegistry.find("MaxSoftmax"), MaxSoftmax))
 
     def test_is_confidence(self):
         self.assertTrue(MaxSoftmax.is_confidence())
@@ -213,6 +220,7 @@ class TestSoftmaxEntropy(TestCase):
         self.assertTrue(
             isinstance(QuantifierRegistry.find("SoftmaxEntropy"), SoftmaxEntropy)
         )
+        self.assertTrue(isinstance(QuantifierRegistry.find("SE"), SoftmaxEntropy))
 
     def test_is_confidence(self):
         self.assertFalse(SoftmaxEntropy.is_confidence())
diff --git a/tests_unit/quantifiers_tests/test_predictive_entropy.py b/tests_unit/quantifiers_tests/test_predictive_entropy.py
index cebcf67..60be40f 100644
--- a/tests_unit/quantifiers_tests/test_predictive_entropy.py
+++ b/tests_unit/quantifiers_tests/test_predictive_entropy.py
@@ -19,6 +19,10 @@ class TestPredictiveEntropy(TestCase):
         self.assertTrue(
             isinstance(QuantifierRegistry.find("pred_entropy"), PredictiveEntropy)
         )
+        self.assertTrue(isinstance(QuantifierRegistry.find("PE"), PredictiveEntropy))
+        self.assertTrue(
+            isinstance(QuantifierRegistry.find("PredictiveEntropy"), PredictiveEntropy)
+        )
 
     def test_is_confidence(self):
         self.assertFalse(PredictiveEntropy.is_confidence())
diff --git a/tests_unit/quantifiers_tests/test_stddev.py b/tests_unit/quantifiers_tests/test_stddev.py
index df43465..dbbea1c 100644
--- a/tests_unit/quantifiers_tests/test_stddev.py
+++ b/tests_unit/quantifiers_tests/test_stddev.py
@@ -17,6 +17,9 @@ class TestStandardDeviation(TestCase):
             isinstance(QuantifierRegistry.find("standard_deviation"), StandardDeviation)
         )
         self.assertTrue(isinstance(QuantifierRegistry.find("std"), StandardDeviation))
+        self.assertTrue(
+            isinstance(QuantifierRegistry.find("StandardDeviation"), StandardDeviation)
+        )
         self.assertTrue(
             isinstance(QuantifierRegistry.find("stddev"), StandardDeviation)
         )
diff --git a/tests_unit/quantifiers_tests/test_variation_ratio.py b/tests_unit/quantifiers_tests/test_variation_ratio.py
index 8462857..a814631 100644
--- a/tests_unit/quantifiers_tests/test_variation_ratio.py
+++ b/tests_unit/quantifiers_tests/test_variation_ratio.py
@@ -20,6 +20,9 @@ class TestVariationRatio(TestCase):
             isinstance(QuantifierRegistry.find("var_ratio"), VariationRatio)
         )
         self.assertTrue(isinstance(QuantifierRegistry.find("VR"), VariationRatio))
+        self.assertTrue(
+            isinstance(QuantifierRegistry.find("VariationRatio"), VariationRatio)
+        )
 
     def test_is_confidence(self):
         self.assertFalse(VariationRatio.is_confidence())