Update README.md

README.md

@@ -1,68 +1,112 @@
 ---
 library_name: peft
-license: apache-2.0
+license: mit
 base_model: openai/whisper-large-v2
 tags:
 - generated_from_trainer
+- ASR
+- Wolof
+- French
+- English
+- Multi-lang
+- Open-Source
+- code-switched
 model-index:
 - name: whosper-large-v3
   results: []
+language:
+- wo
+- fr
+- en
+metrics:
+- cer
+- wer
+pipeline_tag: automatic-speech-recognition
 ---
+# Whosper-large-v3
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
-
-# whosper-large-v3
-
-This model is a fine-tuned version of [openai/whisper-large-v2](https://huggingface.co/openai/whisper-large-v2) on the None dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.4490
-
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
-
-## Training procedure
-
-### Training hyperparameters
-
-The following hyperparameters were used during training:
-- learning_rate: 0.001
-- train_batch_size: 8
-- eval_batch_size: 8
-- seed: 42
-- gradient_accumulation_steps: 4
-- total_train_batch_size: 32
-- optimizer: Use adamw_torch with betas=(0.9,0.999) and epsilon=1e-08 and optimizer_args=No additional optimizer arguments
-- lr_scheduler_type: linear
-- lr_scheduler_warmup_steps: 50
-- num_epochs: 6
-- mixed_precision_training: Native AMP
-
-### Training results
-
-| Training Loss | Epoch  | Step  | Validation Loss |
-|:-------------:|:------:|:-----:|:---------------:|
-| 0.7575        | 0.9998 | 2354  | 0.7068          |
-| 0.6429        | 1.9998 | 4708  | 0.6073          |
-| 0.5468        | 2.9998 | 7062  | 0.5428          |
-| 0.4439        | 3.9998 | 9416  | 0.4935          |
-| 0.3208        | 4.9998 | 11770 | 0.4600          |
-| 0.2394        | 5.9998 | 14124 | 0.4490          |
-
-
-### Framework versions
+---
+library_name: peft
+license: apache-2.0
+base_model: openai/whisper-large-v2
+tags:
+- generated_from_trainer
+- wolof-asr
+- bilingual
+---
 
-- PEFT 0.14.1.dev0
-- Transformers 4.49.0.dev0
-- Pytorch 2.5.1+cu124
-- Datasets 3.2.0
-- Tokenizers 0.21.0
+## Model Overview
+Whosper-large-v3 is a fine-tuned version of [openai/whisper-large-v2](https://huggingface.co/openai/whisper-large-v2) optimized for Wolof and French speech recognition, with improved WER and CER metrics compared to its predecessor.
+
+## Performance Metrics
+- **Loss**: 0.4490 (final)
+- **WER (Word Error Rate)**: 0.2409
+- **CER (Character Error Rate)**: 0.1128
+- **Average Inference Time**: 1.8298s
+- **Success Rate**: 100%
+
+## Key Features
+- Improved WER and CER compared to whosper-large
+- Optimized for Wolof and French recognition
+- Enhanced performance on bilingual content
+
+## Limitations
+- Reduced performance on English compared to whosper-large
+- Less effective for general multilingual content
+
+## Training Data
+Combined dataset including:
+- ALFFA Public Dataset
+- FLEURS Dataset
+- Bus Urbain Dataset
+- Anta Women TTS Dataset
+
+## Training Procedure
+
+### Training Hyperparameters
+```yaml
+learning_rate: 0.001
+train_batch_size: 8
+eval_batch_size: 8
+seed: 42
+gradient_accumulation_steps: 4
+total_train_batch_size: 32
+optimizer: adamw_torch (betas=0.9,0.999, epsilon=1e-08)
+lr_scheduler_type: linear
+lr_scheduler_warmup_steps: 50
+num_epochs: 6
+mixed_precision_training: Native AMP
+```
+
+### Training Results
+| Training Loss | Epoch | Step | Validation Loss |
+|:-------------:|:-----:|:----:|:---------------:|
+| 0.7575 | 0.9998 | 2354 | 0.7068 |
+| 0.6429 | 1.9998 | 4708 | 0.6073 |
+| 0.5468 | 2.9998 | 7062 | 0.5428 |
+| 0.4439 | 3.9998 | 9416 | 0.4935 |
+| 0.3208 | 4.9998 | 11770 | 0.4600 |
+| 0.2394 | 5.9998 | 14124 | 0.4490 |
+
+## Framework Versions
+- PEFT: 0.14.1.dev0
+- Transformers: 4.49.0.dev0
+- PyTorch: 2.5.1+cu124
+- Datasets: 3.2.0
+- Tokenizers: 0.21.0
+
+## License
+Apache-2.0
+
+## Citation
+```bibtex
+@misc{whosper2025,
+  title={Whosper-large-v3: An Enhanced ASR Model for Wolof and French},
+  author={Caytu Robotics AI Department},
+  year={2025},
+  publisher={Caytu Robotics}
+}
+```
+
+## Acknowledgments
+This model is developed by the AI Department at Caytu Robotics. It builds upon the OpenAI Whisper Large V2 model.