Skip to content

Commit 9b1a937

Browse files
Add Phoenix examples readme to docs (#404)
Co-authored-by: José Valim <jose.valim@dashbit.co>
1 parent 94fa47a commit 9b1a937

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

examples/phoenix/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Phoenix LiveView examples
22

3-
This directory contains minimal, single-file LiveView applications, which showcase how to integrate Bumblebee as part of the application.
3+
The [examples/phoenix](https://github.com/elixir-nx/bumblebee/tree/main/examples/phoenix) directory contains minimal, single-file LiveView applications, which showcase how to integrate Bumblebee as part of the application.
44

55
## Running
66

@@ -89,12 +89,12 @@ When working with user-given images, the most trivial approach would be to just
8989

9090
Both of these downsides can be avoided by moving all the work to the client. Specifically, when the user selects an image, we can resize it to a much smaller version and decode to pixel values right away. Both of these steps are fairly straightforward using the Canvas API.
9191

92-
For an example implementation of this technique see the [image classification example](image_classification.exs).
92+
For an example implementation of this technique see the [image classification example](https://github.com/elixir-nx/bumblebee/tree/main/examples/phoenix/image_classification.exs).
9393

9494
### User audio
9595

9696
The points made about images above are relevant to user-given audio as well. In fact, decoding audio files on the server requires ffmpeg to be installed system-wide. However, we can do all preprocessing on the client and send raw PCM data with a single channel to the server.
9797

98-
For an example implementation of this technique see the [speech-to-text example](speech_to_text.exs).
98+
For an example implementation of this technique see the [speech-to-text example](https://github.com/elixir-nx/bumblebee/tree/main/examples/phoenix/speech_to_text.exs).
9999

100100
If you are interested in real-time streaming, look at the [Membrane Framework](https://github.com/membraneframework/membrane_core).

mix.exs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ defmodule Bumblebee.MixProject do
6363
"notebooks/stable_diffusion.livemd",
6464
"notebooks/llms.livemd",
6565
"notebooks/llms_rag.livemd",
66-
"notebooks/fine_tuning.livemd"
66+
"notebooks/fine_tuning.livemd",
67+
"examples/phoenix/README.md"
6768
],
6869
extra_section: "GUIDES",
6970
groups_for_modules: [

0 commit comments

Comments
 (0)