abdouaziz/wolof

Wolof is a library that you can use to do specific tasks in NLP with the Wolof language e.g. text classification in Wolof , NMT , ASR Library, built on PyTorch and Transformers, for developing state-of-the-art deep learning models on a wide variety of linguistic tasks in wolof. ## Your Library for Wolof Language **Wolof** is a language spoken in Senegal in neighboring countries, many works are written in Wolof or the need to have a tool that allows us to know better this language. **Wolof library** allows us to do several specific tasks in Wolof languages such as text classification, translation, automatic speech recognition. ### Why Wolof library ?: - simple and easy to use - customizable - clean code ## Installation ### Requirements - Python >= 3.6 - Torch - Transformers ### With pip wolof can be installed using pip as follows: ``` pip install wolof ``` ### From source ```py pip install git+github.com ``` ## Usage ```python from wolof import Speech2Text asr = Speech2Text(model_name="abdouaziiz/wav2vec2-xls-r-300m-wolof") audio_file = "audio.wav" prediction = asr(audio_file) ``` # Pipeline The pipelines are a great and easy way to use models for inference. These pipelines are objects that abstract most of the complex code from the library,offering a simple API dedicated to several tasks Masked Language Modeling, Sentiment Analysis . **bert-base-wolof** is pretrained bert-base model on wolof language . **sora-wolof** is pretrained roberta model on wolof language . ## Models in Wolof library | Model name | Number of layers | Attention Heads | Embedding Dimension | Total Parameters | | :------: | :---: | :---: | :---: | :---: | | `bert-base-wolof` | 6 | 12 | 514 | 56931622 M | | `soraberta-base` | 6 | 12 | 514 | 83 M | ## Using Soraberta or BERT-base-wolof Let's use ***`fill_mask`*** for masked language modeling . We mask a word with the token ***`[MASK]`*** in the given input_text and the unmasker predict the right word corresponding to the token ***`[MASK]`*** . ```python >>> from wolof import Pipeline > …