lxsameer
/
Orion
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update the docs

This commit is contained in:
Sameer Rahmani 2022-04-15 23:35:33 +01:00
parent 69bb419ac7
commit 0cc687b6a4
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,3 +1,22 @@
# Orion
Orion is a telegram bot that converts voice messages into text and org-mode files. It can be trained for better accuracy.
Orion is a telegram bot that converts voice messages into text and org-mode files.
It can be trained for better accuracy.
In order to use it, first you need to setup the project which you can just call
`./builder setup` and then you can run Orion via the builder script again with the
following command:
```bash
./builder run -owner TELEGRAM_ID -model PATH_TO_MODEL -scorer PATH_TO_SCORER
```
* *TELEGRAM_ID*: Is your telegram id. It will only reply to you and tell others
to F off.
* *PATH_TO_MODEL(optoinal)*: Is the path to the model file you want to use for speech recognition.
the default points to the default model in the models directory.
* *PATH_TO_SCORER(optional)*: Is the path to the scorer to be use to speech recognition.
the default points to the default scorer in the models directory.
Models and scorers should be compatible with [Coqui](https://coqui.ai/).