Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add important notice on experimental branches #188

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add important notice on experimental branches #188

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,15 @@ This is a refactored and enhanced version of _DiffSinger: Singing Voice Synthesi
- **Roadmap for future releases**: See [Project Board](https://github.com/orgs/openvpi/projects/1)
- **Thoughts, proposals & ideas**: See [Discussions](https://github.com/openvpi/DiffSinger/discussions)

## Important notice on experimental branches

ONNX exporting pipelines, OpenUtau support and other deployment-related components are **supported ONLY FOR MAIN BRANCH**. Without in-depth knowledge on how and why DiffSinger code works, you can easily make things break just like many other machine-learning projects. All experimental branches are only intended for feature development, only a limited feature set is tested, and are **never meant to be deployed as ONNX models**. This wasn't clearly stated before and has caused us debugging headaches multiple times in the past, in some cases users had:

- distributed ONNX model that won't work in OpenUtau (possibly worked in their own modified revision) and led to mysterious bug report in OpenUtau repo (#xxxx)
- exported ONNX model with Torch 2.2 (which is unsupported), had a success (which is broken, ONNX export has A LOT of quirks we had to iron out with our code) and distributed the model, led to mysterious bug report in OpenUtau repo (#xxxx)

### Please refrain from distributing model files generated by experimental branches, for the sake of developers' maintenance burden. This is NOT SUPPORTED.

## Architecture & Algorithms

TBD
Expand Down