mirror of
https://github.com/RevLayDust/RLD-UVR-Opt.git
synced 2026-11-20 13:07:58 +09:00
chore(community): add GitHub issue/PR templates, Code of Conduct, and Security policy
This commit is contained in:
1 parent
7daa15523f
commit
94c067632c
7 files changed
+346
No files matched your search
@@ -0,0 +1,71 @@
|
||||
name: Bug Report
|
||||
description: Create a report to help us reproduce and fix a bug in RLD UVR-Opt.
|
||||
title: "[Bug]: "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to report a bug! Please ensure you have checked existing issues first.
|
||||
- type: input
|
||||
id: os_version
|
||||
attributes:
|
||||
label: Operating System Version
|
||||
description: What version of Windows are you running?
|
||||
placeholder: e.g., Windows 11 Pro 64-bit (Build 22631)
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: install_mode
|
||||
attributes:
|
||||
label: Installation Profile
|
||||
description: Which installation profile was chosen in install_packages.bat / Install-UVR.ps1?
|
||||
options:
|
||||
- "Option A (NVIDIA CUDA EP)"
|
||||
- "Option B (NVIDIA TensorRT-RTX EP)"
|
||||
- "Option C (CPU Only Fallback)"
|
||||
- "Manual virtual environment setup"
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: gpu_hardware
|
||||
attributes:
|
||||
label: GPU Hardware & Driver Version
|
||||
description: Model name and NVIDIA display driver version.
|
||||
placeholder: e.g., NVIDIA GeForce RTX 4070 (Driver 572.16)
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
id: reproduction_steps
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: Describe the exact sequence of steps to trigger the bug.
|
||||
placeholder: |
|
||||
1. Run `python -m uvr_cli run -a "song.wav" -m "UVR-MDX-NET-Inst_HQ_4.onnx"`
|
||||
2. Select TensorRT-RTX EP in GUI
|
||||
3. See error
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected_behavior
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: What did you expect to happen?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: error_logs
|
||||
attributes:
|
||||
label: Terminal Output & Logs
|
||||
description: Paste terminal traceback or relevant entries from `uvr_run.log` or `install_logs/`.
|
||||
render: shell
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: install_record
|
||||
attributes:
|
||||
label: Install Record (`install/install_record.json`)
|
||||
description: Paste the content of your `install/install_record.json` file if available.
|
||||
render: json
|
||||
validations:
|
||||
required: false
|
||||
@@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: GitHub Discussions
|
||||
url: https://github.com/RevLayDust/RLD-UVR-Opt/discussions
|
||||
about: Ask questions, share separation workflows, or get community support.
|
||||
@@ -0,0 +1,30 @@
|
||||
name: Feature Request / RFC
|
||||
description: Suggest an optimization, new model architecture, Execution Provider, or CLI capability.
|
||||
title: "[Feature]: "
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Have an idea to make RLD UVR-Opt faster or more versatile? Describe it below.
|
||||
- type: textarea
|
||||
id: problem_statement
|
||||
attributes:
|
||||
label: Problem Statement
|
||||
description: Is your feature request related to a specific limitation, hardware constraint, or workflow friction?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: proposed_solution
|
||||
attributes:
|
||||
label: Proposed Solution
|
||||
description: Describe the behavior, CLI flag, or architectural change you would like to see implemented.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: alternatives_considered
|
||||
attributes:
|
||||
label: Alternative Approaches Considered
|
||||
description: Describe any alternative implementations or workarounds you have evaluated.
|
||||
validations:
|
||||
required: false
|
||||
@@ -0,0 +1,54 @@
|
||||
name: Performance & Benchmark Report
|
||||
description: Submit hardware benchmark results across varied GPU and CPU architectures.
|
||||
title: "[Bench]: "
|
||||
labels: ["benchmark", "performance"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for contributing hardware telemetry! Standardized benchmarks help us validate Execution Provider speedups and memory optimizations.
|
||||
- type: input
|
||||
id: system_hardware
|
||||
attributes:
|
||||
label: System Hardware Specifications
|
||||
description: GPU model, CPU model, total RAM, and OS version.
|
||||
placeholder: e.g., NVIDIA GeForce RTX 4080 (Driver 572.16) | Intel i7-13700K | 32 GB RAM | Windows 11
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: model_tested
|
||||
attributes:
|
||||
label: Model Name & Settings
|
||||
description: Model filename, segment size, overlap, and precision mode.
|
||||
placeholder: "e.g., UVR-MDX-NET-Inst_HQ_4.onnx (Segment: 4000, Overlap: 0.75, FP32)"
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: ep_tested
|
||||
attributes:
|
||||
label: Execution Provider Tested
|
||||
options:
|
||||
- "NvTensorRTRTXExecutionProvider (trt_rtx:0)"
|
||||
- "CUDAExecutionProvider (cuda:0)"
|
||||
- "CPUExecutionProvider (cpu)"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: results_table
|
||||
attributes:
|
||||
label: Benchmark Results Table
|
||||
description: Fill in your measurement metrics following the format in docs/development/benchmarking.md.
|
||||
value: |
|
||||
| Metric | Cold Run (Warmup 1) | Steady-State (Median / Mean) | Chunk Latency (p50 / p95) | Peak Device VRAM | Peak Torch VRAM | Peak Process RAM |
|
||||
| :--- | :---: | :---: | :---: | :---: | :---: | :---: |
|
||||
| Measured Values | 0.00 s (0.00x RT) | 0.00 s (0.00x RT) | 0.0 ms / 0.0 ms | 0,000 MB | 0,000 MB | 0,000 MB |
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: summary_csv_row
|
||||
attributes:
|
||||
label: Benchmark CSV / JSON Output
|
||||
description: Paste the corresponding row from `benchmark_results/summary.csv` or session JSON file.
|
||||
render: text
|
||||
validations:
|
||||
required: false
|
||||
@@ -0,0 +1,35 @@
|
||||
## Description
|
||||
|
||||
<!-- Provide a concise summary of your changes and motivation. -->
|
||||
|
||||
## Related Issue
|
||||
|
||||
<!-- Closes #123 / Relates to #456 -->
|
||||
|
||||
## Type of Change
|
||||
|
||||
- [ ] `fix`: Bug fix (non-breaking change fixing an issue)
|
||||
- [ ] `feat`: New feature or Execution Provider support
|
||||
- [ ] `perf`: Performance optimization or memory reduction
|
||||
- [ ] `refactor`: Code reorganization without functional changes
|
||||
- [ ] `docs`: Documentation update or addition
|
||||
- [ ] `test`: Unit test additions or test fixture updates
|
||||
|
||||
## How Has This Been Tested?
|
||||
|
||||
<!-- Describe tests run, commands used, and test environment (GPU model, driver version, OS). -->
|
||||
```powershell
|
||||
# Examples of executed test commands:
|
||||
.\venv\Scripts\python.exe -m unittest discover tests -v
|
||||
powershell -NoProfile -ExecutionPolicy Bypass -Command "Invoke-Pester -Path ./install/tests"
|
||||
```
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] My code adheres to the project's [Coding Standards](docs/development/coding-standards.md) (lazy imports, context lock prevention, decoupled pipeline).
|
||||
- [ ] All Python unit tests pass locally (`python -m unittest discover tests`).
|
||||
- [ ] All Pester installer tests pass locally if `install/` was modified (`Invoke-Pester -Path ./install/tests`).
|
||||
- [ ] Batch files maintain Windows CRLF line endings (verified via `tests.test_windows_batch_files`).
|
||||
- [ ] If changing inference, EP selection, or precision logic, benchmark results using `uvr_cli bench` are attached below following [Benchmarking Guidelines](docs/development/benchmarking.md).
|
||||
- [ ] No raw audio files, stems, or binary model weights (`*.onnx`, `*.pth`) are included in this commit.
|
||||
- [ ] Documentation has been updated to reflect new CLI flags, options, or behavior.
|
||||
@@ -0,0 +1,126 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, caste, color, religion, or sexual
|
||||
identity and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or advances of
|
||||
any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email address,
|
||||
without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
[maintainer contact / RevLayDust - needs confirmation].
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series of
|
||||
actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within the
|
||||
community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
|
||||
version 2.1, available at
|
||||
https://www.contributor-covenant.org/version/2.1/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by
|
||||
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
+25
@@ -0,0 +1,25 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Security updates are provided for the latest minor releases of **RLD UVR-Opt**:
|
||||
|
||||
| Version | Supported |
|
||||
| :--- | :--- |
|
||||
| `v0.2.x` | :white_check_mark: Supported |
|
||||
| `< v0.2.0` | :x: End of Life |
|
||||
|
||||
---
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
If you discover a security vulnerability in this project (e.g., untrusted model deserialization, arbitrary code execution via pickled weights, or installer path injection):
|
||||
|
||||
1. **Do Not Open a Public Issue**: Do not report security vulnerabilities via public GitHub Issues or discussions.
|
||||
2. **Private Disclosure**: Report the vulnerability directly to the project maintainers via GitHub Private Vulnerability Reporting or by contacting [RevLayDust](https://github.com/RevLayDust).
|
||||
3. **Information to Include**:
|
||||
- Description of the vulnerability and its potential impact.
|
||||
- Minimal reproduction script or steps.
|
||||
- Affected Execution Providers, components, or OS versions.
|
||||
|
||||
Maintainers will acknowledge receipt within 48 hours and work on a coordinated fix and patch release.
|
||||
Reference in new issue
Block a user