The toolkit has three major usages:

Pretrain

• Pretrain upstream models, including Mockingjay, Audio ALBERT and TERA.
• Document: pretrain/README.md

Upstream

• 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.
• Document: upstream/README.md

Downstream

• Utilize upstream models in lots of downstream tasks
• Benchmark upstream models with SUPERB Benchmark
• Document: downstream/README.md

---

Installation

1. Python >= 3.6
2. Install sox on your OS
3. Install s3prl

pip install -e ./

4. Some upstream models require special dependencies. If you encounter error with a specific upstream model, you can look into the README.md under each upstream folder. E.g., upstream/pase/README.md