Skip to content

Commit

Permalink
Update README installation section
Browse files Browse the repository at this point in the history
  • Loading branch information
ZhitingHu committed Oct 16, 2019
1 parent 95822e1 commit 9cafd4d
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,21 +109,30 @@ Many more examples are available [here](./examples).


### Installation
Texar-PyTorch requires `torch >= 1.0.0 (but < 1.3.0)`. Please follow the [official instructions](https://pytorch.org/get-started/locally/#start-locally) to install the appropriate version.
Texar-PyTorch requires:

After `torch` is installed, please run the following commands to install Texar-PyTorch:
* `python == 3.6` or `3.7`
* `torch >= 1.0.0 (but < 1.3.0)`. Please follow the [official instructions](https://pytorch.org/get-started/locally/#start-locally) to install the appropriate version.

After `torch` is installed, install Texar from PyPI:
```bash
pip install texar-pytorch
```

To use cutting-edge features or develop locally, install from source:
```
git clone https://github.com/asyml/texar-pytorch.git
git clone https://github.com/asyml/texar-pytorch.git
cd texar-pytorch
pip install .
```

To use tensorboard support with `Executor`, please install `tensorboardX` with the following command
To use *tensorboard* support with `Executor`, please install `tensorboardX` with the following command

```commandline
pip install tensorboardX
```


### Getting Started
* [Examples](./examples)
* [Documentation](https://texar-pytorch.readthedocs.io)
Expand Down

0 comments on commit 9cafd4d

Please sign in to comment.