unify retrieval names (#755)

* unify retrieval module's names between func and class * base Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Lightning-AI · Jan 14, 2022 · 7595120 · 7595120
1 parent 32d3cc8
commit 7595120
Show file tree

Hide file tree

Showing 18 changed files with 25 additions and 25 deletions.
diff --git a/tests/retrieval/test_fallout.py b/tests/retrieval/test_fallout.py
@@ -29,7 +29,7 @@
  _errors_test_functional_metric_parameters_k,
 )
 from torchmetrics.functional.retrieval.fall_out import retrieval_fall_out
-from torchmetrics.retrieval.retrieval_fallout import RetrievalFallOut
+from torchmetrics.retrieval.fall_out import RetrievalFallOut
 
 seed_all(42)
 

diff --git a/tests/retrieval/test_hit_rate.py b/tests/retrieval/test_hit_rate.py
@@ -29,7 +29,7 @@
  _errors_test_functional_metric_parameters_k,
 )
 from torchmetrics.functional.retrieval.hit_rate import retrieval_hit_rate
-from torchmetrics.retrieval.retrieval_hit_rate import RetrievalHitRate
+from torchmetrics.retrieval.hit_rate import RetrievalHitRate
 
 seed_all(42)
 

diff --git a/tests/retrieval/test_map.py b/tests/retrieval/test_map.py
@@ -27,7 +27,7 @@
  _errors_test_functional_metric_parameters_default,
 )
 from torchmetrics.functional.retrieval.average_precision import retrieval_average_precision
-from torchmetrics.retrieval.mean_average_precision import RetrievalMAP
+from torchmetrics.retrieval.average_precision import RetrievalMAP
 
 seed_all(42)
 

diff --git a/tests/retrieval/test_mrr.py b/tests/retrieval/test_mrr.py
@@ -28,7 +28,7 @@
  _errors_test_functional_metric_parameters_default,
 )
 from torchmetrics.functional.retrieval.reciprocal_rank import retrieval_reciprocal_rank
-from torchmetrics.retrieval.mean_reciprocal_rank import RetrievalMRR
+from torchmetrics.retrieval.reciprocal_rank import RetrievalMRR
 
 seed_all(42)
 

diff --git a/tests/retrieval/test_ndcg.py b/tests/retrieval/test_ndcg.py
@@ -29,7 +29,7 @@
  _errors_test_functional_metric_parameters_with_nonbinary,
 )
 from torchmetrics.functional.retrieval.ndcg import retrieval_normalized_dcg
-from torchmetrics.retrieval.retrieval_ndcg import RetrievalNormalizedDCG
+from torchmetrics.retrieval.ndcg import RetrievalNormalizedDCG
 
 seed_all(42)
 

diff --git a/tests/retrieval/test_precision.py b/tests/retrieval/test_precision.py
@@ -29,7 +29,7 @@
  _errors_test_functional_metric_parameters_k,
 )
 from torchmetrics.functional.retrieval.precision import retrieval_precision
-from torchmetrics.retrieval.retrieval_precision import RetrievalPrecision
+from torchmetrics.retrieval.precision import RetrievalPrecision
 
 seed_all(42)
 

diff --git a/tests/retrieval/test_r_precision.py b/tests/retrieval/test_r_precision.py
@@ -27,7 +27,7 @@
  _errors_test_functional_metric_parameters_default,
 )
 from torchmetrics.functional.retrieval.r_precision import retrieval_r_precision
-from torchmetrics.retrieval.retrieval_r_precision import RetrievalRPrecision
+from torchmetrics.retrieval.r_precision import RetrievalRPrecision
 
 seed_all(42)
 

diff --git a/tests/retrieval/test_recall.py b/tests/retrieval/test_recall.py
@@ -29,7 +29,7 @@
  _errors_test_functional_metric_parameters_k,
 )
 from torchmetrics.functional.retrieval.recall import retrieval_recall
-from torchmetrics.retrieval.retrieval_recall import RetrievalRecall
+from torchmetrics.retrieval.recall import RetrievalRecall
 
 seed_all(42)
 

diff --git a/torchmetrics/retrieval/__init__.py b/torchmetrics/retrieval/__init__.py
@@ -11,12 +11,12 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from torchmetrics.retrieval.mean_average_precision import RetrievalMAP # noqa: F401
-from torchmetrics.retrieval.mean_reciprocal_rank import RetrievalMRR # noqa: F401
-from torchmetrics.retrieval.retrieval_fallout import RetrievalFallOut # noqa: F401
-from torchmetrics.retrieval.retrieval_hit_rate import RetrievalHitRate # noqa: F401
-from torchmetrics.retrieval.retrieval_metric import RetrievalMetric # noqa: F401
-from torchmetrics.retrieval.retrieval_ndcg import RetrievalNormalizedDCG # noqa: F401
-from torchmetrics.retrieval.retrieval_precision import RetrievalPrecision # noqa: F401
-from torchmetrics.retrieval.retrieval_r_precision import RetrievalRPrecision # noqa: F401
-from torchmetrics.retrieval.retrieval_recall import RetrievalRecall # noqa: F401
+from torchmetrics.retrieval.average_precision import RetrievalMAP # noqa: F401
+from torchmetrics.retrieval.base import RetrievalMetric # noqa: F401
+from torchmetrics.retrieval.fall_out import RetrievalFallOut # noqa: F401
+from torchmetrics.retrieval.hit_rate import RetrievalHitRate # noqa: F401
+from torchmetrics.retrieval.ndcg import RetrievalNormalizedDCG # noqa: F401
+from torchmetrics.retrieval.precision import RetrievalPrecision # noqa: F401
+from torchmetrics.retrieval.r_precision import RetrievalRPrecision # noqa: F401
+from torchmetrics.retrieval.recall import RetrievalRecall # noqa: F401
+from torchmetrics.retrieval.reciprocal_rank import RetrievalMRR # noqa: F401
diff --git a/...trics/retrieval/mean_average_precision.py → torchmetrics/retrieval/average_precision.py b/...trics/retrieval/mean_average_precision.py → torchmetrics/retrieval/average_precision.py
@@ -14,7 +14,7 @@
 from torch import Tensor, tensor
 
 from torchmetrics.functional.retrieval.average_precision import retrieval_average_precision
