Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

123 changes: 123 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
name: Bug report
description: Something in hls4ml is not working as expected
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to file a bug report.

Before filing, please check that the problem still occurs on the current `main` branch, and search
the [open issues](https://github.com/fastmachinelearning/hls4ml/issues) to see whether it has already
been reported. For questions and general problems that are probably not bugs, use
[Discussions](https://github.com/fastmachinelearning/hls4ml/discussions/categories/general) instead.

- type: textarea
id: summary
attributes:
label: Quick summary
description: A brief and concise description of the bug.
validations:
required: true

- type: input
id: version
attributes:
label: hls4ml version
description: Release number, or the commit hash if you are working from a checkout.
placeholder: "1.1.0, or commit abc1234"
validations:
required: true

- type: dropdown
id: frontend
attributes:
label: Frontend
description: How the model enters hls4ml.
options:
- Keras v3
- Keras v2
- PyTorch
- ONNX / QONNX
- Other or not applicable
validations:
required: true

- type: dropdown
id: backend
attributes:
label: Backend
options:
- Vitis
- Vivado
- VivadoAccelerator
- Quartus
- oneAPI
- Catapult
- Libero
- SymbolicExpression
- Other or not applicable
validations:
required: true

- type: dropdown
id: io_type
attributes:
label: io_type
options:
- io_parallel
- io_stream
- Both
- Not applicable
validations:
required: true

- type: input
id: tool_version
attributes:
label: HLS tool and version
description: Only if the bug involves synthesis. Write "not applicable" if it does not.
placeholder: "Vitis HLS 2024.1"

- type: textarea
id: reproducer
attributes:
label: Steps to reproduce
description: |
The smallest script that shows the problem, plus how you ran it. Include the model definition
inline where possible, rather than attaching a large file.
render: python
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behaviour
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual behaviour
description: Include the full error message or the incorrect output, not a paraphrase.
validations:
required: true

- type: textarea
id: context
attributes:
label: Possible fix or additional context
description: Optional. If you know where the problem comes from, or have a hint, tell us here.

- type: checkboxes
id: ai_disclosure
attributes:
label: AI assistance
description: |
See the [contributing guidelines](https://github.com/fastmachinelearning/hls4ml/blob/main/CONTRIBUTING.md#use-of-ai-tools).
Anything quoted here must come from a run you actually performed.
options:
- label: An AI tool helped produce this report, and I have checked its content myself.
required: false
7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Talk and engage with the comunity
- name: Question or general problem
url: https://github.com/fastmachinelearning/hls4ml/discussions/categories/general
about: Check out the GitHub discusisons page for hls4ml. This is the best way to get in touch with us. In particular, if you have a question about hls4ml or a general problem that is likely not a bug.
about: Ask on the discussions page. This is the best way to get in touch with us, in particular for a question about hls4ml or a problem that is likely not a bug.
- name: Propose an idea
url: https://github.com/fastmachinelearning/hls4ml/discussions/categories/ideas
about: Float a feature idea with the community before opening a feature request or an RFC.
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Documentation issue
description: Something in the documentation is wrong, missing or unclear
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
This covers the documentation at [hls4ml.org](https://fastmachinelearning.org/hls4ml/), the
docstrings, and the guidance files in the repository. Corrections are welcome as pull requests too —
you do not have to file an issue first.

- type: input
id: location
attributes:
label: Where
description: Page URL, file path, or the function whose docstring is affected.
validations:
required: true

- type: dropdown
id: kind
attributes:
label: Kind of problem
options:
- Incorrect — it says something that is not true
- Missing — the topic is not documented
- Unclear — correct but hard to follow
- Outdated — describes behaviour that has since changed
validations:
required: true

- type: textarea
id: details
attributes:
label: Details
description: What it says now, and what it should say instead.
validations:
required: true

- type: checkboxes
id: ai_disclosure
attributes:
label: AI assistance
description: See the [contributing guidelines](https://github.com/fastmachinelearning/hls4ml/blob/main/CONTRIBUTING.md#use-of-ai-tools).
options:
- label: An AI tool helped produce this report, and I have checked its content myself.
required: false
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Feature request
description: Suggest a new capability for hls4ml
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Please consider raising the idea in
[Discussions](https://github.com/fastmachinelearning/hls4ml/discussions/categories/ideas) first, so
you can find out whether it is already being worked on. A feature request is still welcome afterwards,
as the place to track the work.

If you are proposing a design rather than requesting a capability — something with a migration path,
a new configuration surface, or changes across several components — use the Plan / RFC template
instead.

- type: textarea
id: problem
attributes:
label: Problem
description: What can you not do today, and why does it matter for real hls4ml users?
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed behaviour
description: |
What hls4ml should do instead. If it adds a user-facing surface — a config key, a Strategy, an
`io_type`, an API argument — name it here.
validations:
required: true

- type: textarea
id: scope
attributes:
label: Parts of hls4ml affected
description: Frontends, backends and components you expect this to touch.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Optional. Workarounds you tried, and why they are not enough.

- type: checkboxes
id: contribution
attributes:
label: Contribution
options:
- label: I am willing to work on this myself.
required: false

- type: checkboxes
id: ai_disclosure
attributes:
label: AI assistance
description: See the [contributing guidelines](https://github.com/fastmachinelearning/hls4ml/blob/main/CONTRIBUTING.md#use-of-ai-tools).
options:
- label: An AI tool helped produce this request, and I have checked its content myself.
required: false
Loading
Loading