From 72395f05c53ea93ddebadbc2433f278ea740592a Mon Sep 17 00:00:00 2001
From: Benjamin Sparks <b.sparks@alugha.com>
Date: Sun, 2 Feb 2025 21:51:04 +0100
Subject: [PATCH] python3Packages.torcheval: init at 0.0.7

---
 .../python-modules/torcheval/default.nix      | 113 ++++++++++++++++++
 pkgs/top-level/python-packages.nix            |   2 +
 2 files changed, 115 insertions(+)
 create mode 100644 pkgs/development/python-modules/torcheval/default.nix

diff --git a/pkgs/development/python-modules/torcheval/default.nix b/pkgs/development/python-modules/torcheval/default.nix
new file mode 100644
index 000000000000..0e696603fdae
--- /dev/null
+++ b/pkgs/development/python-modules/torcheval/default.nix
@@ -0,0 +1,113 @@
+{
+  lib,
+  buildPythonPackage,
+  fetchFromGitHub,
+
+  # build-system
+  setuptools,
+
+  # dependencies
+  typing-extensions,
+
+  # tests
+  cython,
+  numpy,
+  pytest-timeout,
+  pytest-xdist,
+  pytestCheckHook,
+  scikit-image,
+  scikit-learn,
+  torchtnt-nightly,
+  torchvision,
+}:
+let
+  pname = "torcheval";
+  version = "0.0.7";
+in
+buildPythonPackage {
+  inherit pname version;
+  pyproject = true;
+
+  src = fetchFromGitHub {
+    owner = "pytorch";
+    repo = "torcheval";
+    # Upstream has not created a tag for this version
+    # https://github.com/pytorch/torcheval/issues/215
+    rev = "f1bc22fc67ec2c77ee519aa4af8079f4fdaa41bb";
+    hash = "sha256-aVr4qKKE+dpBcJEi1qZJBljFLUl8d7D306Dy8uOojJE=";
+  };
+
+  # Patches are only applied to usages of numpy within tests,
+  # which are only used for testing purposes (see dev-requirements.txt)
+  postPatch =
+    # numpy's `np.NAN` was changed to `np.nan` when numpy 2 was released
+    ''
+      substituteInPlace tests/metrics/classification/test_accuracy.py tests/metrics/functional/classification/test_accuracy.py \
+        --replace-fail "np.NAN" "np.nan"
+    ''
+
+    # `unittest.TestCase.assertEquals` does not exist;
+    # the correct symbol is `unittest.TestCase.assertEqual`
+    + ''
+      substituteInPlace tests/metrics/test_synclib.py \
+        --replace-fail "tc.assertEquals" "tc.assertEqual"
+    '';
+
+  build-system = [ setuptools ];
+
+  dependencies = [ typing-extensions ];
+
+  pythonImportsCheck = [ "torcheval" ];
+
+  nativeCheckInputs = [
+    cython
+    numpy
+    pytest-timeout
+    pytest-xdist
+    pytestCheckHook
+    scikit-image
+    scikit-learn
+    torchtnt-nightly
+    torchvision
+  ];
+
+  pytestFlagsArray = [
+    "-v"
+    "tests/"
+
+    # -- tests/metrics/audio/test_fad.py --
+    # Touch filesystem and require network access.
+    # torchaudio.utils.download_asset("models/vggish.pt") -> PermissionError: [Errno 13] Permission denied: '/homeless-shelter'
+    "--deselect=tests/metrics/audio/test_fad.py::TestFAD::test_vggish_fad"
+    "--deselect=tests/metrics/audio/test_fad.py::TestFAD::test_vggish_fad_merge"
+
+    # -- tests/metrics/image/test_fid.py --
+    # Touch filesystem and require network access.
+    # models.inception_v3(weights=weights) -> PermissionError: [Errno 13] Permission denied: '/homeless-shelter'
+    "--deselect=tests/metrics/image/test_fid.py::TestFrechetInceptionDistance::test_fid_invalid_input"
+    "--deselect=tests/metrics/image/test_fid.py::TestFrechetInceptionDistance::test_fid_random_data_custom_model"
+    "--deselect=tests/metrics/image/test_fid.py::TestFrechetInceptionDistance::test_fid_random_data_default_model"
+    "--deselect=tests/metrics/image/test_fid.py::TestFrechetInceptionDistance::test_fid_with_dissimilar_inputs"
+    "--deselect=tests/metrics/image/test_fid.py::TestFrechetInceptionDistance::test_fid_with_similar_inputs"
+
+    # -- tests/metrics/functional/text/test_perplexity.py --
+    # AssertionError: Scalars are not close!
+    # Expected 3.537154912949 but got 3.53715443611145
+    "--deselect=tests/metrics/functional/text/test_perplexity.py::Perplexity::test_perplexity_with_ignore_index"
+
+    # -- tests/metrics/image/test_psnr.py --
+    # AssertionError: Scalars are not close!
+    # Expected 7.781850814819336 but got 7.781772613525391
+    "--deselect=tests/metrics/image/test_psnr.py::TestPeakSignalNoiseRatio::test_psnr_with_random_data"
+  ];
+
+  meta = {
+    description = "Rich collection of performant PyTorch model metrics and tools for PyTorch model evaluations";
+    homepage = "https://pytorch.org/torcheval";
+    changelog = "https://github.com/pytorch/torcheval/releases/tag/${version}";
+
+    platforms = lib.platforms.linux;
+    license = with lib.licenses; [ bsd3 ];
+    maintainers = with lib.maintainers; [ bengsparks ];
+  };
+}
diff --git a/pkgs/top-level/python-packages.nix b/pkgs/top-level/python-packages.nix
index ad9734cfcfd0..fbbbdab78daa 100644
--- a/pkgs/top-level/python-packages.nix
+++ b/pkgs/top-level/python-packages.nix
@@ -16514,6 +16514,8 @@ self: super: with self; {
 
   torchdiffeq = callPackage ../development/python-modules/torchdiffeq { };
 
+  torcheval = callPackage ../development/python-modules/torcheval { };
+
   torchmetrics = callPackage ../development/python-modules/torchmetrics { };
 
   torchio = callPackage ../development/python-modules/torchio { };