✍️ update setuptools and installation instruction

TensorSpeech · Apr 10, 2021 · ac06a8b · ac06a8b
1 parent 8769192
commit ac06a8b
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -76,31 +76,31 @@ TensorFlowASR implements some automatic speech recognition architectures such as
 
 ## Installation
 
-Install `tensorflow>=2.3.0` or `tf-nightly`.
-
 For training and testing, you should use `git clone` for installing necessary packages from other authors (`ctc_decoders`, `rnnt_loss`, etc.)
 
 ### Installing via PyPi
 
-Run `pip3 install -U TensorFlowASR`
+For tensorflow 2.3.x, run `pip3 install -U 'TensorFlowASR[tf2.3]'` or `pip3 install -U 'TensorFlowASR[tf2.3-gpu]'`
+
+For tensorflow 2.4.x, run `pip3 install -U 'TensorFlowASR[tf2.4]'` or `pip3 install -U 'TensorFlowASR[tf2.4-gpu]'`
 
 ### Installing from source
 
 ```bash
 git clone https://github.com/TensorSpeech/TensorFlowASR.git
 cd TensorFlowASR
-pip3 install .
+pip3 install '.[tf2.3]' # or '.[tf2.3-gpu]' or '.[tf2.4]' or '.[tf2.4-gpu]'
 ```
 
 For anaconda3:
 
 ```bash
-conda create -y -n tfasr tensorflow-gpu python=3.8 # tensorflow if using CPU
+conda create -y -n tfasr tensorflow-gpu python=3.8 # tensorflow if using CPU, this makes sure conda install all dependencies for tensorflow
 conda activate tfasr
 pip install -U tensorflow-gpu # upgrade to latest version of tensorflow
 git clone https://github.com/TensorSpeech/TensorFlowASR.git
 cd TensorFlowASR
-pip install .
+pip3 install '.[tf2.3]' # or '.[tf2.3-gpu]' or '.[tf2.4]' or '.[tf2.4-gpu]'
 ```
 
 ### Running in a container

diff --git a/requirements.txt b/requirements.txt
@@ -5,8 +5,6 @@ sklearn
 pandas
 tensorflow-datasets>=4.2.0
 tensorflow-addons>=0.11.1
-tensorflow-text>=2.3.0
-tensorflow-io>=0.16.0
 setuptools>=47.1.1
 librosa>=0.8.0
 soundfile>=0.10.3

diff --git a/setup.py b/setup.py
@@ -22,7 +22,7 @@
 
 setuptools.setup(
     name="TensorFlowASR",
-    version="0.8.2",
+    version="0.8.3",
     author="Huy Le Nguyen",
     author_email="nlhuy.cs.16@gmail.com",
     description="Almost State-of-the-art Automatic Speech Recognition using Tensorflow 2",
@@ -31,6 +31,12 @@
     url="https://github.com/TensorSpeech/TensorFlowASR",
     packages=setuptools.find_packages(include=["tensorflow_asr*"]),
     install_requires=requirements,
+    extras_require={
+        "tf2.3": ["tensorflow==2.3.2", "tensorflow-text==2.3.0", "tensorflow-io==0.16.0"],
+        "tf2.3-gpu": ["tensorflow-gpu==2.3.2", "tensorflow-text==2.3.0", "tensorflow-io==0.16.0"],
+        "tf2.4": ["tensorflow>=2.4", "tensorflow-text==2.4.3", "tensorflow-io==0.17.0"],
+        "tf2.4-gpu": ["tensorflow-gpu>=2.4", "tensorflow-text==2.4.3", "tensorflow-io==0.17.0"]
+    },
     classifiers=[
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",