File size: 1,910 Bytes
0b32ad6 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
.. S3PRL documentation master file, created by
sphinx-quickstart on Sun May 15 15:43:39 2022.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
S3PRL
=====
.. image:: https://raw.githubusercontent.com/s3prl/s3prl/master/file/S3PRL-logo.png
**S3PRL** is a toolkit targeting for Self-Supervised Learning for speech processing.
Its full name is **S**\elf-**S**\upervised **S**\peech **P**\re-training and **R**\epresentation **L**\earning.
It supports the following three major features:
* **Pre-training**
* You can train the following models from scratch:
* *Mockingjay*, *Audio ALBERT*, *TERA*, *APC*, *VQ-APC*, *NPC*, and *DistilHuBERT*
* **Pre-trained models (Upstream) collection**
* Easily load most of the existing upstream models with pretrained weights in a unified I/O interface.
* Pretrained models are registered through torch.hub, which means you can use these models in your own project by one-line plug-and-play without depending on this toolkit's coding style.
* **Downstream Evaluation**
* Utilize upstream models in lots of downstream tasks
* The official implementation of the `SUPERB Benchmark <https://superbbenchmark.org/>`_
Getting Started
---------------
.. toctree::
:caption: Getting started
./tutorial/installation.rst
./tutorial/upstream_collection.rst
./tutorial/problem.rst
How to Contribute
-----------------
.. toctree::
:caption: How to Contribute
./contribute/general.rst
./contribute/upstream.rst
API Documentation
-----------------
.. autosummary::
:caption: API Documentation
:toctree: _autosummary
:template: custom-module-template.rst
:recursive:
s3prl.nn
s3prl.problem
s3prl.task
s3prl.dataio
s3prl.metric
s3prl.util
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|