From 46619ac8577190781955d78ab080b5bd5c991b30 Mon Sep 17 00:00:00 2001 From: Aaron Keesing Date: Tue, 6 Jun 2023 17:37:29 +1200 Subject: [PATCH] Add fairseq note to docs. --- README.md | 18 ++++++++++++++++++ docs/installation.rst | 7 ++++++- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cab37d3..1c37958 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ ![Version](https://img.shields.io/pypi/v/ertk) ![Python version](https://img.shields.io/pypi/pyversions/ertk) ![Python wheel](https://img.shields.io/pypi/wheel/ertk) +![Read the Docs](https://img.shields.io/readthedocs/ertk) +![GitHub stars](https://img.shields.io/github/stars/Strong-AI-Lab/emotion?style=social) # ERTK: Emotion Recognition ToolKit This is a Python library with utilities for processing emotional @@ -37,6 +39,22 @@ Or, if you want to develop continuously: pip install -e . ``` +### Optional dependencies +Optional dependencies can be install via: +``` +pip install -r requirements-dev.txt +``` +Or via PyPI: +``` +pip install ertk[all-preprocessors] +``` +Note that if installing from PyPI, fairseq is not updated on PyPI and so +must be installed from GitHub directly: +``` +pip install git+https://github.com/facebookresearch/fairseq.git@ae59bd6d04871f6174351ad46c90992e1dca7ac7 +``` + + ## Using CLI tools Upon installation, you should be able to use common tools using the CLI applications `ertk-cli`, `ertk-dataset` and `ertk-util`. Use the diff --git a/docs/installation.rst b/docs/installation.rst index 95f8ac5..af8a326 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -48,4 +48,9 @@ ERTK can use the following third-party libraries if they are installed: To install ERTK with these dependencies, use the ``[all]`` extra:: - pip install ertk[all] + pip install ertk[all-preprocessors] + +Note that fairseq is not updated on PyPI and so must be installed from +GitHub directly:: + + pip install git+https://github.com/facebookresearch/fairseq.git@ae59bd6d04871f6174351ad46c90992e1dca7ac7