Skip to content

Commit

Permalink
create remaining server curl examples
Browse files Browse the repository at this point in the history
  • Loading branch information
ajcwebdev committed Oct 1, 2024
1 parent 9529db8 commit cba319a
Show file tree
Hide file tree
Showing 2 changed files with 325 additions and 104 deletions.
59 changes: 31 additions & 28 deletions docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,12 @@
- [OctoAI's Models](#octoais-models)
- [Llama.cpp](#llamacpp)
- [Transcription Options](#transcription-options)
- [Whisper.cpp](#whispercpp)
- [Deepgram](#deepgram)
- [Assembly](#assembly)
- [Whisper.cpp](#whispercpp)
- [Docker Compose](#docker-compose)
- [Alternative JavaScript Runtimes](#alternative-javascript-runtimes)
- [Prompt Options](#prompt-options)
- [Alternative Runtimes](#alternative-runtimes)
- [Docker Compose](#docker-compose)
- [Deno](#deno)
- [Bun](#bun)
- [Makeshift Test Suite](#makeshift-test-suite)
Expand Down Expand Up @@ -232,26 +233,6 @@ npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --llama

## Transcription Options

Create a `.env` file and set API key as demonstrated in `.env.example` for `DEEPGRAM_API_KEY` or `ASSEMBLY_API_KEY`.

### Deepgram

```bash
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --deepgram
```

### Assembly

```bash
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --assembly
```

Include speaker labels and number of speakers:

```bash
npm run as -- --video "https://ajc.pics/audio/fsjam-short.mp3" --assembly --speakerLabels
```

### Whisper.cpp

If neither the `--deepgram` or `--assembly` option is included for transcription, `autoshow` will default to running the largest Whisper.cpp model. To configure the size of the Whisper model, use the `--model` option and select one of the following:
Expand Down Expand Up @@ -279,15 +260,27 @@ Run `whisper.cpp` in a Docker container with `--whisperDocker`:
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --whisperDocker base
```

## Docker Compose
### Deepgram

This will run both `whisper.cpp` and the AutoShow Commander CLI in their own Docker containers.
Create a `.env` file and set API key as demonstrated in `.env.example` for `DEEPGRAM_API_KEY`.

```bash
docker-compose run autoshow --video "https://www.youtube.com/watch?v=MORMZXEaONk" --whisperDocker base
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --deepgram
```

Currently working on the `llama.cpp` Docker integration so the entire project can be encapsulated in one local Docker Compose file.
### Assembly

Create a `.env` file and set API key as demonstrated in `.env.example` for `ASSEMBLY_API_KEY`.

```bash
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --assembly
```

Include speaker labels and number of speakers:

```bash
npm run as -- --video "https://ajc.pics/audio/fsjam-short.mp3" --assembly --speakerLabels
```

## Prompt Options

Expand Down Expand Up @@ -345,7 +338,17 @@ Include all prompt options:
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --prompt titles summary longChapters takeaways questions
```

## Alternative JavaScript Runtimes
## Alternative Runtimes

### Docker Compose

This will run both `whisper.cpp` and the AutoShow Commander CLI in their own Docker containers.

```bash
docker-compose run autoshow --video "https://www.youtube.com/watch?v=MORMZXEaONk" --whisperDocker base
```

Currently working on the `llama.cpp` Docker integration so the entire project can be encapsulated in one local Docker Compose file.

### Bun

Expand Down
Loading

0 comments on commit cba319a

Please sign in to comment.