Skip to content

Commit

Permalink
doc: demo (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
PABannier committed Oct 23, 2023
1 parent 55116f3 commit eff5691
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,26 @@ High-performance inference of [Meta's Encodec](https://github.com/facebookresear

- Plain C/C++ implementation without dependencies using [ggml](https://github.com/ggerganov/ggml)

The entire implementation of the model is contained in 3 source files:
## Demo

Tensor operations: ggml.h / ggml.c<br/>
Inference: encodec.h / encodec.cpp
Here is a demo of running Encodec on a single M1 MacBook Pro:

https://github.com/PABannier/encodec.cpp/assets/12958149/d11561be-98e9-4504-bba7-86bcc233a499

## Roadmap

- [x] Support of 24Khz model
- [ ] Support of 48Khz model
- [ ] Encodec's language model support
- [x] Mixed F16 / F32 precision

- [ ] 4-bit and 8-bit quantization
- [ ] Metal support
- [ ] cuBLAS support

## Implementation details

- The core tensor operations are implemented in C ([ggml.h](ggml.h) / [ggml.c](ggml.c))
- The encoder-decoder architecture and the high-level C-style API are implemented in C++ ([encodec.h](encodec.h) / [encodec.cpp](encodec.cpp))
- Basic usage is demonstrated in [main.cpp](examples/main)
- Basic usage is demonstrated in [main.cpp](examples/main).


## Usage

Expand Down

0 comments on commit eff5691

Please sign in to comment.