2022-04-09 18:14:29 +01:00
|
|
|
# Orion
|
|
|
|
|
|
2022-04-15 23:35:33 +01:00
|
|
|
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
|
2022-04-16 11:56:00 +01:00
|
|
|
./builder run -owner TELEGRAM_ID -org-file ORG_FILE_PATH -model PATH_TO_MODEL -scorer PATH_TO_SCORER
|
2022-04-15 23:35:33 +01:00
|
|
|
```
|
2022-04-15 23:38:29 +01:00
|
|
|
* **TELEGRAM_ID**: Is your telegram id. It will only reply to you and tell others
|
2022-04-15 23:35:33 +01:00
|
|
|
to F off.
|
|
|
|
|
|
2022-04-16 11:56:00 +01:00
|
|
|
* **ORG_FILE_PATH**: Path to an `org-mode` file that **HAS TO EXIST**. Orion will append entries
|
|
|
|
|
to this file.
|
2022-04-15 23:38:29 +01:00
|
|
|
* **PATH_TO_MODEL(optoinal)**: Is the path to the model file you want to use for speech recognition.
|
2022-04-15 23:35:33 +01:00
|
|
|
the default points to the default model in the models directory.
|
|
|
|
|
|
2022-04-15 23:38:29 +01:00
|
|
|
* **PATH_TO_SCORER(optional)**: Is the path to the scorer to be use to speech recognition.
|
2022-04-15 23:35:33 +01:00
|
|
|
the default points to the default scorer in the models directory.
|
|
|
|
|
|
|
|
|
|
Models and scorers should be compatible with [Coqui](https://coqui.ai/).
|
