Skip to content

Commit

Permalink
Update DOCS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cociweb authored Jan 6, 2024
1 parent 81ca2f8 commit e27b560
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion custom_whisper/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Increasing the beam size will increase accuracy at the cost of performance.

## Custom model

There is a possibility to add a custom model from a remote folder (from a repository or from a webpage). The folder should contain the `model.bin`, `vocabulary.txt`, `config.json` and `hash.json`. The `hash.json` file should contain the md5sum type hash of the first 3 files in JSON format.
There is a possibility to add a custom model from a remote folder (from a repository or from a webpage). The remote folder of the model should contain the `model.bin`, `vocabulary.txt`, `config.json` and `hash.json`. The `hash.json` file should contain the md5sum type hash of the first 3 files in JSON format.

Eg:
```
Expand All @@ -71,6 +71,9 @@ Eg:

In this case, the `model` field should be `custom`, and add the parent folder url of the model to the `Custom model url` field.

Don't forget to append the `/resolve/{branch}/` at the end of the repository's url. The custom_model_url should look like eg. this:
`https://huggingface.co/Hungarians/whisper-tiny-cv16-v2-int8.hu/resolve/main/`

## Backups

Whisper model files can be quite large, so they are automatically excluded from backups. The models will be re-downloaded when the backup is restored.
Expand Down

0 comments on commit e27b560

Please sign in to comment.