Skip to content

Commit

Permalink
Update installation.md (#5029)
Browse files Browse the repository at this point in the history
* Update installation.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add files via upload

* Update installation.md

* Delete environment_structure.pdf

* Add files via upload

* Update installation.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update README.md

* Update README.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
kamo-naoyuki and pre-commit-ci[bot] committed Mar 18, 2023
1 parent 5e9ca93 commit c5b6254
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 1 deletion.
Binary file added doc/image/environment_structure.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions doc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,11 @@ We also have [prebuilt Kaldi binaries](https://github.com/espnet/espnet/blob/mas
</div></details>

### Step 2) Installation ESPnet

<div align="left"><img src="image/environment_structure.png" width="700"/></div>



1. Git clone ESPnet
```sh
$ cd <any-place>
Expand Down
20 changes: 19 additions & 1 deletion tools/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Tools for setup

<div align="left"><img src="../doc/image/environment_structure.png" width="700"/></div>


See also https://espnet.github.io/espnet/installation.html

## Contents
Expand All @@ -14,8 +17,23 @@ setup_python.sh # To generate activate_python.sh with the specified python
setup_venv.sh # To generate activate_python.sh with venv of your python
```

## Check installation
## Install

```sh
# ./setup_anaconda.sh <conda-root|default="venv"> <env-name|default=root env> <python-version|default=latest python>
# e.g.
./setup_anaconda.sh miniconda espnet
# If the conda-root already exists at the path, it tries to create in the conda
# ./setup_anaconda.sh /some/where/miniconda espnet

# e.g. make TH_VERSION=<torch-ver|default=latest torch>
make
```

For more detail: https://espnet.github.io/espnet/installation.html#step-2-installation-espnet

## Check installation

```sh
. ./activate_python.sh; . ./extra_path.sh; python3 check_install.py
```

0 comments on commit c5b6254

Please sign in to comment.