mirror of
https://github.com/SWivid/F5-TTS.git
synced 2025-12-05 20:40:12 -08:00
update issue templates
This commit is contained in:
12
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
12
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@@ -1,6 +1,6 @@
|
||||
name: "Bug Report"
|
||||
description: |
|
||||
Please provide as much details to help address the issue, including logs and screenshots.
|
||||
Please provide as much details to help address the issue more efficiently, including input, output, logs and screenshots.
|
||||
labels:
|
||||
- bug
|
||||
body:
|
||||
@@ -15,13 +15,13 @@ body:
|
||||
required: true
|
||||
- label: I have searched for existing issues, including closed ones, and couldn't find a solution.
|
||||
required: true
|
||||
- label: I confirm that I am using English to submit this report in order to facilitate communication.
|
||||
- label: I am using English to submit this issue to facilitate community communication.
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Environment Details
|
||||
description: "Provide details such as OS, Python version, and any relevant software or dependencies."
|
||||
placeholder: e.g., CentOS Linux 7, RTX 3090, Python 3.10, torch==2.3.0, cuda 11.8
|
||||
description: "Provide details including OS, GPU info, Python version, any relevant software or dependencies, and trainer setting."
|
||||
placeholder: e.g., CentOS Linux 7, 4 * RTX 3090, Python 3.10, torch==2.3.0+cu118, cuda 11.8, config yaml is ...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
@@ -39,12 +39,12 @@ body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: ✔️ Expected Behavior
|
||||
placeholder: Describe what you expected to happen.
|
||||
placeholder: Describe in detail what you expected to happen.
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: ❌ Actual Behavior
|
||||
placeholder: Describe what actually happened.
|
||||
placeholder: Describe in detail what actually happened.
|
||||
validations:
|
||||
required: false
|
||||
2
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
2
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
@@ -15,7 +15,7 @@ body:
|
||||
required: true
|
||||
- label: I have searched for existing issues, including closed ones, and found not discussion yet.
|
||||
required: true
|
||||
- label: I confirm that I am using English to submit this report in order to facilitate communication.
|
||||
- label: I am using English to submit this issue to facilitate community communication.
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
|
||||
16
.github/ISSUE_TEMPLATE/help_wanted.yml
vendored
16
.github/ISSUE_TEMPLATE/help_wanted.yml
vendored
@@ -1,6 +1,6 @@
|
||||
name: "Help Wanted"
|
||||
description: |
|
||||
Please provide as much details to help address the issue, including logs and screenshots.
|
||||
Please provide as much details to help address the issue more efficiently, including input, output, logs and screenshots.
|
||||
labels:
|
||||
- help wanted
|
||||
body:
|
||||
@@ -15,36 +15,40 @@ body:
|
||||
required: true
|
||||
- label: I have searched for existing issues, including closed ones, and couldn't find a solution.
|
||||
required: true
|
||||
- label: I confirm that I am using English to submit this report in order to facilitate communication.
|
||||
- label: I am using English to submit this issue to facilitate community communication.
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Environment Details
|
||||
description: "Provide details such as OS, Python version, and any relevant software or dependencies."
|
||||
placeholder: e.g., macOS 13.5, Python 3.10, torch==2.3.0, Gradio 4.44.1
|
||||
placeholder: |
|
||||
e.g., macOS 13.5, Python 3.10, torch==2.3.0, Gradio 4.44.1
|
||||
If training or finetuning related, provide detailed configuration including GPU info and training setup.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: |
|
||||
Include detailed steps, screenshots, and logs. Use the correct markdown syntax for code blocks.
|
||||
Include detailed steps, screenshots, and logs. Provide used prompt wav and text. Use the correct markdown syntax for code blocks.
|
||||
placeholder: |
|
||||
1. Create a new conda environment.
|
||||
2. Clone the repository and install as pip package.
|
||||
3. Run the command: `f5-tts_infer-gradio` with no ref_text provided.
|
||||
4. Stuck there with the following message... (attach logs and also error msg e.g. after ctrl-c).
|
||||
5. Prompt & generated wavs are [change suffix to .mp4 to enable direct upload or pack all to .zip].
|
||||
6. Reference audio's transcription or provided ref_text is `xxx`, and text to generate is `xxx`.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: ✔️ Expected Behavior
|
||||
placeholder: Describe what you expected to happen, e.g. output a generated audio
|
||||
placeholder: Describe what you expected to happen in detail, e.g. output a generated audio.
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: ❌ Actual Behavior
|
||||
placeholder: Describe what actually happened, failure messages, etc.
|
||||
placeholder: Describe what actually happened in detail, failure messages, etc.
|
||||
validations:
|
||||
required: false
|
||||
6
.github/ISSUE_TEMPLATE/question.yml
vendored
6
.github/ISSUE_TEMPLATE/question.yml
vendored
@@ -1,6 +1,6 @@
|
||||
name: "Question"
|
||||
description: |
|
||||
Pure question or inquiry about the project, usage issue goes with "help wanted".
|
||||
Research question or pure inquiry about the project, usage issue goes with "help wanted".
|
||||
labels:
|
||||
- question
|
||||
body:
|
||||
@@ -9,13 +9,13 @@ body:
|
||||
label: Checks
|
||||
description: "To help us grasp quickly, please confirm the following:"
|
||||
options:
|
||||
- label: This template is only for question, not feature requests or bug reports.
|
||||
- label: This template is only for research question, not usage problems, feature requests or bug reports.
|
||||
required: true
|
||||
- label: I have thoroughly reviewed the project documentation and read the related paper(s).
|
||||
required: true
|
||||
- label: I have searched for existing issues, including closed ones, no similar questions.
|
||||
required: true
|
||||
- label: I confirm that I am using English to submit this report in order to facilitate communication.
|
||||
- label: I am using English to submit this issue to facilitate community communication.
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
|
||||
Reference in New Issue
Block a user