Skip to content
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

Minor docs updates #768

Merged
merged 3 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
13 changes: 10 additions & 3 deletions docs/docs/audio/speech.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,15 @@ Marvin can generate speech from text.
```python
import marvin

marvin.speak("I sure like being inside this fancy computer!")
audio = marvin.speak("I sure like being inside this fancy computer!")
```

!!! success "Result"
```python
audio.stream_to_file("path/to/fancy_computer.mp3")
```
<audio controls>
<source src="/assets/audio/hello.mp3" type="audio/mpeg">
<source src="/assets/audio/fancy_computer.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio>

Expand All @@ -38,10 +41,14 @@ Marvin can generate speech from text.
def say_hello(name: str):
return f'Hello, {name}! How are you doing today?'

say_hello("Arthur")

audio = say_hello("Arthur")
```

!!! success "Result"
```python
audio.stream_to_file("path/to/hello_arthur.mp3")
```
<audio controls>
<source src="/assets/audio/hello_arthur.mp3" type="audio/mpeg">
Your browser does not support the audio element.
Expand Down
2 changes: 2 additions & 0 deletions docs/welcome/what_is_marvin.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# What is Marvin?

![](/assets/images/heroes/it_hates_me_hero.png)

Marvin is a lightweight AI toolkit for building natural language interfaces that are reliable, scalable, and easy to trust.

Each of Marvin's tools is simple and self-documenting, using AI to solve common but complex challenges like entity extraction, classification, and generating synthetic data. Each tool is independent and incrementally adoptable, so you can use them on their own or in combination with any other library. Marvin is also multi-modal, supporting both image and audio generation as well using images as inputs for extraction and classification.
Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ plugins:
cards: !ENV [MKDOCS_SOCIAL_CARDS, false]
cards_layout_options:
font_family: Inter
background_color: "#2d6df6"
# background_color: "#2d6df6"
background_color: "#181544" # marvin blue
- awesome-pages
- autolinks
- mkdocstrings:
Expand Down