Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hedonhermdev authored Jul 23, 2024
1 parent 930d102 commit 48cbf2e
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,25 @@

Split a track into 4 stems: vocals, drums, bass and others. Based on Facebook's HTDemucs model ([repo](https://www.google.com/search?q=demucs+facebook&oq=demucs+fac&sourceid=chrome&ie=UTF-8)).


Built with Rust, Tauri, PyTorch and React.

# Try it Out
## Demo
Simply drag a track in, extract stems and drag your stems out.

https://github.com/user-attachments/assets/584cf59e-ef4b-4f24-913d-dc52d7549609


## Try it Out
For M1 macs running MacOS, there's a prebuilt binary available on the releases page. Currently, that's the only platform I have built and tested the app on. Porting to other platforms is a bit of work and I only own a MacBook. If you can make the app run on Linux or Windows machines, I will happily accept your PR.

# Building Locally
## Building Locally

These instructions have been tested to work on an M1 Macbook Pro running MacOS

## Requirements
### Requirements

### Rust and Cargo
#### Rust and Cargo
You can install Rust using [rustup](rustup.rs). I don't know what the MSRV is but I used `v1.79.0` while building the app.

```bash
Expand All @@ -23,7 +30,7 @@ rustc 1.79.0 (129f3b996 2024-06-10)
$ cargo --version
cargo 1.79.0 (ffa9cf99a 2024-06-03)
```
### Node and NPM
#### Node and NPM
```bash
$ brew install node@20

Expand All @@ -34,7 +41,7 @@ $ npm --version
10.7.0
```

### PyTorch
#### PyTorch

You can either use `libtorch` or provide the path to a PYTORCH installation. I found it easier to use `libtorch` directly.

Expand All @@ -43,13 +50,13 @@ $ wget https://download.pytorch.org/libtorch/cpu/libtorch-macos-arm64-2.2.0.zip
$ unzip libtorch-macos-arm64-2.2.0.zip
```

### Misc Dependencies
#### Misc Dependencies

```bash
$ brew install libomp
```

## Building the app
### Building the app

- Clone the repo
```bash
Expand Down Expand Up @@ -79,3 +86,7 @@ After this you're all set to start building the app.
$ npm run tauri build
$ npm run tauri dev # for development
```

# Contributing

Just open a PR :)

0 comments on commit 48cbf2e

Please sign in to comment.