From 1b154a5b706f2ec0b5dd2636267a88a995e48090 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iker=20Garc=C3=ADa-Ferrero?= Date: Mon, 9 Oct 2023 16:17:37 +0200 Subject: [PATCH] Create issue templates --- .../\342\234\215\357\270\217-other-issue.md" | 12 ++++ ...\360\237\220\233-bug-report-and-issues.md" | 56 +++++++++++++++++++ ...237\223\221-new-task-dataset-proposals.md" | 20 +++++++ .../\360\237\232\200-feature-request.md" | 18 ++++++ 4 files changed, 106 insertions(+) create mode 100644 ".github/ISSUE_TEMPLATE/\342\234\215\357\270\217-other-issue.md" create mode 100644 ".github/ISSUE_TEMPLATE/\360\237\220\233-bug-report-and-issues.md" create mode 100644 ".github/ISSUE_TEMPLATE/\360\237\223\221-new-task-dataset-proposals.md" create mode 100644 ".github/ISSUE_TEMPLATE/\360\237\232\200-feature-request.md" diff --git "a/.github/ISSUE_TEMPLATE/\342\234\215\357\270\217-other-issue.md" "b/.github/ISSUE_TEMPLATE/\342\234\215\357\270\217-other-issue.md" new file mode 100644 index 00000000..3cc26e1a --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\342\234\215\357\270\217-other-issue.md" @@ -0,0 +1,12 @@ +--- +name: "✍️ Other Issue" +about: For issues not covered by the other templates. +title: '' +labels: '' +assignees: '' + +--- + +Please proviede a concise description of your issue. Proviede as much information as possible, including, if required, your system hardware, software version... and any other info that could be usefull to find a solution. + +Please, If you want to report a bug, or any error you found while running the code, use the "Bug report and Issues" Template. diff --git "a/.github/ISSUE_TEMPLATE/\360\237\220\233-bug-report-and-issues.md" "b/.github/ISSUE_TEMPLATE/\360\237\220\233-bug-report-and-issues.md" new file mode 100644 index 00000000..d2eebf2e --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\360\237\220\233-bug-report-and-issues.md" @@ -0,0 +1,56 @@ +--- +name: "\U0001F41B Bug report and Issues" +about: Submit a bug report to help us improve GoLLIE +title: "[BUG] Bug or issue report" +labels: '' +assignees: '' + +--- + +**Describe the task** +1. Model: Which GoLLIE model are you attemping to run? +2. Task: Which task are you attemping to run (training, evaluation, generate the dataset,...)? + +**Describe the bug** +A clear and concise description of what the bug is. You can add the error traceback or screenshots here. + +**To Reproduce** +Steps to reproduce the behavior: +1. Load model X +```Python +model, tokenizer = load_model( + inference=True, + model_weights_name_or_path="HiTZ/GoLLIE-7B", + quantization=None, + use_lora=False, + force_auto_device_map=True, + use_flash_attention=True, + torch_dtype="bfloat16" +) +``` +2. Run X function +```Python +model_ouput = model.generate( + **model_input.to(model.device), + max_new_tokens=128, + do_sample=False, + min_new_tokens=0, + num_beams=1, + num_return_sequences=1, +) +``` +3. Any other step required to reproduce the behaviour + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**System Info** +1. GPU: (i.e Nvidia A100) +2. Pytorch version: +3. Transformers version: +4. Model configuration: Are you using 4 / 8 bits quantization? Are you using mGPU? etc.. +5. Any other relevant information: + + +**Additional context** +Add any other context about the problem here. diff --git "a/.github/ISSUE_TEMPLATE/\360\237\223\221-new-task-dataset-proposals.md" "b/.github/ISSUE_TEMPLATE/\360\237\223\221-new-task-dataset-proposals.md" new file mode 100644 index 00000000..5133267a --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\360\237\223\221-new-task-dataset-proposals.md" @@ -0,0 +1,20 @@ +--- +name: "\U0001F4D1 New Task/Dataset Proposals" +about: Submit a proposal/request for a new task support in GoLLIE +title: "[TASK] I want task X to be supported by GoLLIE" +labels: '' +assignees: '' + +--- + +**Describe the task you'd like to implement** +A clear and concise description of the task/dataset. If you want to propose a new dataset, please explain if the task is already supported by GoLLIE (i.e Named Entity Recognition, Event Extraction, Relation Extraction...). If it is not, explain how you would implement it. + +**Data** +Is the data for the task publicly available? If it is, provide a link to it. If it is not, explain how the data can be obtained. + +**Guidelines** +Are guidelines available? If guidelines are available, provide a link to them. If they are not, describe how you would generate them. + +**Your contribution** +Is there any way that you could help, e.g. by submitting a PR? diff --git "a/.github/ISSUE_TEMPLATE/\360\237\232\200-feature-request.md" "b/.github/ISSUE_TEMPLATE/\360\237\232\200-feature-request.md" new file mode 100644 index 00000000..2d28a70b --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\360\237\232\200-feature-request.md" @@ -0,0 +1,18 @@ +--- +name: "\U0001F680 Feature request" +about: Submit a proposal/request for a new transformers feature +title: "[FEATURE] I want feature X supported by GoLLIE" +labels: '' +assignees: '' + +--- + +**Feature request** +A clear and concise description of the feature proposal. + +**Motivation** +Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too. + + +**Your contribution** +Is there any way that you could help, e.g. by submitting a PR?