Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ZJaume committed Nov 13, 2024
1 parent ddf32f1 commit 00b0bc2
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Install it in your environment
pip install heliport
```

NOTE: Since version 0.8 models do not need to be downloaded anymore.

### From source
Install the requirements:
- Python
Expand Down Expand Up @@ -50,16 +52,27 @@ Arguments:
[OUTPUT_FILE] Output file, default: stdout
Options:
-j, --threads <THREADS> Number of parallel threads to use.
0 means no multi-threading
1 means running the identification in a separated thread
>1 run multithreading [default: 0]
-b, --batch-size <BATCH_SIZE> Number of text segments to pre-load for parallel processing [default: 100000]
-c, --ignore-confidence Ignore confidence thresholds. Predictions under the thresholds will not be labeled as 'und'
-s, --print-scores Print confidence score (higher is better) or raw score (higher is better) in case '-c' is provided
-m, --model-dir <MODEL_DIR> Model directory containing binarized model or plain text model. Default is Python module path or './LanguageModels' if relevant languages are requested
-l, --relevant-langs <RELEVANT_LANGS> Load only relevant languages. Specify a comma-separated list of language codes. Needs plain text model directory
-h, --help Print help
-j, --threads <THREADS>
Number of parallel threads to use.
0 means no multi-threading
1 means running the identification in a separated thread
>1 run multithreading [default: 0]
-b, --batch-size <BATCH_SIZE>
Number of text segments to pre-load for parallel processing [default: 100000]
-c, --ignore-confidence
Ignore confidence thresholds. Predictions under the thresholds will not be
labeled as 'und'
-s, --print-scores
Print confidence score (higher is better) or raw score (higher is better) in case
'-c' is provided
-m, --model-dir <MODEL_DIR>
Model directory containing binarized model or plain text model. Default is Python
module path or './LanguageModels' if relevant languages are requested
-l, --relevant-langs <RELEVANT_LANGS>
Load only relevant languages. Specify a comma-separated list of language codes.
Needs plain text model directory
-h, --help
Print help
```

### Python package
Expand Down

0 comments on commit 00b0bc2

Please sign in to comment.