Skip to content

Commit f092d39

Browse files
committed
docs: readme
1 parent 66ca1ed commit f092d39

File tree

1 file changed

+2
-38
lines changed

1 file changed

+2
-38
lines changed

README.md

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,6 @@ TensorFlowASR implements some automatic speech recognition architectures such as
3131
- [Baselines](#baselines)
3232
- [Publications](#publications)
3333
- [Installation](#installation)
34-
- [Installing from source (recommended)](#installing-from-source-recommended)
35-
- [Installing via PyPi](#installing-via-pypi)
36-
- [Installing for development](#installing-for-development)
37-
- [Running in a container](#running-in-a-container)
3834
- [Training \& Testing Tutorial](#training--testing-tutorial)
3935
- [Features Extraction](#features-extraction)
4036
- [Augmentations](#augmentations)
@@ -79,45 +75,13 @@ For training and testing, you should use `git clone` for installing necessary pa
7975

8076
See the `requirements.[extra].txt` files for extra dependencies
8177

82-
### Installing from source (recommended)
83-
84-
```bash
85-
git clone https://github.com/TensorSpeech/TensorFlowASR.git
86-
cd TensorFlowASR
87-
pip3 install -e . # or ".[cuda]" if using GPU
88-
```
89-
90-
For **anaconda3**:
91-
92-
```bash
93-
conda create -y -n tfasr python=3.11 # tensorflow if using CPU, this makes sure conda install all dependencies for tensorflow
94-
conda activate tfasr
95-
git clone https://github.com/TensorSpeech/TensorFlowASR.git
96-
cd TensorFlowASR
97-
pip3 install -e . # or ".[cuda]" if using GPU
98-
```
99-
100-
For **colab with TPUs**:
101-
102-
```bash
103-
pip3 install -e ".[tpu]" -f https://storage.googleapis.com/libtpu-tf-releases/index.html
104-
```
105-
106-
### Installing via PyPi
107-
108-
```bash
109-
pip3 install "TensorFlowASR" # or "TensorFlowASR[cuda]" if using GPU
110-
```
111-
112-
### Installing for development
113-
11478
```bash
11579
git clone https://github.com/TensorSpeech/TensorFlowASR.git
11680
cd TensorFlowASR
117-
pip3 install -e ".[apple,dev]"
81+
./setup.sh [apple|tpu|gpu] [dev]
11882
```
11983

120-
### Running in a container
84+
**Running in a container**
12185

12286
```bash
12387
docker-compose up -d

0 commit comments

Comments
 (0)