Skip to content

Commit

Permalink
Updating README to have clearer installation expectations (#103)
Browse files Browse the repository at this point in the history
#102
#101

People are having issues that are a result of poor documentation.  This should help.

Signed-off-by: lucapericlp <[email protected]>
  • Loading branch information
lucapericlp authored Mar 25, 2024
1 parent 3b5ead3 commit 48bd134
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,14 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# install poetry if not installed (ensure you've restarted your terminal after installation)
pipx install poetry

# disable any conda envs that might interfere with poetry's venv
conda deactivate

# if running from Linux, keyring backend can hang on `poetry install`. This prevents that.
export PYTHON_KEYRING_BACKEND=keyring.backends.fail.Keyring

# pip's dependency resolver will complain, this is temporary expected behaviour
# full inference & finetuning functionality will still be available
poetry install && poetry run pip install torch==2.2.1 torchaudio==2.2.1
```

Expand Down

0 comments on commit 48bd134

Please sign in to comment.