Skip to content
Draft
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
136 changes: 136 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
name: Bug report
description: Something TensorFold does wrong, such as a crash, hang, refusal, token mismatch or API error.
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for the report. A public request we can run lands a fix fastest.
Write "n/a" and why for a field that does not apply, such as the checkpoint for a build bug.
Do not paste private paths, hostnames, tokens, keys or confidential prompts. Maintainers may relabel the issue.
- type: dropdown
id: component
attributes:
label: Component
options:
- Engine or server
- Desktop app
- Mobile app
- Tools, build or CI
- Documentation or website
- Other
validations:
required: true
- type: dropdown
id: kind
attributes:
label: Kind of failure
options:
- Crash or startup error
- Hang or timeout
- Wrong refusal
- Token mismatch (drafted, resumed or concurrent differs from plain)
- API or streaming error
- Wrong state after cancel, reset or restart
- Build or install failure
- Other
validations:
required: true
- type: textarea
id: behavior
attributes:
label: Expected and actual behavior
description: What you expected, what happened instead, and how often it happens.
validations:
required: true
- type: input
id: version
attributes:
label: TensorFold version or commit
description: The `--version` output or the commit SHA. Say whether it is a release archive, a source build or a fork with changes.
placeholder: 1.1.9 release archive
validations:
required: true
- type: input
id: last-good
attributes:
label: Last version that worked
description: Optional. A release or commit where this did not happen.
- type: dropdown
id: backend
attributes:
label: Backend
multiple: true
options:
- Metal
- CUDA
- HIP
- XPU
- None (no GPU involved)
- Other
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating system
multiple: true
options:
- macOS
- Linux
- Windows
- iOS
- Android
validations:
required: true
- type: textarea
id: hardware
attributes:
label: Hardware and runtime
description: Chip or GPU, RAM or VRAM, OS version, and driver, CUDA, ROCm or Xcode versions. Hosts and ranks when it runs on several.
placeholder: Apple M4 Max, 128 GB, macOS 26.1
validations:
required: true
- type: textarea
id: model
attributes:
label: Checkpoint and revision
description: Repository and immutable revision, format or quantization, and the drafter and its revision. "n/a" for a model-free bug.
placeholder: org/model at revision 0123abcd, 4-bit, drafter org/drafter at revision 4567ef01
validations:
required: true
- type: textarea
id: command
attributes:
label: Exact command and request
description: The full launch command, environment options by name, and a public request JSON, token IDs or a script that generates them.
render: shell
validations:
required: true
- type: textarea
id: logs
attributes:
label: Startup output, error and logs
description: The startup lines, error or stack trace, and exit status. Say why if none is available.
render: shell
validations:
required: true
- type: textarea
id: mismatch
attributes:
label: Token mismatch details
description: Optional. The first differing index, both token arrays or `token_sha` hashes, and the drafted and plain settings.
- type: textarea
id: related
attributes:
label: Related issues and pull requests
description: Links to similar reports and how this one differs, or "none found".
validations:
required: true
- type: checkboxes
id: privacy
attributes:
label: Privacy
options:
- label: This report holds no private paths, hostnames, tokens, keys or confidential prompts.
required: true
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: Contributing guide
url: https://github.com/ashhart/TensorFold/blob/main/CONTRIBUTING.md
about: Build, exactness, receipts and the issue-first rule for families, backends and arithmetic.
- name: Agent radar
url: https://tensorfold.dev/atc
about: See which issues contributors and agents are working on before choosing one.
- name: Known issues
url: https://github.com/ashhart/TensorFold/blob/main/docs/known-issues.md
about: Problems we already know about, and their workarounds.
- name: Runbook
url: https://github.com/ashhart/TensorFold/blob/main/RUNBOOK.md
about: Installing and running a TensorFold server, with a troubleshooting section.
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Feature request
description: A new capability or workflow improvement. Use the proposal form for a model family, backend or arithmetic change.
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Describe the problem first; a proposed design is welcome but optional.
Do not paste private paths, hostnames, tokens, keys or confidential prompts. Maintainers may relabel the issue.
- type: dropdown
id: component
attributes:
label: Component
options:
- Engine or server
- Desktop app
- Mobile app
- Tools, build or CI
- Documentation or website
- Other
validations:
required: true
- type: textarea
id: problem
attributes:
label: Problem or use case
description: What you are trying to do and what gets in the way.
validations:
required: true
- type: textarea
id: current
attributes:
label: Current behavior
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed behavior and how to verify it
description: What a user would see, and the checks that would show it works.
validations:
required: true
- type: textarea
id: scope
attributes:
label: Scope and exclusions
description: What this includes and what it leaves out.
validations:
required: true
- type: textarea
id: effects
attributes:
label: Compatibility, API and security effects
description: Optional. Changes to flags, endpoints, defaults or stored data.
- type: textarea
id: alternatives
attributes:
label: Alternatives tried
description: Optional.
- type: textarea
id: environment
attributes:
label: Version, hardware and checkpoint
description: Optional, unless the feature depends on them. The TensorFold version or commit, GPU, and checkpoint and revision.
- type: textarea
id: related
attributes:
label: Related issues and pull requests
description: Links to similar requests and how this one differs, or "none found".
validations:
required: true
138 changes: 138 additions & 0 deletions .github/ISSUE_TEMPLATE/performance.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
name: Performance or memory regression
description: TensorFold is slower or uses more memory than it did, or than it should.
body:
- type: markdown
attributes:
value: |
Measure before and after on the same machine, checkpoint, prompts and settings, as CONTRIBUTING.md describes.
A suspected regression is welcome without a patch. Write "n/a" and why for a field that does not apply.
Do not paste private paths, hostnames, tokens, keys or confidential prompts. Maintainers may relabel the issue.
- type: dropdown
id: component
attributes:
label: Component
options:
- Engine or server
- Desktop app
- Mobile app
- Tools, build or CI
- Other
validations:
required: true
- type: dropdown
id: metric
attributes:
label: Metric
multiple: true
options:
- Decode speed
- Prompt processing or time to first token
- Concurrent throughput
- Pauses between tokens
- Memory
- Startup or build time
- Other
validations:
required: true
- type: input
id: versions
attributes:
label: Baseline and candidate versions or commits
description: The faster or smaller one and the slower or larger one. Say whether either is a fork with changes.
placeholder: 1.1.8 release archive and 1.1.9 release archive
validations:
required: true
- type: dropdown
id: backend
attributes:
label: Backend
multiple: true
options:
- Metal
- CUDA
- HIP
- XPU
- None (no GPU involved)
- Other
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating system
multiple: true
options:
- macOS
- Linux
- Windows
- iOS
- Android
validations:
required: true
- type: textarea
id: hardware
attributes:
label: Hardware and runtime
description: Chip or GPU, RAM or VRAM, OS version, and driver, CUDA, ROCm or Xcode versions. Hosts and ranks when it runs on several, and any other load.
validations:
required: true
- type: textarea
id: model
attributes:
label: Checkpoint and revision
description: Repository and immutable revision, format or quantization, and the drafter and its revision. "n/a" for a model-free measurement.
validations:
required: true
- type: textarea
id: command
attributes:
label: Exact commands and inputs
description: |
The server and client commands, public prompt IDs, token arrays or a generator, and the settings:
drafts, sampling, thinking, precision, output length, concurrent streams, and cache cold or warm with cached-token counts.
render: shell
validations:
required: true
- type: textarea
id: results
attributes:
label: Results
description: |
Baseline and candidate values with units, the repetitions, the run order and the spread.
For memory, the peak physical process footprint and any device or pinned allocations, with the RAM class and context.
validations:
required: true
- type: textarea
id: equality
attributes:
label: Token equality
description: Whether both runs gave the same tokens, or why tokens do not apply.
validations:
required: true
- type: textarea
id: receipt
attributes:
label: Raw output
description: The tool output or log behind the results, or why it is missing.
render: shell
validations:
required: true
- type: textarea
id: extra
attributes:
label: First bad commit, profile or suspected cause
description: Optional. A bisect result, a profile, or a comparison with another server such as `mlx_lm` or vLLM.
- type: textarea
id: related
attributes:
label: Related issues and pull requests
description: Links to similar reports and how this one differs, or "none found".
validations:
required: true
- type: checkboxes
id: privacy
attributes:
label: Privacy
options:
- label: This report holds no private paths, hostnames, tokens, keys or confidential prompts.
required: true
Loading
Loading