Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
adefossez committed Sep 18, 2024
1 parent 50edf17 commit d0e0a60
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
3 changes: 2 additions & 1 deletion moshi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ You can use `--gradio-tunnel-token` to set a fixed secret token and reuse the sa
Alternatively, you might want to use SSH to redirect your connection.

You can use `--hf-repo` to select a different pretrained model, by setting the proper Hugging Face repository.
See [the model list](https://github.com/kyutai-labs/moshi?tab=readme-ov-file#models) for a reference of the available models.

Accessing a server that is not localhost via http may cause issues with using
the microphone in the web UI (in some browsers this is only allowed using
Expand All @@ -57,7 +58,7 @@ However note, that unlike the web browser, this client is barebone. It does not
nor does it try to compensate for a growing lag by skipping frames.


## API - Mimi
## API

You can use programmatically the Mimi/Moshi as follows:
```python
Expand Down
11 changes: 9 additions & 2 deletions moshi_mlx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,22 @@ We have tested the MLX version with MacBook Pro M3.
## Usage


Then the model can be run with:
Once you have installed `moshi_mlx`, you can run
```bash
python -m moshi_mlx.local -q 4 # weights quantized to 4 bits
python -m moshi_mlx.local -q 8 # weights quantized to 8 bits
# And using a different pretrained model:
python -m moshi_mlx.local -q 4 --hf-repo kmhf/moshika-mlx-q4
python -m moshi_mlx.local -q 8 --hf-repo kmhf/moshika-mlx-q8
# be careful to always match the `-q` and `--hf-repo` flag.
```

This uses a command line interface, which is barebone. It does not perform any echo cancellation,
nor does it try to compensate for a growing lag by skipping frames.

You can use `--hf-repo` to select a different pretrained model, by setting the proper Hugging Face repository.
See [the model list](https://github.com/kyutai-labs/moshi?tab=readme-ov-file#models) for a reference of the available models.

Alternatively you can use `python -m moshi_mlx.local_web` to use
the web UI, the connection is via http, at [localhost:8998](http://localhost:8998).

Expand All @@ -47,7 +54,7 @@ If you use either Mimi or Moshi, please cite the following paper,
```
@article{defossez2024moshi,
title={Moshi: a speech-text foundation model for real-time dialogue},
author={Alexandre Défossez and Laurent Mazaré and Manu Orsini and Amélie Royer and
author={Alexandre Défossez and Laurent Mazaré and Manu Orsini and Amélie Royer and
Patrick Pérez and Hervé Jégou and Edouard Grave and Neil Zeghidour},
journal={arXiv:TBC},
year={2024},
Expand Down

0 comments on commit d0e0a60

Please sign in to comment.