Skip to content
This repository has been archived by the owner on Apr 22, 2022. It is now read-only.

Commit

Permalink
Updating readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
gugarosa committed Jun 9, 2020
1 parent 4fb12f7 commit 1fe1bf3
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@

## Welcome to Textformer.

Text.
Did you ever want to transform text? Are you tired of re-implementing and defining state-of-the-art architectures? If yes, Textformer is the way-to-go! This package provides a straightforward implementation of sequence-to-sequence and transformer-based architectures, fostering all research related to text generation and translation.

Use Textformer if you need a library or wish to:
* 1;
* 2;
* 3;
* 4;

* Create your network;
* Design or use pre-loaded state-of-the-art architectures;
* Mix-and-match encoder and decoders to solve your problem;
* Because it is fun to transform text.

Read the docs at [textformer.readthedocs.io](https://textformer.readthedocs.io).

Expand Down Expand Up @@ -47,14 +48,17 @@ Textformer is based on the following structure, and you should pay attention to
- models
- decoders
- att_bi_gru
- conv
- gru
- lstm
- encoders
- bi_gru
- conv
- gru
- lstm
- layers
- attention
- residual_attention
- att_seq2seq
- conv_seq2seq
- joint_seq2seq
Expand Down
9 changes: 9 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
Welcome to Textformer's documentation!
=================================

Did you ever want to transform text? Are you tired of re-implementing and defining state-of-the-art architectures? If yes, Textformer is the way-to-go! This package provides a straightforward implementation of sequence-to-sequence and transformer-based architectures, fostering all research related to text generation and translation.

Use Textformer if you need a library or wish to:

* Create your network;
* Design or use pre-loaded state-of-the-art architectures;
* Mix-and-match encoder and decoders to solve your problem;
* Because it is fun to transform text.

Textformer is compatible with: **Python 3.6+**.

.. toctree::
Expand Down

0 comments on commit 1fe1bf3

Please sign in to comment.