From 6563f7e60d2cb1e7e39a870e99a106884df365ff Mon Sep 17 00:00:00 2001 From: Pierre Andrews <628467+Mortimerp9@users.noreply.github.com> Date: Wed, 11 Dec 2024 10:08:36 +0000 Subject: [PATCH] update README --- README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 11ca5fc..c0f3e75 100644 --- a/README.md +++ b/README.md @@ -31,14 +31,11 @@ The full list of supported languages (along with download links) can be found he You can install SONAR with `pip install sonar-space`. Note that there is another `sonar` package on pip that IS NOT this project, make sure to use `sonar-space` in your dependencies. -If you want to install SONAR manually, you can install it localy. SONAR depends mainly on [Fairseq2](https://github.com/facebookresearch/fairseq2) and can be installed using (tested with `python=3.8`) +SONAR depends on fairseq2 and torch/torchaudio, you will have to install the variant (cpu/cuda/...) that works for your environment manully. -```bash -pip install --upgrade pip -pip install -e . -``` +Check [fairseq2 variants](https://github.com/facebookresearch/fairseq2?tab=readme-ov-file#variants) for possible variants. Note that SONAR currently relies on the release candidate for fairseq2 0.3.0 rc1. -If fairseq2 does not provide a build for your machine, check the readme of that project to build it locally. +If [fairseq2](https://github.com/facebookresearch/fairseq2) does not provide a build for your machine, check the readme of that project to build it locally. ## Usage fairseq2 will automatically download models into your `$TORCH_HOME/hub` directory upon using the commands below.