Skip to content

Commit a803bf4

Browse files
committed
Add to neural_gpu documentation.
* Switch from decimal to symbol in most places and add a description of what a symbol is per Lukasz.
1 parent b1ad92b commit a803bf4

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

neural_gpu/README.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,30 @@ Requirements:
88

99
The model can be trained on the following algorithmic tasks:
1010

11-
* `sort` - Sort a decimal list
12-
* `kvsort` - Sort decimal keys in dictionary
13-
* `id` - Return the same decimal list
14-
* `rev` - Reverse a decimal list
15-
* `rev2` - Reverse a decimal dictionary by key
16-
* `incr` - Add one to a decimal
11+
* `sort` - Sort a symbol list
12+
* `kvsort` - Sort symbol keys in dictionary
13+
* `id` - Return the same symbol list
14+
* `rev` - Reverse a symbol list
15+
* `rev2` - Reverse a symbol dictionary by key
16+
* `incr` - Add one to a symbol value
1717
* `add` - Long decimal addition
18-
* `left` - First decimal in list
19-
* `right` - Last decimal in list
20-
* `left-shift` - Left shift a decimal list
21-
* `right-shift` - Right shift a decimal list
18+
* `left` - First symbol in list
19+
* `right` - Last symbol in list
20+
* `left-shift` - Left shift a symbol list
21+
* `right-shift` - Right shift a symbol list
2222
* `bmul` - Long binary multiplication
2323
* `mul` - Long decimal multiplication
24-
* `dup` - Duplicate a decimal list with padding
24+
* `dup` - Duplicate a symbol list with padding
2525
* `badd` - Long binary addition
2626
* `qadd` - Long quaternary addition
27-
* `search` - Search for decimal key in dictionary
27+
* `search` - Search for symbol key in dictionary
28+
29+
The value range for symbols are defined by the `niclass` and `noclass` flags.
30+
In particular, the values are in the range `min(--niclass, noclass) - 1`.
31+
So if you set `--niclass=33` and `--noclass=33` (the default) then `--task=rev`
32+
will be reversing lists of 32 symbols, and `--task=id` will be identity on a
33+
list of up to 32 symbols.
34+
2835

2936
To train the model on the reverse task run:
3037

0 commit comments

Comments
 (0)