Skip to content

Commit

Permalink
updated readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
fquirin committed Jul 10, 2022
1 parent 5d0842a commit 475a936
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,11 @@ After the download is finished you can start the container like this:
sudo docker run --rm --name=sepia-stt -p 20741:20741 -it sepia/stt-server:latest
```

### Test via web interface
### Test via web interface or Python client

To test the server visit: `http://localhost:20741` if you are on the same machine or `http://[server-IP]:20741` if you are in the same network (NOTE: custom recordings via microphone will only work using localhost or a HTTPS URL!).
To test the server visit: `http://localhost:20741` if you are on the same machine or `http://[server-IP]:20741` if you are in the same network (NOTE: custom recordings via microphone will only work using localhost or a HTTPS URL!).

Alternatively you can use the [python-client](python-client) to test your server.

### Models

Expand Down Expand Up @@ -107,10 +109,12 @@ and thus the link to your server must be secure as well (e.g. use a real domain

## Develop your own Client

See the separate [API docs](API.md) file or check out the [Javascript client class](src/www/audio-modules/shared/sepia-stt-socket-client.js) and the [test page](src/www/test-page.html) source-code.
See the separate [API docs](API.md) file or check out the [Javascript client class](src/www/audio-modules/shared/sepia-stt-socket-client.js), the [HTML test page](src/www/test-page.html)
or the [python-client](python-client/example.py) source-code.

Demo clients:
- Server test page(s): `http://localhost:20741` (with microphone) or `http://[server-IP]:20741` (no microphone due to "insecure" origin)
- Python client: `[python-client](python-client)`
- [SEPIA Client app](https://sepia-framework.github.io/app/) (v0.24+, simply skip the login, go to settings and enter your server URL)

## Using Customized ASR Models
Expand Down
8 changes: 5 additions & 3 deletions python-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ Check-out [example.py](example.py) for a simple demo.

- Make sure you have a STT-Server running somewhere (in your network), default: `http://localhost:20741`
- Get the `python-client` folder from this repository
- Install requirements: `pip install requirements_client.txt`
- Install requirements: `pip install -r requirements_client.txt`
- Make sure your microphone is connected
- Run the demo: `python example.py --server "http://localhost:20741"` or check the options `python example.py -h`
- If the connection to the server works you should see some info messages and a READY event
- Press and hold 'r' to record audio and watch the transcription appear on the screen :-)
- If the connection to the server works you should see some info messages and a READY event appearing after a short time
- After the ready event press and hold 'r' to record audio and watch the transcription appear on the screen :-)

You can use the info messages on the screen to get valid options for 'language', 'task', 'model' and more.

## Contribute

Expand Down

0 comments on commit 475a936

Please sign in to comment.