From 4e56061ceffe640720a2e2c0310b47dfc6da19fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandre=20D=C3=A9fossez?= Date: Thu, 19 Sep 2024 15:20:13 +0200 Subject: [PATCH] doc --- README.md | 8 ++++---- moshi_mlx/README.md | 9 ++++----- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6ad8e51..9532d88 100644 --- a/README.md +++ b/README.md @@ -77,12 +77,12 @@ All models are released under the CC-BY 4.0 license. ## Requirements -You will need at least Python 3.10. For specific requirements, please check the individual backends +You will need at least Python 3.10, with 3.12 recommended. For specific requirements, please check the individual backends directories. You can install the PyTorch and MLX clients with the following: ```bash pip install moshi # moshi PyTorch, from PyPI -pip install moshi_mlx # moshi MLX, from PyPI +pip install moshi_mlx # moshi MLX, from PyPI, best with Python 3.12. # Or the bleeding edge versions for Moshi and Moshi-MLX. pip install -e "git+https://git@github.com/kyutai-labs/moshi.git#egg=moshi&subdirectory=moshi" pip install -e "git+https://git@github.com/kyutai-labs/moshi.git#egg=moshi_mlx&subdirectory=moshi_mlx" @@ -90,8 +90,8 @@ pip install -e "git+https://git@github.com/kyutai-labs/moshi.git#egg=moshi_mlx&s pip install rustymimi # mimi, rust implementation with Python bindings from PyPI ``` -If you get an error when installing `moshi_mlx` or `rustymimi` (which `moshi_mlx` depends on), -you might need to install the [Rust toolchain](https://rustup.rs/) to install `rustymimi` from sources. +If you are not using Python 3.12, you might get an error when installing +`moshi_mlx` or `rustymimi` (which `moshi_mlx` depends on). Then,you will need to install the [Rust toolchain](https://rustup.rs/), or switch to Python 3.12. While we hope that the present codebase will work on Windows, we do not provide official support for it. We have tested the MLX version on a MacBook Pro M3. At the moment, we do not support quantization diff --git a/moshi_mlx/README.md b/moshi_mlx/README.md index 832ac0d..b6d8057 100644 --- a/moshi_mlx/README.md +++ b/moshi_mlx/README.md @@ -10,18 +10,17 @@ This is the MLX implementation for Moshi. For Mimi, this uses our Rust based imp ## Requirements -You will need at least Python 3.10. +You will need at least Python 3.10, we recommend Python 3.12. ```bash -pip install moshi_mlx # moshi MLX, from PyPI +pip install moshi_mlx # moshi MLX, from PyPI, best with Python 3.12. # Or the bleeding edge versions for Moshi and Moshi-MLX. pip install -e "git+https://git@github.com/kyutai-labs/moshi#egg=moshi_mlx&subdirectory=moshi_mlx" ``` We have tested the MLX version with MacBook Pro M3. -If you get an error when installing `moshi_mlx` or `rustymimi` (which `moshi_mlx` depends on), -you might need to install the [Rust toolchain](https://rustup.rs/) to install `rustymimi` from sources. - +If you are not using Python 3.12, you might get an error when installing +`moshi_mlx` or `rustymimi` (which `moshi_mlx` depends on). Then,you will need to install the [Rust toolchain](https://rustup.rs/), or switch to Python 3.12. ## Usage