Examples
Hello world
The raw
command allows to specify custom text.
Setting a target speed
One can set a target speed via the flag -t, --target-wpm
.
This speed will be interactively shown with a new cursor. One
can use it with the following commands
file
random
raw
replay
sample
Competing against yourself
The command replay
can be used for playing against
a past performance. All of the below commands support
the flag -o, --output-file
that will store a single
performance to a file.
file
random
raw
sample
This file can then be provided as an argument to replay
.
The previous performance will be marked by an additional
cursor.
If me manage to be faster than our previous performance,
the file is not going to be overwritten by default. However, one
can allow for overwriting via the -w, --overwrite
flag. Note that the file will be only overwritten
if we improve. If we use this flag we essentially always
compete against our all time best and each new record will
lead to an update.
Selecting top k characters
The sample
command is using a neural network in the
background. The characters are generated one by one
based on some probability distribution over all
possible characters (vocabulary). One can use the
option -k, --top-k
to only sample from the
most k probable characters. In general, the lower
the k the more conservative the next character
predictions are.
Provide initial text for sampling
The sample
provides an option -s, --starting-text
through which one can specify the starting text. This
way one can decide roughly on the topic of the text.
Independent generation of characters
The random
command allows for generating of random
characters based on provided frequency distribution. Note
that as opposed to sample
the previous characters
are not taken into account when generating a new one.
Reading from a file with whitespace
Text files often contain a lot of whitespace characters (new lines, tabs,…).
One can use the command file
to read from a file and the option
-w, --include-whitespace
option to control whether whitespace is
going to be removed or not.