-from torchmetrics.retrieval.retrieval_metric import RetrievalMetric
+from torchmetrics.retrieval.base import RetrievalMetric
 
 
 class RetrievalMAP(RetrievalMetric):

diff --git a/torchmetrics/retrieval/retrieval_metric.py → torchmetrics/retrieval/base.py b/torchmetrics/retrieval/retrieval_metric.py → torchmetrics/retrieval/base.py
diff --git a/torchmetrics/retrieval/retrieval_fallout.py → torchmetrics/retrieval/fall_out.py b/torchmetrics/retrieval/retrieval_fallout.py → torchmetrics/retrieval/fall_out.py
@@ -17,7 +17,7 @@
 from torch import Tensor, tensor
 
 from torchmetrics.functional.retrieval.fall_out import retrieval_fall_out
-from torchmetrics.retrieval.retrieval_metric import RetrievalMetric
+from torchmetrics.retrieval.base import RetrievalMetric
 from torchmetrics.utilities.data import get_group_indexes
 
 

diff --git a/torchmetrics/retrieval/retrieval_hit_rate.py → torchmetrics/retrieval/hit_rate.py b/torchmetrics/retrieval/retrieval_hit_rate.py → torchmetrics/retrieval/hit_rate.py
@@ -16,7 +16,7 @@
 from torch import Tensor, tensor
 
 from torchmetrics.functional.retrieval.hit_rate import retrieval_hit_rate
-from torchmetrics.retrieval.retrieval_metric import RetrievalMetric
+from torchmetrics.retrieval.base import RetrievalMetric
 
 
 class RetrievalHitRate(RetrievalMetric):

diff --git a/torchmetrics/retrieval/retrieval_ndcg.py → torchmetrics/retrieval/ndcg.py b/torchmetrics/retrieval/retrieval_ndcg.py → torchmetrics/retrieval/ndcg.py
@@ -16,7 +16,7 @@
 from torch import Tensor, tensor
 
 from torchmetrics.functional.retrieval.ndcg import retrieval_normalized_dcg
-from torchmetrics.retrieval.retrieval_metric import RetrievalMetric
+from torchmetrics.retrieval.base import RetrievalMetric
 
 
 class RetrievalNormalizedDCG(RetrievalMetric):

diff --git a/...hmetrics/retrieval/retrieval_precision.py → torchmetrics/retrieval/precision.py b/...hmetrics/retrieval/retrieval_precision.py → torchmetrics/retrieval/precision.py
@@ -16,7 +16,7 @@
 from torch import Tensor, tensor
 
 from torchmetrics.functional.retrieval.precision import retrieval_precision
-from torchmetrics.retrieval.retrieval_metric import RetrievalMetric
+from torchmetrics.retrieval.base import RetrievalMetric
 
 
 class RetrievalPrecision(RetrievalMetric):

diff --git a/...etrics/retrieval/retrieval_r_precision.py → torchmetrics/retrieval/r_precision.py b/...etrics/retrieval/retrieval_r_precision.py → torchmetrics/retrieval/r_precision.py
@@ -14,7 +14,7 @@
 from torch import Tensor, tensor
 
 from torchmetrics.functional.retrieval.r_precision import retrieval_r_precision
-from torchmetrics.retrieval.retrieval_metric import RetrievalMetric
+from torchmetrics.retrieval.base import RetrievalMetric
 
 
 class RetrievalRPrecision(RetrievalMetric):

diff --git a/torchmetrics/retrieval/retrieval_recall.py → torchmetrics/retrieval/recall.py b/torchmetrics/retrieval/retrieval_recall.py → torchmetrics/retrieval/recall.py
@@ -16,7 +16,7 @@
 from torch import Tensor, tensor
 
 from torchmetrics.functional.retrieval.recall import retrieval_recall
-from torchmetrics.retrieval.retrieval_metric import RetrievalMetric
+from torchmetrics.retrieval.base import RetrievalMetric
 
 
 class RetrievalRecall(RetrievalMetric):

diff --git a/...metrics/retrieval/mean_reciprocal_rank.py → torchmetrics/retrieval/reciprocal_rank.py b/...metrics/retrieval/mean_reciprocal_rank.py → torchmetrics/retrieval/reciprocal_rank.py
@@ -14,7 +14,7 @@
 from torch import Tensor, tensor
 
 from torchmetrics.functional.retrieval.reciprocal_rank import retrieval_reciprocal_rank
-from torchmetrics.retrieval.retrieval_metric import RetrievalMetric
+from torchmetrics.retrieval.base import RetrievalMetric
 
 
 class RetrievalMRR(RetrievalMetric):