Skip to content

Commit ac06a8b

Browse files
committed
✍️ update setuptools and installation instruction
1 parent 8769192 commit ac06a8b

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,31 +76,31 @@ TensorFlowASR implements some automatic speech recognition architectures such as
7676

7777
## Installation
7878

79-
Install `tensorflow>=2.3.0` or `tf-nightly`.
80-
8179
For training and testing, you should use `git clone` for installing necessary packages from other authors (`ctc_decoders`, `rnnt_loss`, etc.)
8280

8381
### Installing via PyPi
8482

85-
Run `pip3 install -U TensorFlowASR`
83+
For tensorflow 2.3.x, run `pip3 install -U 'TensorFlowASR[tf2.3]'` or `pip3 install -U 'TensorFlowASR[tf2.3-gpu]'`
84+
85+
For tensorflow 2.4.x, run `pip3 install -U 'TensorFlowASR[tf2.4]'` or `pip3 install -U 'TensorFlowASR[tf2.4-gpu]'`
8686

8787
### Installing from source
8888

8989
```bash
9090
git clone https://github.com/TensorSpeech/TensorFlowASR.git
9191
cd TensorFlowASR
92-
pip3 install .
92+
pip3 install '.[tf2.3]' # or '.[tf2.3-gpu]' or '.[tf2.4]' or '.[tf2.4-gpu]'
9393
```
9494

9595
For anaconda3:
9696

9797
```bash
98-
conda create -y -n tfasr tensorflow-gpu python=3.8 # tensorflow if using CPU
98+
conda create -y -n tfasr tensorflow-gpu python=3.8 # tensorflow if using CPU, this makes sure conda install all dependencies for tensorflow
9999
conda activate tfasr
100100
pip install -U tensorflow-gpu # upgrade to latest version of tensorflow
101101
git clone https://github.com/TensorSpeech/TensorFlowASR.git
102102
cd TensorFlowASR
103-
pip install .
103+
pip3 install '.[tf2.3]' # or '.[tf2.3-gpu]' or '.[tf2.4]' or '.[tf2.4-gpu]'
104104
```
105105

106106
### Running in a container

requirements.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ sklearn
55
pandas
66
tensorflow-datasets>=4.2.0
77
tensorflow-addons>=0.11.1
8-
tensorflow-text>=2.3.0
9-
tensorflow-io>=0.16.0
108
setuptools>=47.1.1
119
librosa>=0.8.0
1210
soundfile>=0.10.3

setup.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
setuptools.setup(
2424
name="TensorFlowASR",
25-
version="0.8.2",
25+
version="0.8.3",
2626
author="Huy Le Nguyen",
2727
author_email="[email protected]",
2828
description="Almost State-of-the-art Automatic Speech Recognition using Tensorflow 2",
@@ -31,6 +31,12 @@
3131
url="https://github.com/TensorSpeech/TensorFlowASR",
3232
packages=setuptools.find_packages(include=["tensorflow_asr*"]),
3333
install_requires=requirements,
34+
extras_require={
35+
"tf2.3": ["tensorflow==2.3.2", "tensorflow-text==2.3.0", "tensorflow-io==0.16.0"],
36+
"tf2.3-gpu": ["tensorflow-gpu==2.3.2", "tensorflow-text==2.3.0", "tensorflow-io==0.16.0"],
37+
"tf2.4": ["tensorflow>=2.4", "tensorflow-text==2.4.3", "tensorflow-io==0.17.0"],
38+
"tf2.4-gpu": ["tensorflow-gpu>=2.4", "tensorflow-text==2.4.3", "tensorflow-io==0.17.0"]
39+
},
3440
classifiers=[
3541
"Programming Language :: Python :: 3.6",
3642
"Programming Language :: Python :: 3.7",

0 commit comments

Comments
 (0)