ylacombe HF staff commited on
Commit
c0afa37
1 Parent(s): a733a7e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -3
README.md CHANGED
@@ -37,6 +37,8 @@ It was trained on speech data, which makes it particularly adapted to train spee
37
 
38
  ## How to Get Started with the Model
39
 
 
 
40
  Use the following code to get started with the Mimi model using a dummy example from the LibriSpeech dataset (~9MB). First, install the required Python packages:
41
 
42
  ```
@@ -73,6 +75,10 @@ audio_values = model.decode(encoder_outputs.audio_codes)[0]
73
  audio_values = model(inputs["input_values"]).audio_values
74
  ```
75
 
 
 
 
 
76
  ### Direct Use
77
 
78
  Mimi can be used directly as an audio codec for real-time compression and decompression of speech signals.
@@ -86,9 +92,6 @@ The model is not intended to be used to impersonate other people or any maliciou
86
 
87
  The model has been trained with a few safeguards to try to limit potential toxic usages, however our toxicity analysis shows that it behaves in the middle of existing models with respect to textual generation. It has some bias towards certain domains and topics that are over-represented in the training data. Its capabilities are relatively limited so far and it is trained to produce only one voice to avoid impersonation. Yet, we need the perspective in time to establish the sociotechnical limitations.
88
 
89
- ## How to Get Started with the Model
90
-
91
- See the main [README](https://github.com/kyutai-labs/moshi) file.
92
 
93
  ## Training Details
94
 
 
37
 
38
  ## How to Get Started with the Model
39
 
40
+ ### Usage with `transformers`
41
+
42
  Use the following code to get started with the Mimi model using a dummy example from the LibriSpeech dataset (~9MB). First, install the required Python packages:
43
 
44
  ```
 
75
  audio_values = model(inputs["input_values"]).audio_values
76
  ```
77
 
78
+ ### Usage with Moshi
79
+
80
+ See the main [README](https://github.com/kyutai-labs/moshi) file.
81
+
82
  ### Direct Use
83
 
84
  Mimi can be used directly as an audio codec for real-time compression and decompression of speech signals.
 
92
 
93
  The model has been trained with a few safeguards to try to limit potential toxic usages, however our toxicity analysis shows that it behaves in the middle of existing models with respect to textual generation. It has some bias towards certain domains and topics that are over-represented in the training data. Its capabilities are relatively limited so far and it is trained to produce only one voice to avoid impersonation. Yet, we need the perspective in time to establish the sociotechnical limitations.
94
 
 
 
 
95
 
96
  ## Training Details
97