Skip to content

Commit

Permalink
Add FAQ section
Browse files Browse the repository at this point in the history
  • Loading branch information
baudm authored Aug 9, 2022
1 parent 85e0326 commit 1627112
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
Electrical and Electronics Engineering Institute<br/>
University of the Philippines, Diliman

[Method](#method-tldr) | [Sample Results](#sample-results) | [Getting Started](#getting-started) | [Training](#training) | [Evaluation](#evaluation) | [Citation](#citation)
[Method](#method-tldr) | [Sample Results](#sample-results) | [Getting Started](#getting-started) | [FAQ](#frequently-asked-questions) | [Training](#training) | [Evaluation](#evaluation) | [Citation](#citation)

</div>

Expand Down Expand Up @@ -46,7 +46,6 @@ A single Transformer can realize different models by merely varying its attentio
**NOTE:** _Bold letters and underscores indicate wrong and missing character predictions, respectively._
</div>


## Getting Started
This repository contains the reference implementation for PARSeq and reproduced models (collectively referred to as _Scene Text Recognition Model Hub_). See `NOTICE` for copyright information.
Majority of the code is licensed under the Apache License v2.0 (see `LICENSE`) while ABINet and CRNN sources are
Expand Down Expand Up @@ -90,6 +89,12 @@ label, confidence = parseq.tokenizer.decode(pred)
print('Decoded label = {}'.format(label[0]))
```

## Frequently Asked Questions
- How do I train on a new language? See Issues [#5](https://github.com/baudm/parseq/issues/5) and [#9](https://github.com/baudm/parseq/issues/9).
- How to finetune or create custom dataset? See Issue [#7](https://github.com/baudm/parseq/issues/7).
- What is `val_NED`? See Issue [#10](https://github.com/baudm/parseq/issues/10).
- Can you export to TorchScript or ONNX? See Issue [#12](https://github.com/baudm/parseq/issues/12).

## Training
The training script can train any supported model. You can override any configuration using the command line. Please refer to [Hydra](https://hydra.cc) docs for more info about the syntax. Use `./train.py --help` to see the default configuration.
```bash
Expand Down

0 comments on commit 1627112

Please sign in to comment.