mirror of
https://github.com/kyutai-labs/delayed-streams-modeling.git
synced 2025-12-23 03:19:57 +00:00
Sketch a FAQ and add some issue templates. (#88)
This commit is contained in:
83
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
83
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
@@ -0,0 +1,83 @@
|
||||
name: Bug Report
|
||||
description: You found a bug.
|
||||
labels: ["bug", "triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Please first check the [FAQ](https://github.com/kyutai-labs/delayed-streams-modeling/blob/main/FAQ.md).
|
||||
- type: dropdown
|
||||
id: backend
|
||||
attributes:
|
||||
label: Backend impacted
|
||||
description: Which backend is concerned with your bug report?
|
||||
options:
|
||||
- The PyTorch implementation
|
||||
- The MLX implementation
|
||||
- The Rust implementation
|
||||
- Other / All
|
||||
default: 0
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: os
|
||||
attributes:
|
||||
label: Operating system
|
||||
description: What is your operating system?
|
||||
options:
|
||||
- Linux
|
||||
- Mac OS X
|
||||
- Windows (unsupported)
|
||||
default: 0
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: hardware
|
||||
attributes:
|
||||
label: Hardware
|
||||
description: What hardware are you using?
|
||||
options:
|
||||
- CPU
|
||||
- GPU with CUDA
|
||||
- Metal with MLX
|
||||
default: 0
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: Provide a detailed description of your bug.
|
||||
placeholder:
|
||||
value:
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: more_info
|
||||
attributes:
|
||||
label: Extra information
|
||||
description: Please provide any other relevant information, such as log extracts, code etc.
|
||||
placeholder:
|
||||
value:
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: env
|
||||
attributes:
|
||||
label: Environment
|
||||
description: Please provide any other relevant information, such as log extracts, code etc.
|
||||
placeholder:
|
||||
value: |
|
||||
Fill in the following information on your system.
|
||||
- Operating system version:
|
||||
|
||||
If the backend impacted is PyTorch:
|
||||
- Python version:
|
||||
- PyTorch version:
|
||||
- CUDA version (run `python -c 'import torch; print(torch.version.cuda)'`):
|
||||
- GPU model and memory:
|
||||
|
||||
If the backend is MLX:
|
||||
- Mac model:
|
||||
validations:
|
||||
required: true
|
||||
40
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
40
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
@@ -0,0 +1,40 @@
|
||||
name: Question
|
||||
description: You have a question about the codebase, the paper, or the implementation.
|
||||
labels: ["question", "triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Please first check the [FAQ](https://github.com/kyutai-labs/delayed-streams-modeling/blob/main/FAQ.md).
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Due diligence
|
||||
description: Have you searched the existing issues / FAQ / Google / asked ChatGPT?
|
||||
options:
|
||||
- label: I have done my due diligence in trying to find the answer myself.
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: backend
|
||||
attributes:
|
||||
label: Topic
|
||||
description: What is your question about?
|
||||
options:
|
||||
- The paper
|
||||
- The PyTorch implementation
|
||||
- The MLX implementation
|
||||
- The Rust implementation
|
||||
- Other / All
|
||||
default: 0
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: Question
|
||||
description: What is your question?
|
||||
placeholder: Your question. Please make sure this is directly related to our codebase. We will not provide support for installing PyTorch, CUDA, Rust etc.
|
||||
value:
|
||||
validations:
|
||||
required: true
|
||||
Reference in New Issue
Block a user