-
Notifications
You must be signed in to change notification settings - Fork 258
docs(ifr): add documentation for moshi #3924
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
0dadcce
feat(ifr): add moshi related documentation
bmarzelleau ea35863
Fix missing `|` in ai-data/managed-inference/reference-content/moshik…
bmarzelleau 31a9fed
Add posted date to moshika-0.1-8b.mdx
bmarzelleau a1f06b4
Add missing `|` in moshiko-0.1-8b.mdx
bmarzelleau a2ee16a
Update ai-data/managed-inference/reference-content/moshika-0.1-8b.mdx
bene2k1 97d3b92
Update ai-data/managed-inference/reference-content/moshiko-0.1-8b.mdx
bene2k1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
87 changes: 87 additions & 0 deletions
87
ai-data/managed-inference/reference-content/moshika-0.1-8b.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| --- | ||
| meta: | ||
| title: Understanding the Moshika-0.1-8b model | ||
| description: Deploy your own secure Moshika-0.1-8b model with Scaleway Managed Inference. Privacy-focused, fully managed. | ||
| content: | ||
| h1: Understanding the Moshika-0.1-8b model | ||
| paragraph: This page provides information on the Moshika-0.1-8b model | ||
| tags: | ||
| dates: | ||
| validation: 2024-10-30 | ||
| posted: 2024-10-30 | ||
| categories: | ||
| - ai-data | ||
| --- | ||
|
|
||
| ## Model overview | ||
|
|
||
| | Attribute | Details | | ||
| |-----------------|------------------------------------| | ||
| | Provider | [Kyutai](https://github.com/kyutai-labs/moshi) | | ||
| | Compatible Instances | L4, H100 (FP8, BF16) | | ||
| | Context size | 4096 tokens | | ||
|
|
||
| ## Model names | ||
|
|
||
| ```bash | ||
| kyutai/moshika-0.1-8b:bf16 | ||
| kyutai/moshika-0.1-8b:fp8 | ||
| ``` | ||
|
|
||
| ## Compatible Instances | ||
|
|
||
| | Instance type | Max context length | | ||
| | ------------- |-------------| | ||
| | L4 | 4096 (FP8, BF16) | | ||
| | H100 | 4096 (FP8, BF16) | | ||
|
|
||
| ## Model introduction | ||
|
|
||
| Kyutai's Moshi is a speech-text foundation model for real-time dialogue. | ||
| Moshi is an experimental next-generation conversational model, designed to understand and respond fluidly and naturally to complex conversations, while providing unprecedented expressiveness and spontaneity. | ||
| While current systems for spoken dialogue rely on a pipeline of separate components, Moshi is the first real-time full-duplex spoken large language model. | ||
| Moshika is the variant of Moshi with a female voice in English. | ||
|
|
||
| ## Why is it useful? | ||
|
|
||
| Moshi offers seamless real-time dialogue capabilities, enabling users to engage in natural conversations with the model. | ||
| It allows the modeling of arbitrary conversational dynamics, including overlapping speech, interruptions, interjections, and more. | ||
| In particular, this model: | ||
| - Processes 24 kHz audio down to a 12.5 Hz representation with a bandwith of 1.1 kbps, performing better than existing non-streaming models. | ||
| - Achieves a theoretical latency of 160 ms, with a practical latency of 200 ms, making it suitable for real-time applications. | ||
|
|
||
| ## How to use it | ||
|
|
||
| To perform inference tasks with your Moshi deployed at Scaleway, a WebSocket API is exposed for real-time dialogue and is accessible at the following endpoint: | ||
|
|
||
| ```bash | ||
| wss://<Deployment UUID>.ifr.fr-par.scaleway.com/api/chat | ||
| ``` | ||
|
|
||
| ### Testing the WebSocket endpoint | ||
|
|
||
| To test the endpoint, use the following command: | ||
|
|
||
| ```bash | ||
| curl -i --http1.1 \ | ||
| -H "Authorization: Bearer <IAM API key>" \ | ||
| -H "Connection: Upgrade" \ | ||
| -H "Upgrade: websocket" \ | ||
| -H "Sec-WebSocket-Key: SGVsbG8sIHdvcmxkIQ==" \ | ||
| -H "Sec-WebSocket-Version: 13" \ | ||
| --url "https://<Deployment UUID>.ifr.fr-par.scaleway.com/api/chat" | ||
| ``` | ||
|
|
||
| Make sure to replace `<IAM API key>` and `<Deployment UUID>` with your actual [IAM API key](/identity-and-access-management/iam/how-to/create-api-keys/) and the Deployment UUID you are targeting. | ||
|
|
||
| <Message type="tip"> | ||
| Authentication can be done using the `token` query parameter, which should be set to your IAM API key, if headers are not supported (e.g., in a browser). | ||
| </Message> | ||
|
|
||
| The server should respond with a `101 Switching Protocols` status code, indicating that the connection has been successfully upgraded to a WebSocket connection. | ||
|
|
||
| ### Interacting with the model | ||
|
|
||
| We provide code samples in various programming languages (Python, Rust, typescript) to interact with the model using the WebSocket API as well as a simple web interface. | ||
| Those code samples can be found in our [GitHub repository](https://github.com/scaleway/moshi-client-examples). | ||
| This repository contains instructions on how to run the code samples and interact with the model. | ||
86 changes: 86 additions & 0 deletions
86
ai-data/managed-inference/reference-content/moshiko-0.1-8b.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| --- | ||
| meta: | ||
| title: Understanding the Moshiko-0.1-8b model | ||
| description: Deploy your own secure Moshiko-0.1-8b model with Scaleway Managed Inference. Privacy-focused, fully managed. | ||
| content: | ||
| h1: Understanding the Moshiko-0.1-8b model | ||
| paragraph: This page provides information on the Moshiko-0.1-8b model | ||
| tags: | ||
| dates: | ||
| validation: 2024-10-30 | ||
| categories: | ||
| - ai-data | ||
| --- | ||
|
|
||
| ## Model overview | ||
|
|
||
| | Attribute | Details | | ||
| |-----------------|------------------------------------| | ||
| | Provider | [Kyutai](https://github.com/kyutai-labs/moshi) | | ||
| | Compatible Instances | L4, H100 (FP8, BF16) | | ||
| | Context size | 4096 tokens | | ||
|
|
||
| ## Model names | ||
|
|
||
| ```bash | ||
| kyutai/moshiko-0.1-8b:bf16 | ||
| kyutai/moshiko-0.1-8b:fp8 | ||
| ``` | ||
|
|
||
| ## Compatible Instances | ||
|
|
||
| | Instance type | Max context length | | ||
| | ------------- |-------------| | ||
| | L4 | 4096 (FP8, BF16) | | ||
| | H100 | 4096 (FP8, BF16) | | ||
|
|
||
| ## Model introduction | ||
|
|
||
| Kyutai's Moshi is a speech-text foundation model for real-time dialogue. | ||
| Moshi is an experimental next-generation conversational model, designed to understand and respond fluidly and naturally to complex conversations, while providing unprecedented expressiveness and spontaneity. | ||
| While current systems for spoken dialogue rely on a pipeline of separate components, Moshi is the first real-time full-duplex spoken large language model. | ||
| Moshiko is the variant of Moshi with a male voice in English. | ||
|
|
||
| ## Why is it useful? | ||
|
|
||
| Moshi offers seamless real-time dialogue capabilities, enabling users to engage in natural conversations with the model. | ||
| It allows the modeling of arbitrary conversational dynamics, including overlapping speech, interruptions, interjections, and more. | ||
| In particular, this model: | ||
| - Processes 24 kHz audio down to a 12.5 Hz representation with a bandwith of 1.1 kbps, performing better than existing non-streaming models. | ||
| - Achieves a theoretical latency of 160 ms, with a practical latency of 200 ms, making it suitable for real-time applications. | ||
|
|
||
| ## How to use it | ||
|
|
||
| To perform inference tasks with your Moshi deployed at Scaleway, a WebSocket API is exposed for real-time dialogue and is accessible at the following endpoint: | ||
|
|
||
| ```bash | ||
| wss://<Deployment UUID>.ifr.fr-par.scaleway.com/api/chat | ||
| ``` | ||
|
|
||
| ### Testing the WebSocket endpoint | ||
|
|
||
| To test the endpoint, use the following command: | ||
|
|
||
| ```bash | ||
| curl -i --http1.1 \ | ||
| -H "Authorization: Bearer <IAM API key>" \ | ||
| -H "Connection: Upgrade" \ | ||
| -H "Upgrade: websocket" \ | ||
| -H "Sec-WebSocket-Key: SGVsbG8sIHdvcmxkIQ==" \ | ||
| -H "Sec-WebSocket-Version: 13" \ | ||
| --url "https://<Deployment UUID>.ifr.fr-par.scaleway.com/api/chat" | ||
| ``` | ||
|
|
||
| Make sure to replace `<IAM API key>` and `<Deployment UUID>` with your actual [IAM API key](/identity-and-access-management/iam/how-to/create-api-keys/) and the Deployment UUID you are targeting. | ||
|
|
||
| <Message type="tip"> | ||
| Authentication can be done using the `token` query parameter, which should be set to your IAM API key, if headers are not supported (e.g., in a browser). | ||
| </Message> | ||
|
|
||
| The server should respond with a `101 Switching Protocols` status code, indicating that the connection has been successfully upgraded to a WebSocket connection. | ||
|
|
||
| ### Interacting with the model | ||
|
|
||
| We provide code samples in various programming languages (Python, Rust, typescript) to interact with the model using the WebSocket API as well as a simple web interface. | ||
| Those code samples can be found in our [GitHub repository](https://github.com/scaleway/moshi-client-examples). | ||
| This repository contains instructions on how to run the code samples and interact with the model. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.