Skip to content

Commit e3f46a9

Browse files
committed
Update README.md
1 parent 507932c commit e3f46a9

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
With the design goals of **modularity, versatility, and extensibility** in mind, Texar extracts the common patterns underlying the diverse tasks and methodologies, creates a library of highly reusable modules and functionalities, and facilitates **arbitrary model architectures and algorithmic paradigms**, e.g.,
1919
* encoder(s) to decoder(s), sequential- and self-attentions, memory, hierarchical models, classifiers, ...
2020
* maximum likelihood learning, reinforcement learning, adversarial learning, probabilistic modeling, ...
21-
* **pretrained models** such as **BERT**, **GPT2**, **XLNet**, ...
21+
* **pre-trained models** such as **BERT**, **GPT2**, **XLNet**, ...
2222

23-
With Texar, cutting-edge complex models can be easily constructed, freely enriched with best modeling/training practices, readily fitted into standard training/evaluation pipelines, and fastly experimented and evolved by, e.g., plugging-in and swapping-out different modules.
23+
With Texar, cutting-edge complex models can be easily constructed, freely enriched with best modeling/training practices, readily fitted into standard training/evaluation pipelines, and quickly experimented and evolved by, e.g., plugging in and swapping out different modules.
2424

2525
<div align="center">
2626
<img src="https://zhitinghu.github.io/texar_web/images/texar_stack.png"><br><br>
@@ -29,8 +29,8 @@ With Texar, cutting-edge complex models can be easily constructed, freely enrich
2929

3030
### Key Features
3131
* **Versatility**. Texar contains a wide range of modules and functionalities for composing arbitrary model architectures and implementing various learning algorithms, as well as for data processing, evaluation, prediction, etc.
32-
* **Modularity**. Texar decomposes diverse complex machine learning models/algorithms into a set of highly-reusable modules. In particular, model **architecture, losses, and learning processes** are fully decomposed.
33-
Users can construct their own models at a high conceptual level just like assembling building blocks. It is convenient to plug-ins or swap-out modules, and configure rich options of each module. For example, switching between maximum likelihood learning and reinforcement learning involves only changing several lines of code.
32+
* **Modularity**. Texar decomposes diverse, complex machine learning models and algorithms into a set of highly-reusable modules. In particular, model **architecture, losses, and learning processes** are fully decomposed.
33+
Users can construct their own models at a high conceptual level, just like assembling building blocks. It is convenient to plug in or swap out modules, and configure rich options for each module. For example, switching between maximum-likelihood learning and reinforcement learning involves only changing several lines of code.
3434
* **Extensibility**. It is straightforward to integrate any user-customized, external modules. Also, Texar is fully compatible with the native PyTorch interfaces and can take advantage of the rich PyTorch features, and resources from the vibrant open-source community.
3535
* Interfaces with different functionality levels. Users can customize a model through 1) simple **Python/YAML configuration files** of provided model templates/examples; 2) programming with **Python Library APIs** for maximal customizability.
3636
* Easy-to-use APIs; rich configuration options for each module, all with default values.
@@ -85,10 +85,13 @@ for batch in iterator:
8585
loss = model(batch)
8686
# ...
8787
```
88-
Many more examples are available [here](./examples)
88+
Many more examples are available [here](./examples).
8989

9090

9191
### Installation
92+
Texar-PyTorch requires PyTorch 1.0 or higher. Please follow the [official instructions](https://pytorch.org/get-started/locally/#start-locally) to install the appropriate version.
93+
94+
After PyTorch is installed, please run the following commands to install Texar-PyTorch:
9295
```
9396
git clone https://github.com/asyml/texar-pytorch.git
9497
cd texar-pytorch

0 commit comments

Comments
 (0)