Spaces:
Configuration error
Configuration error
add issue templates
Browse files
.github/ISSUE_TEMPLATE/bug_report.yml
ADDED
@@ -0,0 +1,50 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
name: "Bug Report"
|
2 |
+
description: |
|
3 |
+
Please provide as much details to help address the issue, including logs and screenshots.
|
4 |
+
labels:
|
5 |
+
- bug
|
6 |
+
body:
|
7 |
+
- type: checkboxes
|
8 |
+
attributes:
|
9 |
+
label: Checks
|
10 |
+
description: "To ensure timely help, please confirm the following:"
|
11 |
+
options:
|
12 |
+
- label: This template is only for bug reports, usage problems go with 'Help Wanted'.
|
13 |
+
required: true
|
14 |
+
- label: I have thoroughly reviewed the project documentation but couldn't find information to solve my problem.
|
15 |
+
required: true
|
16 |
+
- label: I have searched for existing issues, including closed ones, and couldn't find a solution.
|
17 |
+
required: true
|
18 |
+
- label: I confirm that I am using English to submit this report in order to facilitate communication.
|
19 |
+
required: true
|
20 |
+
- type: textarea
|
21 |
+
attributes:
|
22 |
+
label: Environment Details
|
23 |
+
description: "Provide details such as OS, Python version, and any relevant software or dependencies."
|
24 |
+
placeholder: e.g., CentOS Linux 7, RTX 3090, Python 3.10, torch==2.3.0, cuda 11.8
|
25 |
+
validations:
|
26 |
+
required: true
|
27 |
+
- type: textarea
|
28 |
+
attributes:
|
29 |
+
label: Steps to Reproduce
|
30 |
+
description: |
|
31 |
+
Include detailed steps, screenshots, and logs. Use the correct markdown syntax for code blocks.
|
32 |
+
placeholder: |
|
33 |
+
1. Create a new conda environment.
|
34 |
+
2. Clone the repository, install as local editable and properly set up.
|
35 |
+
3. Run the command: `accelerate launch src/f5_tts/train/train.py`.
|
36 |
+
4. Have following error message... (attach logs).
|
37 |
+
validations:
|
38 |
+
required: true
|
39 |
+
- type: textarea
|
40 |
+
attributes:
|
41 |
+
label: ✔️ Expected Behavior
|
42 |
+
placeholder: Describe what you expected to happen.
|
43 |
+
validations:
|
44 |
+
required: false
|
45 |
+
- type: textarea
|
46 |
+
attributes:
|
47 |
+
label: ❌ Actual Behavior
|
48 |
+
placeholder: Describe what actually happened.
|
49 |
+
validations:
|
50 |
+
required: false
|
.github/ISSUE_TEMPLATE/feature_request.yml
ADDED
@@ -0,0 +1,62 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
name: "Feature Request"
|
2 |
+
description: |
|
3 |
+
Some constructive suggestions and new ideas regarding current repo.
|
4 |
+
labels:
|
5 |
+
- enhancement
|
6 |
+
body:
|
7 |
+
- type: checkboxes
|
8 |
+
attributes:
|
9 |
+
label: Checks
|
10 |
+
description: "To help us grasp quickly, please confirm the following:"
|
11 |
+
options:
|
12 |
+
- label: This template is only for feature request.
|
13 |
+
required: true
|
14 |
+
- label: I have thoroughly reviewed the project documentation but couldn't find any relevant information that meets my needs.
|
15 |
+
required: true
|
16 |
+
- label: I have searched for existing issues, including closed ones, and found not discussion yet.
|
17 |
+
required: true
|
18 |
+
- label: I confirm that I am using English to submit this report in order to facilitate communication.
|
19 |
+
required: true
|
20 |
+
- type: textarea
|
21 |
+
attributes:
|
22 |
+
label: 1. Is this request related to a challenge you're experiencing? Tell us your story.
|
23 |
+
description: |
|
24 |
+
Describe the specific problem or scenario you're facing in detail. For example:
|
25 |
+
*"I was trying to use [feature] for [specific task], but encountered [issue]. This was frustrating because...."*
|
26 |
+
placeholder: Please describe the situation in as much detail as possible.
|
27 |
+
validations:
|
28 |
+
required: true
|
29 |
+
|
30 |
+
- type: textarea
|
31 |
+
attributes:
|
32 |
+
label: 2. What is your suggested solution?
|
33 |
+
description: |
|
34 |
+
Provide a clear description of the feature or enhancement you'd like to propose.
|
35 |
+
How would this feature solve your issue or improve the project?
|
36 |
+
placeholder: Describe your idea or proposed solution here.
|
37 |
+
validations:
|
38 |
+
required: true
|
39 |
+
|
40 |
+
- type: textarea
|
41 |
+
attributes:
|
42 |
+
label: 3. Additional context or comments
|
43 |
+
description: |
|
44 |
+
Any other relevant information, links, documents, or screenshots that provide clarity.
|
45 |
+
Use this section for anything not covered above.
|
46 |
+
placeholder: Add any extra details here.
|
47 |
+
validations:
|
48 |
+
required: false
|
49 |
+
|
50 |
+
- type: checkboxes
|
51 |
+
attributes:
|
52 |
+
label: 4. Can you help us with this feature?
|
53 |
+
description: |
|
54 |
+
Let us know if you're interested in contributing. This is not a commitment but a way to express interest in collaboration.
|
55 |
+
options:
|
56 |
+
- label: I am interested in contributing to this feature.
|
57 |
+
required: false
|
58 |
+
|
59 |
+
- type: markdown
|
60 |
+
attributes:
|
61 |
+
value: |
|
62 |
+
**Note:** Please submit only one request per issue to keep discussions focused and manageable.
|
.github/ISSUE_TEMPLATE/help_wanted.yml
ADDED
@@ -0,0 +1,50 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
name: "Help Wanted"
|
2 |
+
description: |
|
3 |
+
Please provide as much details to help address the issue, including logs and screenshots.
|
4 |
+
labels:
|
5 |
+
- help wanted
|
6 |
+
body:
|
7 |
+
- type: checkboxes
|
8 |
+
attributes:
|
9 |
+
label: Checks
|
10 |
+
description: "To ensure timely help, please confirm the following:"
|
11 |
+
options:
|
12 |
+
- label: This template is only for usage issues encountered.
|
13 |
+
required: true
|
14 |
+
- label: I have thoroughly reviewed the project documentation but couldn't find information to solve my problem.
|
15 |
+
required: true
|
16 |
+
- label: I have searched for existing issues, including closed ones, and couldn't find a solution.
|
17 |
+
required: true
|
18 |
+
- label: I confirm that I am using English to submit this report in order to facilitate communication.
|
19 |
+
required: true
|
20 |
+
- type: textarea
|
21 |
+
attributes:
|
22 |
+
label: Environment Details
|
23 |
+
description: "Provide details such as OS, Python version, and any relevant software or dependencies."
|
24 |
+
placeholder: e.g., macOS 13.5, Python 3.10, torch==2.3.0, Gradio 4.44.1
|
25 |
+
validations:
|
26 |
+
required: true
|
27 |
+
- type: textarea
|
28 |
+
attributes:
|
29 |
+
label: Steps to Reproduce
|
30 |
+
description: |
|
31 |
+
Include detailed steps, screenshots, and logs. Use the correct markdown syntax for code blocks.
|
32 |
+
placeholder: |
|
33 |
+
1. Create a new conda environment.
|
34 |
+
2. Clone the repository and install as pip package.
|
35 |
+
3. Run the command: `f5-tts_infer-gradio` with no ref_text provided.
|
36 |
+
4. Stuck there with the following message... (attach logs and also error msg e.g. after ctrl-c).
|
37 |
+
validations:
|
38 |
+
required: true
|
39 |
+
- type: textarea
|
40 |
+
attributes:
|
41 |
+
label: ✔️ Expected Behavior
|
42 |
+
placeholder: Describe what you expected to happen, e.g. output a generated audio
|
43 |
+
validations:
|
44 |
+
required: false
|
45 |
+
- type: textarea
|
46 |
+
attributes:
|
47 |
+
label: ❌ Actual Behavior
|
48 |
+
placeholder: Describe what actually happened, failure messages, etc.
|
49 |
+
validations:
|
50 |
+
required: false
|
.github/ISSUE_TEMPLATE/question.yml
ADDED
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
name: "Question"
|
2 |
+
description: |
|
3 |
+
Pure question or inquiry about the project.
|
4 |
+
labels:
|
5 |
+
- question
|
6 |
+
body:
|
7 |
+
- type: checkboxes
|
8 |
+
attributes:
|
9 |
+
label: Checks
|
10 |
+
description: "To help us grasp quickly, please confirm the following:"
|
11 |
+
options:
|
12 |
+
- label: This template is only for question, not feature requests or bug reports.
|
13 |
+
required: true
|
14 |
+
- label: I have thoroughly reviewed the project documentation and read the related paper(s).
|
15 |
+
required: true
|
16 |
+
- label: I have searched for existing issues, including closed ones, no similar questions.
|
17 |
+
required: true
|
18 |
+
- label: I confirm that I am using English to submit this report in order to facilitate communication.
|
19 |
+
required: true
|
20 |
+
- type: textarea
|
21 |
+
attributes:
|
22 |
+
label: Question details
|
23 |
+
description: |
|
24 |
+
Question details, clearly stated using proper markdown syntax.
|
25 |
+
validations:
|
26 |
+
required: true
|