Merge pull request #153 from sp-nitech/doctest

Add doctest

Author: takenori-y

.github/workflows/ci.yml

@@ -21,15 +21,15 @@ jobs:
             torch: 2.3.1
             torchaudio: 2.3.1
           - python: "3.13"
-            torch: 2.8.0
-            torchaudio: 2.8.0
+            torch: 2.9.0
+            torchaudio: 2.9.0
 
     steps:
       - name: Clone
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python }}
           architecture: x64
@@ -46,7 +46,7 @@ jobs:
         run: make check
 
       - name: Test
-        run: make test OPT="--dtype double"
+        run: make test-all OPT="--dtype double"
 
       - name: Coverage
         uses: codecov/codecov-action@v5

Makefile

@@ -61,11 +61,18 @@ format: tool
 	./tools/taplo/taplo fmt *.toml
 	./tools/yamlfmt/yamlfmt *.cff *.yml .github/workflows/*.yml
 
+test-all: test-example test
+
 test: tool
-	[ -n "$(MODULE)" ] && module=tests/test_$(MODULE).py || module=; \
+	[ -n "$(MODULE)" ] && module="--no-cov tests/test_$(MODULE).py" || module=; \
 	. .venv/bin/activate && export PATH=./tools/SPTK/bin:$$PATH NUMBA_CUDA_LOW_OCCUPANCY_WARNINGS=0 PYLSTRAIGHT_DEBUG=1 && \
 	python -m pytest $$module $(OPT)
 
+test-example: tool
+	[ -n "$(MODULE)" ] && module=modules/$(MODULE).py || module=; \
+	. .venv/bin/activate && export NUMBA_CUDA_LOW_OCCUPANCY_WARNINGS=0 && \
+	python -m pytest --doctest-modules --no-cov --ignore=diffsptk/third_party diffsptk/$$module
+
 test-clean:
 	rm -rf tests/__pycache__
 	rm -rf *.png *.wav

README.md

@@ -2,11 +2,12 @@
 
 *diffsptk* is a differentiable version of [SPTK](https://github.com/sp-nitech/SPTK) based on the PyTorch framework.
 
-[![Manual](https://img.shields.io/badge/docs-stable-blue.svg)](https://sp-nitech.github.io/diffsptk/3.3.1/)
+[![Manual](https://img.shields.io/badge/docs-stable-blue.svg)](https://sp-nitech.github.io/diffsptk/3.4.0/)
 [![Downloads](https://static.pepy.tech/badge/diffsptk)](https://pepy.tech/project/diffsptk)
 [![ClickPy](https://img.shields.io/badge/downloads-clickpy-yellow.svg)](https://clickpy.clickhouse.com/dashboard/diffsptk)
+[![Advisor](https://snyk.io/advisor/python/diffsptk/badge.svg)](https://snyk.io/advisor/python/diffsptk)
 [![Python Version](https://img.shields.io/pypi/pyversions/diffsptk.svg)](https://pypi.python.org/pypi/diffsptk)
-[![PyTorch Version](https://img.shields.io/badge/pytorch-2.3.1%20%7C%202.8.0-orange.svg)](https://pypi.python.org/pypi/diffsptk)
+[![PyTorch Version](https://img.shields.io/badge/pytorch-2.3.1%20%7C%202.9.0-orange.svg)](https://pypi.python.org/pypi/diffsptk)
 [![PyPI Version](https://img.shields.io/pypi/v/diffsptk.svg)](https://pypi.python.org/pypi/diffsptk)
 [![Codecov](https://codecov.io/gh/sp-nitech/diffsptk/branch/master/graph/badge.svg)](https://app.codecov.io/gh/sp-nitech/diffsptk)
 [![License](https://img.shields.io/github/license/sp-nitech/diffsptk.svg)](https://github.com/sp-nitech/diffsptk/blob/master/LICENSE)
@@ -20,7 +21,7 @@
 
 ## Documentation
 
-- Online [documentation](https://sp-nitech.github.io/diffsptk/3.3.1/) for the reference manual
+- Online [documentation](https://sp-nitech.github.io/diffsptk/3.4.0/) for the reference manual
 - Conference [paper](https://www.isca-archive.org/ssw_2023/yoshimura23_ssw.html) on the ISCA Archive
 - Hands-on [tutorial](https://colab.research.google.com/drive/1xAoUKqXadvJXJ7RzN0OceB6y7q5i7Sn6?usp=drive_link) on Google Colab
 

diffsptk/functional.py

@@ -444,11 +444,12 @@ def dht(x: Tensor, dht_type: int = 2) -> Tensor:
 
 def drc(
     x: Tensor,
+    *,
+    sample_rate: int,
     threshold: float,
     ratio: float,
     attack_time: float,
     release_time: float,
-    sample_rate: int,
     makeup_gain: float = 0,
     abs_max: float = 1,
 ) -> Tensor:
@@ -459,6 +460,9 @@ def drc(
     x : Tensor [shape=(..., T)]
         The input waveform.
 
+    sample_rate : int >= 1
+        The sample rate in Hz.
+
     threshold : float <= 0
         The threshold in dB.
 
@@ -471,9 +475,6 @@ def drc(
     release_time : float > 0
         The release time in msec.
 
-    sample_rate : int >= 1
-        The sample rate in Hz.
-
     makeup_gain : float >= 0
         The make-up gain in dB.
 
@@ -571,36 +572,27 @@ def dtw(
     )
 
 
-def dtw_merge(x: Tensor, y: Tensor, indices: Tensor) -> tuple[Tensor, Tensor]:
-    """Align two vector sequences according to the given path.
+def dtw_merge(x: Tensor, y: Tensor, indices: Tensor) -> Tensor:
+    """Merge two sequences according to the given indices.
 
     Parameters
     ----------
-    x : Tensor [shape=(T1, ...)]
+    x : Tensor [shape=(T1, D) or (T1,)]
         The query vector sequence.
 
-    y : Tensor [shape=(T2, ...)]
+    y : Tensor [shape=(T2, D) or (T2,)]
         The reference vector sequence.
 
     indices : Tensor [shape=(T, 2)]
-        The indices of the path.
+        The indices of the viterbi path.
 
     Returns
     -------
-    x_align : Tensor [shape=(T, ...)]
-        The aligned query vector sequence.
-
-    y_align : Tensor [shape=(T, ...)]
-        The aligned reference vector sequence.
+    z : Tensor [shape=(T, 2D) or (T, 2)]
+        The merged vector sequence.
 
     """
-    if x.dim() != y.dim():
-        raise ValueError("x and y must have the same number of dimensions.")
-    if indices.dim() != 2 or indices.size(-1) != 2:
-        raise ValueError("The shape of indices must be (T, 2).")
-    x_align = x[indices[:, 0]]
-    y_align = y[indices[:, 1]]
-    return x_align, y_align
+    return nn.DynamicTimeWarping.merge(x=x, y=y, indices=indices)
 
 
 def entropy(p: Tensor, out_format: str = "nat") -> Tensor:

diffsptk/modules/acorr.py

@@ -62,8 +62,9 @@ def forward(self, x: torch.Tensor) -> torch.Tensor:
 
         Examples
         --------
-        >>> x = diffsptk.ramp(4)
+        >>> import diffsptk
         >>> acorr = diffsptk.Autocorrelation(5, 3)
+        >>> x = diffsptk.ramp(4)
         >>> r = acorr(x)
         >>> r
         tensor([30.0000, 20.0000, 11.0000,  4.0000])

diffsptk/modules/acr2csm.py

@@ -73,14 +73,13 @@ def forward(self, r: torch.Tensor) -> torch.Tensor:
 
         Examples
         --------
-        >>> x = diffsptk.nrand(4)
-        >>> x
-        tensor([ 0.0165, -2.3693,  0.1375, -0.2262,  1.3307])
+        >>> import diffsptk
         >>> acorr = diffsptk.Autocorrelation(5, 3)
         >>> acr2csm = diffsptk.AutocorrelationToCompositeSinusoidalModelCoefficients(3)
+        >>> x = diffsptk.ramp(4)
         >>> c = acr2csm(acorr(x))
         >>> c
-        tensor([0.9028, 2.5877, 3.8392, 3.6153])
+        tensor([ 0.5261,  2.1403, 25.7668,  4.2332])
 
         """
         check_size(r.size(-1), self.in_dim, "dimension of autocorrelation")
@@ -137,12 +136,6 @@ def _precompute(
 
     @staticmethod
     def _forward(r: torch.Tensor, C: torch.Tensor) -> torch.Tensor:
-        if r.dtype != torch.double or C.dtype != torch.double:
-            raise ValueError(
-                "Only double precision is supported "
-                f"(input: {r.dtype}, module: {C.dtype})."
-            )
-
         u = torch.matmul(r, C)
         u1, u2 = torch.tensor_split(u, 2, dim=-1)
 

diffsptk/modules/alaw.py

@@ -57,8 +57,9 @@ def forward(self, x: torch.Tensor) -> torch.Tensor:
 
         Examples
         --------
-        >>> x = diffsptk.ramp(4)
+        >>> import diffsptk
         >>> alaw = diffsptk.ALawCompression(4)
+        >>> x = diffsptk.ramp(4)
         >>> y = alaw(x)
         >>> y
         tensor([0.0000, 2.9868, 3.4934, 3.7897, 4.0000])

diffsptk/modules/ap.py

@@ -138,15 +138,16 @@ def forward(self, x: torch.Tensor, f0: torch.Tensor) -> torch.Tensor:
 
         Examples
         --------
-        >>> x = diffsptk.sin(1000, 80)
-        >>> pitch = diffsptk.Pitch(160, 8000, out_format="f0")
+        >>> import diffsptk
+        >>> pitch = diffsptk.Pitch(160, 16000, out_format="f0")
+        >>> aperiodicity = diffsptk.Aperiodicity(160, 16000, 1024)
+        >>> x = diffsptk.sin(2000, 80)
         >>> f0 = pitch(x)
         >>> f0.shape
-        torch.Size([7])
-        >>> aperiodicity = diffsptk.Aperiodicity(160, 16000, 1024)
+        torch.Size([13])
         >>> ap = aperiodicity(x, f0)
         >>> ap.shape
-        torch.Size([7, 513])
+        torch.Size([13, 513])
 
         """
         d = x.dim()

diffsptk/modules/b2mc.py

@@ -77,12 +77,13 @@ def forward(self, b: torch.Tensor) -> torch.Tensor:
 
         Examples
         --------
-        >>> b = diffsptk.ramp(4)
+        >>> import diffsptk
         >>> mc2b = diffsptk.MelCepstrumToMLSADigitalFilterCoefficients(4, 0.3)
         >>> b2mc = diffsptk.MLSADigitalFilterCoefficientsToMelCepstrum(4, 0.3)
+        >>> b = diffsptk.ramp(1, 5)
         >>> b2 = mc2b(b2mc(b))
         >>> b2
-        tensor([0.0000, 1.0000, 2.0000, 3.0000, 4.0000])
+        tensor([1.0000, 2.0000, 3.0000, 4.0000, 5.0000])
 
         """
         check_size(b.size(-1), self.in_dim, "dimension of cepstrum")

diffsptk/modules/c2acr.py

@@ -61,13 +61,13 @@ def forward(self, c: torch.Tensor) -> torch.Tensor:
 
         Examples
         --------
-        >>> c = diffsptk.nrand(4)
-        >>> c
-        tensor([-0.1751,  0.1950, -0.3211,  0.3523, -0.5453])
-        >>> c2acr = diffsptk.CepstrumToAutocorrelation(4, 4, 16)
+        >>> import diffsptk
+        >>> import torch
+        >>> c2acr = diffsptk.CepstrumToAutocorrelation(4, 3)
+        >>> c = torch.tensor([0.5, -0.3, 0.2, -0.1, 0.05])
         >>> r = c2acr(c)
         >>> r
-        tensor([ 1.0672, -0.0485, -0.1564,  0.2666, -0.4551])
+        tensor([ 3.2404, -1.1920,  0.9037, -0.5838])
 
         """
         check_size(c.size(-1), self.in_dim, "dimension of cepstrum")