xares-audio-encoder-template

This repository provides a template for creating audio encoders compatible with X-ARES and XARES-LLM. Your encoder should process raw audio waveforms and generate meaningful audio embeddings.

Steps to create your own audio encoder

1. Install dependencies

   pip install -r requirements.txt
   

2. Make a copy of template.py.

   cp template.py my_encoder.py
   

3. Edit the newly created file to implement your own audio encoder.

4. Check your encoder to make sure it is compatible with X-ARES.

   >>> from audio_encoder_checker import check_audio_encoder
   >>> from my_encoder import MyEncoder
   
   >>> encoder = MyEncoder()
   
   >>> check_audio_encoder(encoder)
   # No errors! All good!