"""
The backbone run procedure of ASV tasks
Authors
* Haibin Wu 2022
* Leo 2022
"""
import logging
import os
import pickle
import shutil
from pathlib import Path
from typing import List
import pandas as pd
import yaml
from s3prl.problem.base import Problem
from s3prl.task.speaker_verification_task import SpeakerVerification
logger = logging.getLogger(__name__)
__all__ = ["ASV"]
[docs]class ASV(Problem):
[docs] def run(
self,
target_dir: str,
cache_dir: str,
remove_all_cache: bool = False,
start: int = 0,
stop: int = None,
num_workers: int = 6,
eval_batch: int = -1,
device: str = "cuda",
world_size: int = 1,
rank: int = 0,
test_ckpt_dir: str = None,
test_ckpt_steps: List[int] = None,
prepare_data: dict = None,
build_encoder: dict = None,
build_dataset: dict = None,
build_batch_sampler: dict = None,
build_collate_fn: dict = None,
build_upstream: dict = None,
build_featurizer: dict = None,
build_downstream: dict = None,
build_model: dict = None,
build_task: dict = None,
build_optimizer: dict = None,
build_scheduler: dict = None,
save_model: dict = None,
save_task: dict = None,
train: dict = None,
evaluate: dict = None,
):
"""
======== ====================
stage description
======== ====================
0 Parse the corpus and save the metadata file (waveform path, label...)
1 Build the encoder for encoding the speaker labels
2 Train the model
3 Evaluate the model on multiple test sets, multiple checkpoints will be evaluated for each test set (See :code:`test_ckpt_steps`)
4 Report the best result find on each test set
======== ====================
Args:
target_dir (str):
The directory that stores the script result.
cache_dir (str):
The directory that caches the processed data.
Default: /home/user/.cache/s3prl/data
remove_all_cache (bool):
Whether to remove all the cache stored under `cache_dir`.
Default: False
start (int):
The starting stage of the problem script.
Default: 0
stop (int):
The stoping stage of the problem script, set `None` to reach the final stage.
Default: None
num_workers (int): num_workers for all the torch DataLoder
eval_batch (int):
During evaluation (valid or test), limit the number of batch.
This is helpful for the fast development to check everything won't crash.
If is -1, disable this feature and evaluate the entire epoch.
Default: -1
device (str):
The device type for all torch-related operation: "cpu" or "cuda"
Default: "cuda"
world_size (int):
How many processes are running this script simultaneously (in parallel).
Usually this is just 1, however if you are runnig distributed training,
this should be > 1.
Default: 1
rank (int):
When distributed training, world_size > 1. Take :code:`world_size == 8` for
example, this means 8 processes (8 GPUs) are runing in parallel. The script
needs to know which process among 8 processes it is. In this case, :code:`rank`
can range from 0~7. All the 8 processes have the same :code:`world_size` but
different :code:`rank` (process id).
test_ckpt_dir (str):
Specify the checkpoint path for testing. If not, use checkpoints specified by
:code:`test_ckpts_steps`.
test_ckpt_steps (List[int]):
After training, multiple steps of checkpoints are saved. This option specifies
which checkpoints (multiple) will be used for evaluation.
**kwds:
The other arguments like :code:`prepare_data` and :code:`build_model` are
method specific-arguments for methods like :obj:`prepare_data` and
:obj:`build_model`, and will not be used in the core :obj:`run` logic.
See the specific method documentation for their supported arguments and
meaning
"""
yaml_path = Path(target_dir) / "configs" / f"{self._get_time_tag()}.yaml"
yaml_path.parent.mkdir(exist_ok=True, parents=True)
with yaml_path.open("w") as f:
yaml.safe_dump(self._get_current_arguments(), f)
cache_dir: str = cache_dir or Path.home() / ".cache" / "s3prl" / "data"
prepare_data: dict = prepare_data or {}
build_encoder: dict = build_encoder or {}
build_dataset: dict = build_dataset or {}
build_batch_sampler: dict = build_batch_sampler or {}
build_collate_fn: dict = build_collate_fn or {}
build_upstream: dict = build_upstream or {}
build_featurizer: dict = build_featurizer or {}
build_downstream: dict = build_downstream or {}
build_model: dict = build_model or {}
build_task: dict = build_task or {}
build_optimizer: dict = build_optimizer or {}
build_scheduler: dict = build_scheduler or {}
save_model: dict = save_model or {}
save_task: dict = save_task or {}
train: dict = train or {}
evaluate = evaluate or {}
target_dir: Path = Path(target_dir)
target_dir.mkdir(exist_ok=True, parents=True)
cache_dir = Path(cache_dir)
cache_dir.mkdir(exist_ok=True, parents=True)
if remove_all_cache:
shutil.rmtree(cache_dir)
stage_id = 0
if start <= stage_id:
logger.info(f"Stage {stage_id}: prepare data")
train_csv, test_csvs = self.prepare_data(
prepare_data, target_dir, cache_dir, get_path_only=False
)
train_csv, test_csvs = self.prepare_data(
prepare_data, target_dir, cache_dir, get_path_only=True
)
def check_fn():
assert Path(train_csv).is_file()
for test_csv in test_csvs:
assert Path(test_csv).is_file()
self._stage_check(stage_id, stop, check_fn)
stage_id = 1
if start <= stage_id:
logger.info(f"Stage {stage_id}: build encoder")
encoder_path = self.build_encoder(
build_encoder,
target_dir,
cache_dir,
train_csv,
test_csvs,
get_path_only=False,
)
encoder_path = self.build_encoder(
build_encoder,
target_dir,
cache_dir,
train_csv,
test_csvs,
get_path_only=True,
)
def check_fn():
assert Path(encoder_path).is_file()
self._stage_check(stage_id, stop, check_fn)
stage_id = 2
train_dir = target_dir / "train"
if start <= stage_id:
logger.info(f"Stage {stage_id}: Train Model")
train_ds, train_bs = self._build_dataset_and_sampler(
target_dir,
cache_dir,
"train",
train_csv,
encoder_path,
build_dataset,
build_batch_sampler,
)
with Path(encoder_path).open("rb") as f:
encoder = pickle.load(f)
build_model_all_args = dict(
build_model=build_model,
model_output_size=len(encoder),
build_upstream=build_upstream,
build_featurizer=build_featurizer,
build_downstream=build_downstream,
)
build_task_all_args_except_model = dict(
build_task=build_task,
encoder=encoder,
)
self.train(
train,
train_dir,
build_model_all_args,
build_task_all_args_except_model,
save_model,
save_task,
build_optimizer,
build_scheduler,
evaluate,
train_ds,
train_bs,
self.build_collate_fn(build_collate_fn, "train"),
None,
None,
None,
device=device,
eval_batch=eval_batch,
num_workers=num_workers,
world_size=world_size,
rank=rank,
)
test_ckpt_dirs = []
if test_ckpt_dir is not None:
test_ckpt_dirs.append(test_ckpt_dir)
if test_ckpt_steps is None:
train_ckpts = [
train_dir / name
for name in os.listdir(train_dir)
if name.startswith("step_")
]
test_ckpt_dirs.extend(train_ckpts)
else:
test_ckpt_dirs.extend(
[train_dir / f"step_{step}" for step in test_ckpt_steps]
)
def check_fn():
for ckpt_dir in test_ckpt_dirs:
assert Path(ckpt_dir).is_dir(), ckpt_dir
self._stage_check(stage_id, stop, check_fn)
stage_id = 3
if start <= stage_id:
for test_idx, test_csv in enumerate(test_csvs):
for ckpt_idx, ckpt_dir in enumerate(test_ckpt_dirs):
test_name = Path(test_csv).stem
test_dir: Path = (
target_dir
/ "evaluate"
/ test_name
/ ckpt_dir.relative_to(train_dir).as_posix().replace("/", "-")
)
test_dir.mkdir(exist_ok=True, parents=True)
logger.info(
f"Stage {stage_id}.{test_idx}.{ckpt_idx}: Test on {test_csv} with model {ckpt_dir}"
)
test_ds, test_bs = self._build_dataset_and_sampler(
target_dir,
cache_dir,
"test",
test_csv,
encoder_path,
build_dataset,
build_batch_sampler,
)
csv = pd.read_csv(test_csv)
test_trials = []
for rowid, row in csv.iterrows():
test_trials.append(
(int(row["label"]), str(row["id1"]), str(row["id2"]))
)
overrides = dict(test_trials=test_trials)
_, task = self.load_model_and_task(ckpt_dir, overrides)
logs = self.evaluate(
evaluate,
"test",
task,
test_ds,
test_bs,
self.build_collate_fn(build_collate_fn, "test"),
eval_batch,
test_dir,
device,
num_workers,
)
test_metrics = {name: float(value) for name, value in logs.items()}
logger.info(f"test metrics: {test_metrics}")
assert "EER" in test_metrics
with (test_dir / f"result.yaml").open("w") as f:
yaml.safe_dump(test_metrics, f)
self._stage_check(stage_id, stop, lambda: True)
stage_id = 4
if start <= stage_id:
for test_idx, test_csv in enumerate(test_csvs):
test_name = Path(test_csv).stem
logger.info(f"Report results on {test_name}")
eer_ckpts = []
for ckpt_dir in os.listdir(target_dir / "evaluate" / test_name):
result_yaml: Path = (
target_dir / "evaluate" / test_name / ckpt_dir / "result.yaml"
)
if result_yaml.is_file():
with open(result_yaml) as f:
eer_ckpts.append(
(
float(yaml.load(f, Loader=yaml.FullLoader)["EER"]),
str(result_yaml.parent),
)
)
logger.info(f"All EERs on {test_name}:")
for eer, ckpt in eer_ckpts:
logger.info(f"ckpt_dir: {ckpt}, eer: {eer}")
eer_ckpts.sort(key=lambda x: x[0])
best_eer, best_ckpt_dir = eer_ckpts[0]
logger.info(
f"Best EER on {test_name} is from {best_ckpt_dir}: {best_eer}"
)
with (target_dir / "evaluate" / test_name / "best_result.yaml").open(
"w"
) as f:
yaml.safe_dump({"EER": best_eer}, f)
def _build_dataset_and_sampler(
self,
target_dir: str,
cache_dir: str,
mode: str,
data_csv: str,
encoder_path: str,
build_dataset: dict,
build_batch_sampler: dict,
):
logger.info(f"Build {mode} dataset")
dataset = self.build_dataset(
build_dataset,
target_dir,
cache_dir,
mode,
data_csv,
encoder_path,
)
logger.info(f"Build {mode} batch sampler")
batch_sampler = self.build_batch_sampler(
build_batch_sampler,
target_dir,
cache_dir,
mode,
data_csv,
dataset,
)
return dataset, batch_sampler
[docs] def build_task(
self,
build_task: dict,
model,
encoder,
test_trials=None,
):
"""
Build the task, which defines the logics for every train/valid/test forward step for the :code:`model`,
and the logics for how to reduce all the batch results from multiple train/valid/test steps into metrics
By default build :obj:`SpeakerVerification`
Args:
build_task (dict): same in :obj:`default_config`, no argument supported for now
model (torch.nn.Module): the model built by :obj:`build_model`
encoder: the encoder built by :obj:`build_encoder`
test_trials (List[Tuple[int, str, str]]): each tuple in the list consists of
:code:`(label, enroll_utt_id, test_utt_id)`. label is either 0 or 1
Returns:
Task
"""
task = SpeakerVerification(model, encoder, test_trials, **build_task)
return task