Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
adefossez committed Sep 19, 2024
1 parent e9c5353 commit 4e56061
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,21 +77,21 @@ 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://[email protected]/kyutai-labs/moshi.git#egg=moshi&subdirectory=moshi"
pip install -e "git+https://[email protected]/kyutai-labs/moshi.git#egg=moshi_mlx&subdirectory=moshi_mlx"

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
Expand Down
9 changes: 4 additions & 5 deletions moshi_mlx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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://[email protected]/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

Expand Down

0 comments on commit 4e56061

Please sign in to comment.