.. nnsvs documentation master file, created by
   sphinx-quickstart on Fri Apr 24 00:51:13 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

NNSVS
=====

Neural network based singing voice synthesis library

- GitHub: https://github.com/nnsvs/nnsvs
- Paper: https://arxiv.org/abs/2210.15987
- Demo: https://r9y9.github.io/projects/nnsvs/


Features
--------

- **Open-source**: NNSVS is fully open-source. You can create your own voicebanks with your dataset.
- **Multiple languages**: NNSVS has been used for creating singing voice synthesis (SVS) systems for multiple languages by VocalSynth comminities (8+ as far as I know).
- **Research friendly**: NNSVS comes with reproducible Kaldi/ESPnet-style recipes. You can use NNSVS to create baseline systems for your research.

Tools
-----

Note that NNSVS was originally designed for research purposes. Please check out more user-friendly tools below if you are neither a researcher nor a software developer.

- `ENUNU <https://github.com/oatsu-gh/ENUNU>`_
- `Simple-ENUNU <https://github.com/oatsu-gh/SimpleEnunu>`_

You can find a practical guide for NNSVS/ENUNU at https://nnsvs.carrd.co/ (by `xuu <https://xuu.crd.co/>`_).
A detailed tutorial for for making voice banks can be found at `NNSVS Database Making Tutorial <https://docs.google.com/document/d/1uMsepxbdUW65PfIWL1pt2OM6ZKa5ybTTJOpZ733Ht6s/edit?usp=sharing>`_ (by `PixProcuer <https://twitter.com/PixPrucer>`_).

Selected samples
----------------

Diffusion + SiFiGAN for Ritsu (2023/03/12)

.. youtube:: 1V41mghsxIU
   :align: center

Diffusion + SiFiGAN for Cipher  (2023/03/14)

.. youtube:: CIa6NMnTpfM
   :align: center

Autoregressive model + uSFGAN  (2022/09/24)

..  youtube:: u2210L3JXPo
   :align: center

You can find more from the NNSVS/ENUNU community: `YouTube <https://www.youtube.com/results?search_query=nnsvs+enunu>`_, `NicoNico <https://www.nicovideo.jp/search/nnsvs%20OR%20enunu>`_


.. toctree::
   :maxdepth: 1
   :caption: Demos

   notebooks/Demos

.. toctree::
   :maxdepth: 1
   :caption: Guides

   installation
   recipes
   how_to_choose_model
   custom_models
   devdocs
   tips
   update_guide

.. toctree::
   :maxdepth: 1
   :caption: Advanced guides

   optuna
   train_vocoders
   train_usfgan
   enunu2nnsvs

.. toctree::
   :maxdepth: 1
   :caption: Notes

   overview

.. toctree::
   :maxdepth: 1
   :caption: Package reference

   modules/base
   modules/model
   modules/acoustic_models
   modules/postfilters
   modules/discriminators
   modules/pretrained
   modules/svs
   modules/dsp
   modules/gen
   modules/io
   modules/mdn
   modules/pitch
   modules/multistream
   modules/util
   modules/train_util

.. toctree::
   :maxdepth: 1
   :caption: Resources

   links
   papers

.. toctree::
    :maxdepth: 1
    :caption: Meta information

    changelog


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`