mirror of
https://github.com/pyannote/pyannote-audio.git
synced 2026-11-20 13:07:51 +09:00
216 lines
7.3 KiB
Python
216 lines
7.3 KiB
Python
# MIT License
|
|
#
|
|
# Copyright (c) 2020 CNRS
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in all
|
|
# copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
# SOFTWARE.
|
|
|
|
|
|
from enum import Enum
|
|
from dataclasses import dataclass
|
|
from typing import Optional, List, Text
|
|
|
|
import pytorch_lightning as pl
|
|
import torch
|
|
import torch.optim
|
|
from torch.utils.data import DataLoader
|
|
from torch.utils.data import IterableDataset
|
|
import torch.nn.functional as F
|
|
from pyannote.database import Protocol
|
|
|
|
|
|
# Type of machine learning problem
|
|
class Problem(Enum):
|
|
MONO_LABEL_CLASSIFICATION = 1
|
|
MULTI_LABEL_CLASSIFICATION = 2
|
|
REPRESENTATION = 3
|
|
REGRESSION = 4
|
|
# any other we could think of?
|
|
|
|
|
|
# A task takes an audio chunk as input and returns
|
|
# either a temporal sequence of predictions
|
|
# or just one prediction for the whole audio chunk
|
|
class Scale(Enum):
|
|
FRAME = 1 # model outputs a sequence of frames
|
|
CHUNK = 2 # model outputs just one vector for the whole chunk
|
|
|
|
|
|
@dataclass
|
|
class TaskSpecification:
|
|
problem: Problem
|
|
scale: Scale
|
|
|
|
# for classification tasks only
|
|
classes: Optional[List[Text]] = None
|
|
|
|
|
|
# note how a task is actually a LightningDataModule
|
|
class Task(pl.LightningDataModule):
|
|
"""Base task class
|
|
|
|
A task is the combination of a "problem" and a "dataset".
|
|
For example, here are a few tasks:
|
|
- voice activity detection on the AMI corpus
|
|
- speaker embedding on the VoxCeleb corpus
|
|
- end-to-end speaker diarization on the VoxConverse corpus
|
|
|
|
A task is expected to be solved by a "model" that takes an
|
|
audio chunk as input and returns the solution. Hence, the
|
|
task is in charge of generating (input, expected_output)
|
|
samples used for training the model.
|
|
|
|
Parameters
|
|
----------
|
|
protocol : Protocol
|
|
pyannote.database protocol
|
|
duration : float, optional
|
|
Chunks duration. Defaults to variable duration (None).
|
|
batch_size : int, optional
|
|
Number of training samples per batch.
|
|
num_workers : int, optional
|
|
Number of workers used for generating training samples.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
protocol: Protocol,
|
|
duration: float = None,
|
|
batch_size: int = None,
|
|
num_workers: int = 1,
|
|
):
|
|
super().__init__()
|
|
|
|
# dataset
|
|
self.protocol = protocol
|
|
|
|
# batching
|
|
self.duration = duration
|
|
self.batch_size = batch_size
|
|
self.num_workers = num_workers
|
|
|
|
def prepare_data(self):
|
|
# this is where we might end up downloading datasets
|
|
# and transform them so that they are ready to be used
|
|
# with pyannote.database. but for now, the API assume
|
|
# that we directly provide a pyannote.database.Protocol.
|
|
pass
|
|
|
|
def train__iter__(self):
|
|
# will become train_dataset.__iter__ method
|
|
msg = f"Missing '{self.__class__.__name__}.train__iter__' method."
|
|
raise NotImplementedError(msg)
|
|
|
|
def train__len__(self):
|
|
# will become train_dataset.__len__ method
|
|
msg = f"Missing '{self.__class__.__name__}.train__len__' method."
|
|
raise NotImplementedError(msg)
|
|
|
|
def train_dataloader(self) -> DataLoader:
|
|
# build train IterableDataset subclass programmatically
|
|
dataset = type(
|
|
"TrainDataset",
|
|
(IterableDataset,),
|
|
{"__iter__": self.train__iter__, "__len__": self.train__len__},
|
|
)
|
|
|
|
return DataLoader(
|
|
dataset(),
|
|
batch_size=self.batch_size,
|
|
num_workers=self.num_workers,
|
|
drop_last=True,
|
|
)
|
|
|
|
@property
|
|
def example_input_duration(self) -> float:
|
|
return 2.0 if self.duration is None else self.duration
|
|
|
|
def example_input_array(self):
|
|
# this method is called in Model.setup where it is used
|
|
# to automagically infer the temporal resolution of the
|
|
# model output, and hence allow the dataloader to shape
|
|
# its targets correctly.
|
|
|
|
# since we plan to have the feature extraction step done
|
|
# on GPU as part of the model, the example input array is
|
|
# basically always a chunk of audio
|
|
|
|
if self.audio.mono:
|
|
num_channels = 1
|
|
else:
|
|
msg = "Only 'mono' audio is supported."
|
|
raise NotImplementedError(msg)
|
|
|
|
return torch.randn(
|
|
(
|
|
self.batch_size,
|
|
int(self.audio.sample_rate * self.example_input_duration),
|
|
num_channels,
|
|
)
|
|
)
|
|
|
|
# below is a (hacky) way to automagically infer the expected
|
|
# resolution of the target. basically, we do a forward pass
|
|
# of an example input array and look at the resulting shape
|
|
# of the output. the problem with this approach is that we
|
|
# may encounter weird rounding errors in case of variable-length
|
|
# chunks. TODO: someone should look at this to make it more robust.
|
|
|
|
@property
|
|
def example_output_array(self) -> torch.Tensor:
|
|
return self.example_output_array_
|
|
|
|
@example_output_array.setter
|
|
def example_output_array(self, example_output_array: torch.Tensor):
|
|
self.example_output_array_ = example_output_array
|
|
if self.specifications.scale == Scale.FRAME:
|
|
self.frame_duration_ = (
|
|
self.example_input_duration / example_output_array.shape[1]
|
|
)
|
|
|
|
@property
|
|
def frame_duration(self) -> float:
|
|
if self.specifications.scale == Scale.FRAME:
|
|
return self.frame_duration_
|
|
|
|
# default training_step provided for convenience
|
|
# can obviously be overriden for each task
|
|
def training_step(self, model: "Model", batch, batch_idx: int):
|
|
X, y = batch["X"], batch["y"]
|
|
if self.specifications.problem == Problem.MONO_LABEL_CLASSIFICATION:
|
|
loss = F.nll_loss(
|
|
model(X).view(-1, len(self.specifications.classes)), y.view(-1)
|
|
)
|
|
|
|
elif self.specifications.problem == Problem.MULTI_LABEL_CLASSIFICATION:
|
|
loss = F.binary_cross_entropy(model(X), y.float())
|
|
|
|
else:
|
|
msg = "TODO: implement for other types of problems"
|
|
raise NotImplementedError(msg)
|
|
|
|
model.log("train_loss", loss)
|
|
return loss
|
|
|
|
# default configure_optimizers provided for convenience
|
|
# can obviously be overriden for each task
|
|
def configure_optimizers(self, model: "Model"):
|
|
# for tasks such as SpeakerEmbedding,
|
|
# other parameters should be added here
|
|
return torch.optim.Adam(model.parameters(), lr=1e-3)
|