royf commited on
Commit
0aa3d5a
·
verified ·
1 Parent(s): 086e2ec

Upload folder using huggingface_hub

Browse files
Files changed (3) hide show
  1. README.md +14 -88
  2. config.json +13 -0
  3. weights.safetensors +3 -0
README.md CHANGED
@@ -1,94 +1,20 @@
1
  ---
2
- library_name: transformers
3
- license: apache-2.0
4
- datasets:
5
- - ivrit-ai/crowd-transcribe-v5
6
- - ivrit-ai/crowd-recital-whisper-training
7
- - ivrit-ai/knesset-plenums-whisper-training
8
- language:
9
- - he
10
- metrics:
11
- - wer
12
- base_model:
13
- - openai/whisper-large-v3
14
- pipeline_tag: automatic-speech-recognition
15
- tags:
16
- - mlx
17
  ---
18
 
19
- # Model Card for Model ID
 
20
 
21
- This model is a Hebrew finetune (continued training) of the OpenAI Whisper Large v3 model.
 
 
 
22
 
 
 
23
 
24
- ## Model Details
25
-
26
- ### Model Description
27
-
28
- - **Developed by:** ivrit-ai
29
- - **Language(s) (NLP):** Hebrew
30
- - **License:** Apache-2.0
31
- - **Finetuned from model** openai/whisper-large-v3
32
- - **Training Date** Apr 2025
33
-
34
- ## Bias, Risks, and Limitations
35
-
36
- Language detection capability of this model has been degraded during training - it is intended for mostly-hebrew audio transcription.
37
- Language token should be explicitly set to Hebrew.
38
-
39
- Additionally, the tanslation task was not trained and also degraded. This model would not be able to translate in any reasonable capacity.
40
-
41
- ## How to Get Started with the Model
42
-
43
- Please follow the original [model card](https://huggingface.co/openai/whisper-large-v3#usage) for usage details - replacing with this model name.
44
- You can also fine other weight formats ad quantizations on the [ivrit ai](https://huggingface.co/ivrit-ai) HF page.
45
-
46
- We created some simple example scripts using this model and weights for other inference runtimes.
47
- Find those in the ["examples"](https://github.com/ivrit-ai/asr-training/tree/master/examples) folder within the training GitHub repo.
48
-
49
- ## Training Details
50
-
51
- ### Training Data
52
-
53
- This model was trained on the following datasets:
54
-
55
- - [ivrit-ai/crowd-transcribe-v5](https://huggingface.co/datasets/ivrit-ai/crowd-transcribe-v5) - Publicly accessible audio sources have been crowd-transcribed segment-by-segment - ~300h
56
- - [ivrit-ai/crowd-recital-whisper-training](https://huggingface.co/datasets/ivrit-ai/crowd-recital-whisper-training) - Crowd-sourced recording of Wikipedia article snippets. ~50h
57
- - [ivrit-ai/knesset-plenums-whisper-training](https://huggingface.co/datasets/ivrit-ai/knesset-plenums-whisper-training) - A subset of a Knesset (Israeli house of representatives) plenum protocols. ~4700h
58
-
59
- ### Training Procedure
60
-
61
- This model was trained in two main phases:
62
- - Knesset based pre-training - over all ~4700h of data - 3 epochs, ~54h run
63
- - Mixed post-training over all crowd-transcribe-v5 (300h), crowd-recital-whisper-training (50h) and highest-quality filtered knessets data (150h) - 1 epoch
64
- - Interleaving of datasets with sampling probs: (0.9, 0.025, 0.075) respectively
65
- - Note that crowd-transcribe-v5 has about 5x shorter samples on average thus the over-sampling.
66
-
67
- This model is a weighted-average of the 3 lowest eval loss checkpoints from the same training run.
68
- Training code can be found on the ivrit-ai Github [here](https://github.com/ivrit-ai/asr-training)
69
-
70
- #### Preprocessing
71
-
72
- The "Crowd Recital" and "Knesset" datasets contain timestamps and previous text following the Whisper expected inputs.
73
- Timestamps were used from 40% of samples from those datasets, and 50% of the previous text was used.
74
-
75
- The "Crowd Transcribe" datasets has no timestamps or previous text and this preprocessing only included melspec feature extraction and text encoding.
76
-
77
- Preprocessing code can be found within the training code [repository](https://github.com/ivrit-ai/asr-training).
78
-
79
- Datasets were interleaved with 0.15:0.8:0.05 ratio (knesset:crowd-transcribe:crowd-recital).
80
-
81
- #### Training Hyperparameters
82
-
83
- - **Training regime:** bf16 mixed precision with sdpa
84
- - **Learning Rate:** 1e-5, Linear decay, 800 steps warmup for 3 epochs
85
- - **Batch Size:** 32
86
-
87
- #### Training Hardware / Duration
88
-
89
- - **GPU Type:** 8 x Nvidia A40 machine
90
- - **Duration:** ~60 run across both phases
91
-
92
- ## Evaluation
93
-
94
- Please refer to the [ivrit-ai/hebrew-transcription-leaderboard](https://huggingface.co/spaces/ivrit-ai/hebrew-transcription-leaderboard)
 
1
  ---
2
+ library_name: mlx
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  ---
4
 
5
+ # ivrit-ai-whisper-large-v3-mlx
6
+ This model was converted to MLX format from [`ivrit-ai/whisper-large-v3`]().
7
 
8
+ ## Use with mlx
9
+ ```bash
10
+ pip install mlx-whisper
11
+ ```
12
 
13
+ ```python
14
+ import mlx_whisper
15
 
16
+ result = mlx_whisper.transcribe(
17
+ "FILE_NAME",
18
+ path_or_hf_repo=mlx-community/ivrit-ai-whisper-large-v3-mlx,
19
+ )
20
+ ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
config.json ADDED
@@ -0,0 +1,13 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "n_mels": 128,
3
+ "n_audio_ctx": 1500,
4
+ "n_audio_state": 1280,
5
+ "n_audio_head": 20,
6
+ "n_audio_layer": 32,
7
+ "n_vocab": 51866,
8
+ "n_text_ctx": 448,
9
+ "n_text_state": 1280,
10
+ "n_text_head": 20,
11
+ "n_text_layer": 32,
12
+ "model_type": "whisper"
13
+ }
weights.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:c7b9d7b9df7cb669101a3b166f6b37bcfb3dbe1f20b74e8b6e2867019472ab93
3
+ size 3083275629