Skip to content

Contributing

Thank you for your interest in contributing to MLX Audio! This section covers everything you need to get started.

Where to Start

  • Dev Setup

    Clone the repo, install dependencies, run tests, and set up your development environment.

    Dev Setup

  • Adding a Model

    Step-by-step guide for adding a new TTS or STT model to the library.

    Adding a Model

  • Architecture

    High-level overview of the codebase structure, module layout, and design patterns.

    Architecture

Guidelines

  • Open an issue first for large changes or new models so the maintainers can discuss the approach.
  • Write tests for new functionality where practical.
  • Follow existing code style -- the project uses Black for formatting.
  • Keep PRs focused -- one feature or fix per pull request.
  • Update documentation when adding user-facing features.

License

MLX Audio is released under the MIT License. By contributing, you agree that your contributions will be licensed under the same terms.