Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Pengcheng YIN authored Oct 12, 2018
1 parent 4eb16bb commit 0ecab65
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,19 @@ SQL | `asdl/lang/sql/sql_asdl.txt` | WikiSQL (Zhong et al., 2017)

## Usage

**Conda Environments** TranX supports both Python 2.7 and 3.5. Please note that
### Conda Environments
TranX supports both Python 2.7 and 3.5. Please note that
some datasets only support Python 2.7 (e.g., Django) or Python 3+ (e.g., WikiSQL). We provide example
conda environments (`data/env/(py2torch3cuda9.yml|py3torch3cuda9.yml)`) for both Python versions.
You can export the enviroments using the following command:

```bash
conda env create -f data/env/(py2torch3cuda9.yml|py3torch3cuda9.yml)
```

The conda enviroments are generated on a Ubuntu 16.04 machine. If you are unable to import the enviroment with error message like `cannot found package numpy=1.14.3=py36h14a74c5_0`, please try removing the sha after the version number (e.g., `=py36h14a74c5_0`), since it might be different on different platforms. We keep the detailed version number with sha to ensure reproducibility.

### Example Training Script

```bash
git clone https://github.com/pcyin/tranX
Expand All @@ -69,7 +79,7 @@ The `scripts` folder contains scripts to train TranX on example datasets. For ex
```
. scripts/django/train.sh 0 # start training on Django dataset with seed 0
```
Using the provided conda environment, it achieves 73.9% test accuracy on a ubuntu 16.04 machine with GTX1080 GPU.
Using the provided conda environment, it achieves 73.9% test accuracy on a Ubuntu 16.04 machine with GTX1080 GPU.

## FAQs

Expand Down

0 comments on commit 0ecab65

Please sign in to comment.