Skip to content

Commit

Permalink
add warning about tuning to README (#19)
Browse files Browse the repository at this point in the history
* add warning about tuning to readme

* don't line wrap

Co-authored-by: Patrick O'Neill <patrick.oneill@kensho.com>
  • Loading branch information
poneill and Patrick O'Neill authored Jul 13, 2021
1 parent 0cfad12 commit 50fd623
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,13 @@ text = decoder.decode(
)
```

_(Note: the pyctcdecode decoder contains several free hyperparameters
that can strongly influence error rate and wall time. Default values
for these parameters were (merely) chosen in order to yield good
performance for one particular use case. For best results, especially
when working with languages other than English, users are encouraged
to perform a hyperparameter optimization study on their own data.)_

Batch support via multiprocessing:

``` python
Expand Down

0 comments on commit 50fd623

Please sign in to comment.