From db3e2c3638b688c4071c7174216547b47be3788d Mon Sep 17 00:00:00 2001 From: Mike Bird Date: Thu, 11 Jul 2024 11:01:04 -0400 Subject: [PATCH] merge guides into configure --- docs/guides/language-model.mdx | 16 ---------------- docs/guides/text-to-speech.mdx | 26 -------------------------- docs/mint.json | 4 ---- docs/software/configure.mdx | 30 ++++++++++++++++++++++++++++++ 4 files changed, 30 insertions(+), 46 deletions(-) delete mode 100644 docs/guides/language-model.mdx delete mode 100644 docs/guides/text-to-speech.mdx diff --git a/docs/guides/language-model.mdx b/docs/guides/language-model.mdx deleted file mode 100644 index 03b1d32..0000000 --- a/docs/guides/language-model.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Language Model" -description: "The LLM that powers your 01" ---- - -## Hosted Models - -The default LLM for 01 is GPT-4-Turbo. You can find this in the default profile in `software/source/server/profiles/default.py`. - -The fast profile uses Llama3-8b served by Groq. You can find this in the fast profile in `software/source/server/profiles/fast.py`. - -## Local Models - -You can use local models to power 01. - -Using the local profile launches the Local Explorer where you can select your inference provider and model. The default options include Llamafile, Jan, Ollama, and LM Studio. diff --git a/docs/guides/text-to-speech.mdx b/docs/guides/text-to-speech.mdx deleted file mode 100644 index 03dab15..0000000 --- a/docs/guides/text-to-speech.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Text To Speech" -description: "The voice of 01" ---- - -## Local TTS - -For local TTS, Coqui is used. - -```python -# Set your profile with a local TTS service -interpreter.tts = "coqui" -``` - -## Hosted TTS - -01 supports OpenAI and Elevenlabs for hosted TTS - -```python -# Set your profile with a hosted TTS service -interpreter.tts = "elevenlabs" -``` - -## Other Models - -More instructions coming soon! diff --git a/docs/mint.json b/docs/mint.json index 81f0a44..e763131 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -52,10 +52,6 @@ "group": "Hardware Setup", "pages": ["hardware/01-light", "hardware/m5atom"] }, - { - "group": "Using 01", - "pages": ["guides/language-model", "guides/text-to-speech"] - }, { "group": "Troubleshooting", "pages": ["troubleshooting/faq"] diff --git a/docs/software/configure.mdx b/docs/software/configure.mdx index bdda328..2ebe16a 100644 --- a/docs/software/configure.mdx +++ b/docs/software/configure.mdx @@ -38,3 +38,33 @@ The easiest way is to duplicate an existing profile and then update values as ne # Use custom profile poetry run 01 --profile ``` + +### Hosted LLMs + +The default LLM for 01 is GPT-4-Turbo. You can find this in the default profile in `software/source/server/profiles/default.py`. + +The fast profile uses Llama3-8b served by Groq. You can find this in the fast profile in `software/source/server/profiles/fast.py`. + +### Local LLMs + +You can use local models to power 01. + +Using the local profile launches the Local Explorer where you can select your inference provider and model. The default options include Llamafile, Jan, Ollama, and LM Studio. + +### Hosted TTS + +01 supports OpenAI and Elevenlabs for hosted TTS + +```python +# Set your profile with a hosted TTS service +interpreter.tts = "elevenlabs" +``` + +### Local TTS + +For local TTS, Coqui is used. + +```python +# Set your profile with a local TTS service +interpreter.tts = "coqui" +```