nixpkgs/pkgs/development/python-modules/torchaudio/default.nix

{
  lib,
  stdenv,
  buildPythonPackage,
  fetchFromGitHub,

  # build-system
  setuptools,

  # dependencies
  torch,
  torchcodec,

  # tests
  expecttest,
  inflect,
  librosa,
  parameterized,
  pytestCheckHook,
  pytorch-lightning,
  requests,
  scipy,
  sentencepiece,
  soundfile,
  unidecode,

  # passthru
  torchaudio,

  cudaSupport ? torch.cudaSupport,
  cudaPackages,
  rocmSupport ? torch.rocmSupport,
}:

let
  inherit (stdenv) hostPlatform;
in
buildPythonPackage.override { inherit (torch) stdenv; } (finalAttrs: {
  pname = "torchaudio";
  version = "2.11.0";
  pyproject = true;

  src = fetchFromGitHub {
    owner = "pytorch";
    repo = "audio";
    tag = "v${finalAttrs.version}";
    hash = "sha256-TncROn9wfn5HOaIvupS2/KD9JCgwfHyfnbZRc+SiqJ0=";
  };

  env = {
    # CTC seems to be missing no matter what. No obvious flag to force its compilation.
    TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CTC_DECODER = 1;

    # CUDA
    USE_CUDA = cudaSupport;
    TORCH_CUDA_ARCH_LIST = "${lib.concatStringsSep ";" torch.cudaCapabilities}";
    TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CUCTC_DECODER = 1;
    TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CUDA = 1;
    TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_MULTIGPU_CUDA = 1;

    # ROCM
    USE_ROCM = rocmSupport;
    PYTORCH_ROCM_ARCH = lib.optionalString rocmSupport torch.gpuTargetString;
    ROCM_PATH = lib.optionalString rocmSupport torch.rocmtoolkit_joined;

    # demucs is not packaged in nixpkgs and is archived anyway
    TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_MOD_demucs = true;

    # fairseq is unmaintained and broken in nixpkgs
    TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_MOD_fairseq = true;

    # Fails even on python>3.10 with:
    #   RuntimeError: Test is known to fail for Python 3.10, disabling for now
    #   See: https://github.com/pytorch/audio/pull/2224#issuecomment-1048329450
    TORCHAUDIO_TEST_ALLOW_SKIP_IF_ON_PYTHON_310 = true;

    # Fails on aarch64-linux and darwin with:
    #   RuntimeError: `fbgemm` is not available
    # `fbgemm` is indeed an x86_64-linux-only feature
    TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_QUANTIZATION =
      if ((hostPlatform.isLinux && hostPlatform.isAarch64) || hostPlatform.isDarwin) then 1 else 0;
  };

  build-system = [
    setuptools
  ];

  nativeBuildInputs = lib.optionals cudaSupport [
    cudaPackages.cuda_nvcc
  ];

  buildInputs = lib.optionals cudaSupport [
    cudaPackages.cuda_cudart
  ];

  dependencies = [
    torch
    torchcodec
  ];

  pythonImportsCheck = [ "torchaudio" ];

  nativeCheckInputs = [
    expecttest
    inflect
    parameterized
    pytestCheckHook
    pytorch-lightning
    scipy
    sentencepiece
    unidecode
    librosa
    requests
    soundfile
  ];

  disabledTestPaths = [
    # Require internet access
    "test/integration_tests"
  ]
  ++ lib.optionals stdenv.hostPlatform.isDarwin [
    # Passes, but hangs the build after Pytest completes
    "test/torchaudio_unittest/models/models_test.py::TestConvTasNet"
  ];

  disabledTests = [
    # AssertionError: Tensor-likes are not close!
    # Mismatched elements: 1070 / 32800 (3.3%)
    "test_amplitude_to_DB"
    "test_amplitude_to_DB_power"

    # Very long to run
    "AutogradCPUTest"
    "TestAutogradLfilterCPU"
    "TestWav2Vec2Model"
  ]
  ++ lib.optionals (hostPlatform.isLinux && hostPlatform.isAarch64) [
    # AssertionError: Tensor-likes are not close!
    "test_batch_inverse_spectrogram"
    "test_batch_pitch_shift"
    "test_batch_spectrogram"
    "test_griffinlim_0_99"

    # RuntimeError: illegal immediate parameter (range error)
    "test_lfilter_shape_4"
    "test_lfilter_shape_6"
  ]
  ++ lib.optionals hostPlatform.isDarwin [
    # AssertionError: Tensor-likes are not close!
    "test_griffinlim_0_99"
  ]
  ++ lib.optionals (hostPlatform.isDarwin && hostPlatform.isx86_64) [
    # AssertionError: Tensor-likes are not close!
    "test_MelSpectrogram_00"
    "test_MelSpectrogram_01"
    "test_MelSpectrogram_04"
    "test_MelSpectrogram_05"
    "test_MelSpectrogram_08"
    "test_MelSpectrogram_09"
  ];

  passthru.gpuCheck = torchaudio.overridePythonAttrs (old: {
    pname = "${finalAttrs.pname}-gpuCheck";
    requiredSystemFeatures = [ "cuda" ];

    env = (old.env or { }) // {
      TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CUCTC_DECODER = 0;
      TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CUDA = 0;
    };
  });

  meta = {
    description = "PyTorch audio library";
    homepage = "https://pytorch.org/audio";
    downloadPage = "https://github.com/pytorch/audio";
    changelog = "https://github.com/pytorch/audio/releases/tag/${finalAttrs.src.tag}";
    license = lib.licenses.bsd2;
    platforms =
      lib.platforms.linux ++ lib.optionals (!cudaSupport && !rocmSupport) lib.platforms.darwin;
    maintainers = with lib.maintainers; [
      GaetanLepage
      caniko
      junjihashimoto
    ];
  };
})