Tarun Menta
commited on
Commit
Β·
9e8bf27
1
Parent(s):
6e60c88
Update issue templates
Browse files
.github/ISSUE_TEMPLATE/breaking-bug-report.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
name: Breaking bug report
|
| 3 |
+
about: Create a report about a breaking bug
|
| 4 |
+
title: "[BUG: Breaking]"
|
| 5 |
+
labels: 'bug: breaking'
|
| 6 |
+
assignees: ''
|
| 7 |
+
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
## 𧨠Describe the Bug
|
| 11 |
+
|
| 12 |
+
A clear and concise description of the breaking issue (e.g., crash, OOM, exception, etc).
|
| 13 |
+
|
| 14 |
+
## π Input Document
|
| 15 |
+
|
| 16 |
+
Attach the PDF or input file that triggered the error.
|
| 17 |
+
|
| 18 |
+
## π€ Output Trace / Stack Trace
|
| 19 |
+
|
| 20 |
+
Paste the **complete** stack trace or error output, if available.
|
| 21 |
+
|
| 22 |
+
<details>
|
| 23 |
+
<summary>Click to expand</summary>
|
| 24 |
+
|
| 25 |
+
```
|
| 26 |
+
Paste stack trace here
|
| 27 |
+
```
|
| 28 |
+
|
| 29 |
+
</details>
|
| 30 |
+
|
| 31 |
+
## βοΈ Environment
|
| 32 |
+
|
| 33 |
+
Please fill in all relevant details:
|
| 34 |
+
|
| 35 |
+
- **Marker version**:
|
| 36 |
+
- **Surya version**:
|
| 37 |
+
- **Python version**:
|
| 38 |
+
- **PyTorch version**:
|
| 39 |
+
- **Transformers version**:
|
| 40 |
+
- **Operating System** (incl. container info if relevant):
|
| 41 |
+
|
| 42 |
+
## β
Expected Behavior
|
| 43 |
+
|
| 44 |
+
What did you expect Marker to do?
|
| 45 |
+
|
| 46 |
+
## π Command or Code Used
|
| 47 |
+
|
| 48 |
+
Paste the **exact bash command** or **Python code** you used to run Marker:
|
| 49 |
+
|
| 50 |
+
<details>
|
| 51 |
+
<summary>Click to expand</summary>
|
| 52 |
+
|
| 53 |
+
```bash
|
| 54 |
+
# or Python code block
|
| 55 |
+
your_command_here --with-flags
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
</details>
|
| 59 |
+
|
| 60 |
+
## π Additional Context
|
| 61 |
+
|
| 62 |
+
Any other context that might help us debug this (e.g., CLI options, working directory, runtime settings).
|
.github/ISSUE_TEMPLATE/feature_request.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
name: Feature request
|
| 3 |
+
about: Suggest an idea for this project
|
| 4 |
+
title: "[FEAT]"
|
| 5 |
+
labels: enhancement
|
| 6 |
+
assignees: ''
|
| 7 |
+
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
## β¨ Is your feature request related to a problem?
|
| 11 |
+
|
| 12 |
+
A clear and concise description of what the problem is.
|
| 13 |
+
|
| 14 |
+
## π‘ Describe the Solution You'd Like
|
| 15 |
+
|
| 16 |
+
A concise description of what you want to happen or how you envision it working.
|
| 17 |
+
|
| 18 |
+
## π Alternatives Considered
|
| 19 |
+
|
| 20 |
+
Any alternative solutions or workarounds you've tried.
|
| 21 |
+
|
| 22 |
+
## π§© Additional Context
|
| 23 |
+
|
| 24 |
+
Any additional context, references, or related issues.
|
.github/ISSUE_TEMPLATE/output-bug-report.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
name: Output bug report
|
| 3 |
+
about: Create a report about poor output quality
|
| 4 |
+
title: "[BUG: Output]"
|
| 5 |
+
labels: 'bug: output'
|
| 6 |
+
assignees: ''
|
| 7 |
+
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
## π Describe the Output Issue
|
| 11 |
+
|
| 12 |
+
A clear and concise description of the incorrect or unexpected output.
|
| 13 |
+
|
| 14 |
+
## π Input Document
|
| 15 |
+
|
| 16 |
+
Attach the PDF or input file used.
|
| 17 |
+
|
| 18 |
+
## π€ Current Output
|
| 19 |
+
|
| 20 |
+
Paste the Markdown or HTML that Marker generated:
|
| 21 |
+
|
| 22 |
+
````markdown
|
| 23 |
+
Paste output here
|
| 24 |
+
`````
|
| 25 |
+
|
| 26 |
+
## β
Expected Output
|
| 27 |
+
|
| 28 |
+
Describe or paste what you expected Marker to generate.
|
| 29 |
+
|
| 30 |
+
## βοΈ Environment
|
| 31 |
+
|
| 32 |
+
Please fill in all relevant details:
|
| 33 |
+
|
| 34 |
+
* **Marker version**:
|
| 35 |
+
* **Surya version**:
|
| 36 |
+
* **Python version**:
|
| 37 |
+
* **PyTorch version**:
|
| 38 |
+
* **Transformers version**:
|
| 39 |
+
* **Operating System**:
|
| 40 |
+
|
| 41 |
+
## π Command or Code Used
|
| 42 |
+
|
| 43 |
+
Paste the **exact bash command** or **Python code** you used to run Marker:
|
| 44 |
+
|
| 45 |
+
<details>
|
| 46 |
+
<summary>Click to expand</summary>
|
| 47 |
+
|
| 48 |
+
```bash
|
| 49 |
+
# or Python code block
|
| 50 |
+
your_command_here --with-flags
|
| 51 |
+
```
|
| 52 |
+
|
| 53 |
+
</details>
|
| 54 |
+
|
| 55 |
+
## π Additional Context
|
| 56 |
+
|
| 57 |
+
Any other relevant info, configs, or assumptions.
|