Skip to content

Commit

Permalink
doc: banner + recursive cloning of submodules in instructions (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
PABannier committed Oct 20, 2023
1 parent 3fa4ef0 commit 37e2282
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# encodec.cpp

![encodec.cpp](./assets/banner.png)

[![Actions Status](https://github.com/PABannier/encodec.cpp/actions/workflows/build.yml/badge.svg)](https://github.com/PABannier/encodec.cpp/actions)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

High-performance inference of [Meta's Encodec](https://github.com/facebookresearch/encodec) deep learning based audio codec model:

- Plain C/C++ implementation without dependencies using [ggml](https://github.com/ggerganov/ggml)
Expand All @@ -21,7 +26,7 @@ Inference: encodec.h / encodec.cpp

- 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))
- Sample usage is demonstrated in [main.cpp](examples/main)
- Basic usage is demonstrated in [main.cpp](examples/main)

## Usage

Expand All @@ -30,7 +35,7 @@ Here are the steps for the bark model.
### Get the code

```bash
git clone https://github.com/PABannier/encodec.cpp.git
git clone --recurse-submodules https://github.com/PABannier/encodec.cpp.git
cd encodec.cpp
```

Expand Down
Binary file added assets/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 37e2282

Please sign in to comment.