From c11a49573fc4ca8560e1c66ce3b4e0a8c5b54312 Mon Sep 17 00:00:00 2001 From: Lysandre Debut Date: Mon, 18 Apr 2022 17:43:21 -0300 Subject: [PATCH] Refactor issues with yaml (#16772) * Refactor issues with yaml * Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Anton Lozhkov * Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Anton Lozhkov * Update .github/ISSUE_TEMPLATE/feature-request.yml Co-authored-by: Sanchit Gandhi <93869735+sanchit-gandhi@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Patrick von Platen * Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: Patrick von Platen * Address review comments Co-authored-by: Anton Lozhkov Co-authored-by: Sanchit Gandhi <93869735+sanchit-gandhi@users.noreply.github.com> Co-authored-by: Patrick von Platen --- .github/ISSUE_TEMPLATE/---new-benchmark.md | 22 ---- .../ISSUE_TEMPLATE/--new-model-addition.md | 20 --- .github/ISSUE_TEMPLATE/bug-report.md | 107 ---------------- .github/ISSUE_TEMPLATE/bug-report.yml | 121 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 9 ++ .github/ISSUE_TEMPLATE/feature-request.md | 25 ---- .github/ISSUE_TEMPLATE/feature-request.yml | 31 +++++ .github/ISSUE_TEMPLATE/migration.md | 58 --------- .github/ISSUE_TEMPLATE/migration.yml | 72 +++++++++++ .github/ISSUE_TEMPLATE/new-model-addition.yml | 31 +++++ .github/ISSUE_TEMPLATE/question-help.md | 26 ---- 11 files changed, 264 insertions(+), 258 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/---new-benchmark.md delete mode 100644 .github/ISSUE_TEMPLATE/--new-model-addition.md delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/migration.md create mode 100644 .github/ISSUE_TEMPLATE/migration.yml create mode 100644 .github/ISSUE_TEMPLATE/new-model-addition.yml delete mode 100644 .github/ISSUE_TEMPLATE/question-help.md diff --git a/.github/ISSUE_TEMPLATE/---new-benchmark.md b/.github/ISSUE_TEMPLATE/---new-benchmark.md deleted file mode 100644 index 9e1c20689e0..00000000000 --- a/.github/ISSUE_TEMPLATE/---new-benchmark.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: "\U0001F5A5 New benchmark" -about: Benchmark a part of this library and share your results -title: "[Benchmark]" -labels: '' -assignees: '' - ---- - -# 🖥 Benchmarking `transformers` - -## Benchmark - -Which part of `transformers` did you benchmark? - -## Set-up - -What did you run your benchmarks on? Please include details, such as: CPU, GPU? If using multiple GPUs, which parallelization did you use? - -## Results - -Put your results here! diff --git a/.github/ISSUE_TEMPLATE/--new-model-addition.md b/.github/ISSUE_TEMPLATE/--new-model-addition.md deleted file mode 100644 index 938c0f46052..00000000000 --- a/.github/ISSUE_TEMPLATE/--new-model-addition.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: "\U0001F31F New model addition" -about: Submit a proposal/request to implement a new Transformer-based model -title: '' -labels: New model -assignees: '' - ---- - -# 🌟 New model addition - -## Model description - - - -## Open source status - -* [ ] the model implementation is available: (give details) -* [ ] the model weights are available: (give details) -* [ ] who are the authors: (mention them, if possible by @gh-username) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index fc185cd3783..00000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -name: "\U0001F41B Bug Report" -about: Submit a bug report to help us improve transformers -title: '' -labels: '' -assignees: '' - ---- - - -## Environment info - - -- `transformers` version: -- Platform: -- Python version: -- PyTorch version (GPU?): -- Tensorflow version (GPU?): -- Using GPU in script?: -- Using distributed or parallel set-up in script?: - -### Who can help - - -## Information - -Model I am using (Bert, XLNet ...): - -The problem arises when using: -* [ ] the official example scripts: (give details below) -* [ ] my own modified scripts: (give details below) - -The tasks I am working on is: -* [ ] an official GLUE/SQUaD task: (give the name) -* [ ] my own task or dataset: (give details below) - -## To reproduce - -Steps to reproduce the behavior: - -1. -2. -3. - - - -## Expected behavior - - diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000000..90811bea1a2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,121 @@ +name: "\U0001F41B Bug Report" +description: Submit a bug report to help us import transformers +labels: [ "bug" ] +body: + - type: textarea + id: system-info + attributes: + label: System Info + description: Please share your system info with us. You can run the command `transformers-cli env` and copy-paste its output below. + render: shell + placeholder: transformers version, platform, python version, ... + validations: + required: true + + - type: textarea + id: who-can-help + attributes: + label: Who can help? + description: | + Your issue will be replied to more quickly if you can figure out the right person to tag with @ + If you know how to use git blame, that is the easiest way, otherwise, here is a rough guide of **who to tag**. + Please tag fewer than 3 people. + + Models: + + - ALBERT, BERT, XLM, DeBERTa, DeBERTa-v2, ELECTRA, MobileBert, SqueezeBert: `@LysandreJik` + - T5, Pegasus, EncoderDecoder: `@patrickvonplaten` + - Blenderbot, MBART, BART, Marian, Pegasus: `@patil-suraj` + - Reformer, TransfoXL, XLNet, FNet: `@patrickvonplaten` + - Longformer, BigBird: `@ydshieh` + - FSMT: `@stas00` + - Funnel: `@sgugger` + - GPT-2, GPT: `@patil-suraj`, `@patrickvonplaten`, `@LysandreJik` + - RAG, DPR: `@patrickvonplaten`, `@lhoestq` + - TensorFlow: `@Rocketknight1` + - JAX/Flax: `@patil-suraj` + - TAPAS, LayoutLM, LayoutLMv2, LUKE, ViT, BEiT, DEiT, DETR, CANINE: `@NielsRogge` + - GPT-Neo, GPT-J, CLIP: `@patil-suraj` + - Wav2Vec2, HuBERT, UniSpeech, UniSpeechSAT, SEW, SEW-D: `@patrickvonplaten`, `@anton-l` + - SpeechEncoderDecoder, Speech2Text, Speech2Text2: `@sanchit-gandhi`, `@patrickvonplaten`, `@anton-l` + + If the model isn't in the list, ping `@LysandreJik` who will redirect you to the correct contributor. + + Library: + - Benchmarks: `@patrickvonplaten` + - Deepspeed: `@stas00` + - Ray/raytune: `@richardliaw`, `@amogkam` + - Text generation: `@patrickvonplaten`, `@Narsil`, `@gante` + - Tokenizers: `@SaulLu` + - Trainer: `@sgugger` + - Pipelines: `@Narsil` + - Speech: `@patrickvonplaten`, `@anton-l`, `@sanchit-gandhi` + - Vision: `@NielsRogge`, `@sgugger` + + Documentation: `@sgugger`, `@stevhliu` + + Model hub: + + - for issues with a model, report at https://discuss.huggingface.co/ and tag the model's creator. + + HF projects: + + - datasets: [different repo](https://github.com/huggingface/datasets) + - rust tokenizers: [different repo](https://github.com/huggingface/tokenizers) + + Examples: + + - maintained examples (not research project or legacy): `@sgugger`, `@patil-suraj` + + For research projetcs, please ping the contributor directly. For example, on the following projects: + + - research_projects/bert-loses-patience: `@JetRunner` + - research_projects/distillation: `@VictorSanh` + placeholder: "@Username ..." + + - type: checkboxes + id: information-scripts-examples + attributes: + label: Information + description: 'The problem arises when using:' + options: + - label: "The official example scripts" + - label: "My own modified scripts" + + - type: checkboxes + id: information-tasks + attributes: + label: Tasks + description: "The tasks I am working on are:" + options: + - label: "An officially supported task in the `examples` folder (such as GLUE/SQuAD, ...)" + - label: "My own task or dataset (give details below)" + + - type: textarea + id: reproduction + validations: + required: true + attributes: + label: Reproduction + description: | + Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet. + If you have code snippets, error messages, stack traces please provide them here as well. + Important! Use code tags to correctly format your code. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting + Do not use screenshots, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code. + + placeholder: | + Steps to reproduce the behavior: + + 1. + 2. + 3. + + + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: Expected behavior + description: "A clear and concise description of what you would expect to happen." + render: shell \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..8694e16f749 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,9 @@ +blank_issues_enabled: true +version: 2.1 +contact_links: + - name: Website Related + url: https://github.com/huggingface/hub-docs/issues + about: Feature requests and bug reports related to the website + - name: Forum + url: https://discuss.huggingface.co/ + about: General usage questions and community discussions \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index f54f43ae5a6..00000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: "\U0001F680 Feature request" -about: Submit a proposal/request for a new transformers feature -title: '' -labels: '' -assignees: '' - ---- - -# 🚀 Feature request - - - -## Motivation - - - -## Your contribution - - diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000000..318dc1f9b28 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,31 @@ +name: "\U0001F680 Feature request" +description: Submit a proposal/request for a new transformers feature +labels: [ "feature" ] +body: + - type: textarea + id: feature-request + validations: + required: true + attributes: + label: Feature request + description: | + A clear and concise description of the feature proposal. Please provide a link to the paper and code in case they exist. + + - type: textarea + id: motivation + validations: + required: true + attributes: + label: Motivation + description: | + 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. + + + - type: textarea + id: contribution + validations: + required: true + attributes: + label: Your contribution + description: | + Is there any way that you could help, e.g. by submitting a PR? Make sure to read the CONTRIBUTING.MD [readme](https://github.com/huggingface/transformers/blob/main/CONTRIBUTING.md) diff --git a/.github/ISSUE_TEMPLATE/migration.md b/.github/ISSUE_TEMPLATE/migration.md deleted file mode 100644 index 2402568cb18..00000000000 --- a/.github/ISSUE_TEMPLATE/migration.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: "\U0001F4DA Migration from pytorch-pretrained-bert or pytorch-transformers" -about: Report a problem when migrating from pytorch-pretrained-bert or pytorch-transformers - to transformers -title: '' -labels: Migration -assignees: '' - ---- - -# 📚 Migration - -## Information - - - -Model I am using (Bert, XLNet ...): - -Language I am using the model on (English, Chinese ...): - -The problem arises when using: -* [ ] the official example scripts: (give details below) -* [ ] my own modified scripts: (give details below) - -The tasks I am working on is: -* [ ] an official GLUE/SQUaD task: (give the name) -* [ ] my own task or dataset: (give details below) - -## Details - - - -## Environment info - - -- `transformers` version: -- Platform: -- Python version: -- PyTorch version (GPU?): -- Tensorflow version (GPU?): -- Using GPU in script?: -- Using distributed or parallel set-up in script?: - - -* `pytorch-transformers` or `pytorch-pretrained-bert` version (or branch): - - -## Checklist - -- [ ] I have read the migration guide in the readme. - ([pytorch-transformers](https://github.com/huggingface/transformers#migrating-from-pytorch-transformers-to-transformers); - [pytorch-pretrained-bert](https://github.com/huggingface/transformers#migrating-from-pytorch-pretrained-bert-to-transformers)) -- [ ] I checked if a related official extension example runs on my machine. diff --git a/.github/ISSUE_TEMPLATE/migration.yml b/.github/ISSUE_TEMPLATE/migration.yml new file mode 100644 index 00000000000..778413141b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/migration.yml @@ -0,0 +1,72 @@ +name: "\U0001F4DA Migration from pytorch-pretrained-bert or pytorch-transformers" +description: Report a problem when migrating from pytorch-pretrained-bert or pytorch-transformers to transformers +labels: [ "migration" ] +body: + - type: textarea + id: system-info + attributes: + label: System Info + description: Please share your system info with us. You can run the command `transformers-cli env` and copy-paste its output below. + render: shell + placeholder: transformers version, platform, python version, ... + validations: + required: true + + - type: checkboxes + id: information-scripts-examples + attributes: + label: Information + description: 'The problem arises when using:' + options: + - label: "The official example scripts" + - label: "My own modified scripts" + + - type: checkboxes + id: information-tasks + attributes: + label: Tasks + description: "The tasks I am working on are:" + options: + - label: "An officially supported task in the `examples` folder (such as GLUE/SQuAD, ...)" + - label: "My own task or dataset (give details below)" + + - type: textarea + id: reproduction + validations: + required: true + attributes: + label: Reproduction + description: | + Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet. + If you have code snippets, error messages, stack traces please provide them here as well. + Important! Use code tags to correctly format your code. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting + Do not use screenshots, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code. + + placeholder: | + Steps to reproduce the behavior: + + 1. + 2. + 3. + + + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: Expected behavior + description: "A clear and concise description of what you would expect to happen." + render: shell + + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: "I have read the migration guide in the readme. + ([pytorch-transformers](https://github.com/huggingface/transformers#migrating-from-pytorch-transformers-to-transformers); + [pytorch-pretrained-bert](https://github.com/huggingface/transformers#migrating-from-pytorch-pretrained-bert-to-transformers))" + required: true + - label: "I checked if a related official extension example runs on my machine." + required: true diff --git a/.github/ISSUE_TEMPLATE/new-model-addition.yml b/.github/ISSUE_TEMPLATE/new-model-addition.yml new file mode 100644 index 00000000000..2f3476d3ab0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-model-addition.yml @@ -0,0 +1,31 @@ +name: "\U0001F31F New model addition" +description: Submit a proposal/request to implement a new model +labels: [ "New model" ] + +body: + - type: textarea + id: description-request + validations: + required: true + attributes: + label: Model description + description: | + Put any and all important information relative to the model + + - type: checkboxes + id: information-tasks + attributes: + label: Open source status + description: | + Please note that if the model implementation isn't available or if the weights aren't open-source, we are less likely to implement it in `transformers`. + options: + - label: "The model implementation is available" + - label: "The model weights are available" + + - type: textarea + id: additional-info + attributes: + label: Provide useful links for the implementation + description: | + Please provide information regarding the implementation, the weights, and the authors. + Please mention the authors by @gh-username if you're aware of their usernames. diff --git a/.github/ISSUE_TEMPLATE/question-help.md b/.github/ISSUE_TEMPLATE/question-help.md deleted file mode 100644 index 87a1a53c1ce..00000000000 --- a/.github/ISSUE_TEMPLATE/question-help.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: "❓ Questions & Help" -about: Post your general questions on the Hugging Face forum: https://discuss.huggingface.co/ -title: '' -labels: '' -assignees: '' - ---- - -# ❓ Questions & Help - - - -## Details - - - - - -**A link to original question on the forum**: - - \ No newline at end of file