feat: main feat (#1)

.all-contributorsrc

@@ -9,7 +9,19 @@
   "imageSize": 80,
   "commit": true,
   "commitConvention": "angular",
-  "contributors": [],
+  "contributors": [
+    {
+      "login": "34j",
+      "name": "34j",
+      "avatar_url": "https://avatars.githubusercontent.com/u/55338215?v=4",
+      "profile": "https://github.com/34j",
+      "contributions": [
+        "code",
+        "ideas",
+        "doc"
+      ]
+    }
+  ],
   "contributorsPerLine": 7,
   "skipCi": true
 }

.flake8

@@ -1,3 +1,4 @@
 [flake8]
 exclude = docs
 max-line-length = 88
+ignore = E203, E501, E741, E402, E712, W503, E731, E711

.github/workflows/ci.yml

@@ -39,7 +39,7 @@ jobs:
           - "3.8"
           - "3.9"
           - "3.10"
-          - "3.11"
+          # - "3.11"
         os:
           - ubuntu-latest
           # - windows-latest

.gitignore

@@ -138,3 +138,13 @@ dmypy.json
 
 # Cython debug symbols
 cython_debug/
+
+# additional files
+tests/**/*.wav
+tests/**/*.npy
+tests/**/*.pt
+tests/**/*.txt
+tests/**/*.json
+tests/**/*.pth
+tests/**/*.download
+*.tfevents.*

.pre-commit-config.yaml

@@ -57,17 +57,18 @@ repos:
     rev: v2.2.2
     hooks:
       - id: codespell
+        args: [-w]
   - repo: https://github.com/PyCQA/flake8
     rev: 6.0.0
     hooks:
       - id: flake8
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.931
-    hooks:
-      - id: mypy
-        additional_dependencies: []
-  - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.4
-    hooks:
-      - id: bandit
-        args: [-x, tests]
+  #- repo: https://github.com/pre-commit/mirrors-mypy
+  #  rev: v0.931
+  #  hooks:
+  #    - id: mypy
+  #      additional_dependencies: []
+  # - repo: https://github.com/PyCQA/bandit
+  #   rev: 1.7.4
+  #   hooks:
+  #     - id: bandit
+  #       args: [-x, tests]

LICENSE

@@ -1,7 +1,7 @@
-
 MIT License
 
 Copyright (c) 2023 34j and contributors
+Copyright (c) 2021 Jingyi Li
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -30,24 +30,64 @@
   <img src="https://img.shields.io/pypi/l/so-vits-svc-fork.svg?style=flat-square" alt="License">
 </p>
 
-A fork of so-vits-svc.
+A fork of [`so-vits-svc`](https://github.com/svc-develop-team/so-vits-svc) with a **greatly improved interface**. Based on branch `4.0` (v1). No differences in functionality and the models are compatible.
 
 ## Installation
 
 Install this via pip (or your favourite package manager):
 
 ```shell
+pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/cu117
 pip install so-vits-svc-fork
 ```
 
+## Features not available in the original repo
+
+- Unified command-line interface (no need to run Python scripts)
+- Ready to use just by installing with `pip`.
+- Automatically download pretrained base model and HuBERT model
+- Code completely formatted with black, isort, autoflake etc.
+
+## Usage
+
+### Training
+
+Colab notebook: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/34j/so-vits-svc-fork/blob/main/notebooks/so-vits-svc-fork-4.0.ipynb)
+
+Place your dataset like `dataset_raw/{speaker_id}/{wav_file}.wav` and run:
+
+```shell
+svc pre-resample
+svc pre-config
+svc pre-hubert
+svc train
+```
+
+### Inference
+
+```shell
+svc --model-path <model-path> source.wav
+```
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
 <!-- prettier-ignore-start -->
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
-<!-- markdownlint-enable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/34j"><img src="https://avatars.githubusercontent.com/u/55338215?v=4?s=80" width="80px;" alt="34j"/><br /><sub><b>34j</b></sub></a><br /><a href="https://github.com/34j/so-vits-svc-fork/commits?author=34j" title="Code">💻</a> <a href="#ideas-34j" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/34j/so-vits-svc-fork/commits?author=34j" title="Documentation">📖</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 <!-- prettier-ignore-end -->