Skip to content

Commit

Permalink
Merge branch 'main' into add-siglip
Browse files Browse the repository at this point in the history
  • Loading branch information
xenova committed Dec 24, 2023
2 parents 0123984 + 7636a1c commit 290f9f3
Show file tree
Hide file tree
Showing 58 changed files with 6,771 additions and 1,300 deletions.
40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/1_bug-report.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: "🐛 Bug Report"
description: Submit a bug report to help us improve transformers.js
labels: [ "bug" ]
body:
- type: textarea
id: system-info
attributes:
label: System Info
description: Please share your system info with us. If you are using other JS libraries/frameworks (e.g., React or Next.js), please include their versions too.
placeholder: transformers.js version, browser (if applicable), operating system, Node.js version, bundlers, ...
validations:
required: true

- type: checkboxes
id: environment-or-platform
attributes:
label: Environment/Platform
description: "The environment I am running in, or platform I am developing for:"
options:
- label: "Website/web-app"
- label: "Browser extension"
- label: "Server-side (e.g., Node.js, Deno, Bun)"
- label: "Desktop app (e.g., Electron)"
- label: "Other (e.g., VSCode extension)"

- type: textarea
id: description
validations:
required: true
attributes:
label: Description
description: A clear and concise description of the bug, as well as what you expected to happen.

- type: textarea
id: reproduction
validations:
required: true
attributes:
label: Reproduction
description: |
Please provide a code sample that reproduces the problem you ran into. If you have code snippets, error messages, or stack traces, please provide them here as well.
Important! Use [code tags](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) to correctly format your code.
placeholder: |
Steps to reproduce the behavior:
1.
2.
3.
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/2_feature-request.md

This file was deleted.

40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/2_new_model.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: "🌟 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: |
Include important information about the model.
- type: checkboxes
id: information-tasks
attributes:
label: Prerequisites
description: |
Please note that Transformers.js relies on the model first being supported in [🤗 Transformers](https://github.com/huggingface/transformers) and [🤗 Optimum](https://github.com/huggingface/optimum). If the model you are requesting is not yet supported by either of them, feel free to open up a model request there too.
options:
- label: "The model is supported in Transformers (i.e., listed [here](https://huggingface.co/docs/transformers/index#supported-models-and-frameworks))"
- label: "The model can be exported to ONNX with Optimum (i.e., listed [here](https://huggingface.co/docs/optimum/main/en/exporters/onnx/overview))"

- type: textarea
id: additional-info
attributes:
label: Additional information
description: |
Please provide additional information about the model here.
If the model is already supported in Transformers, you can provide example Python code to help ensure the JavaScript implementation (and output) matches the original version.
- 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?
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/3_new_pipeline.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: "🔧 New pipeline addition"
description: Submit a proposal/request to implement a new pipeline
labels: [ "new pipeline" ]

body:
- type: textarea
id: description-request
validations:
required: true
attributes:
label: Pipeline description
description: |
Include important information about the pipeline.
- type: checkboxes
id: information-tasks
attributes:
label: Prerequisites
description: |
Please note that Transformers.js relies on the pipeline first being supported in [🤗 Transformers](https://github.com/huggingface/transformers). If the pipeline you are requesting is not yet supported by Transformers, feel free to open up a feature request for it there too.
options:
- label: "The pipeline is supported in Transformers (i.e., listed [here](https://huggingface.co/docs/transformers/main_classes/pipelines))"
- label: "The task is listed [here](https://huggingface.co/tasks)"

- type: textarea
id: additional-info
attributes:
label: Additional information
description: |
Please provide additional information about the pipeline here. If the pipeline is already supported in Transformers, you can provide example Python code to help ensure the JavaScript implementation (and output) matches the original version.
- 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?
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/3_question.md

This file was deleted.

30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/4_feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: "🚀 Feature request"
description: Submit a proposal/request for a new transformers.js feature
labels: [ "enhancement" ]
body:
- type: textarea
id: feature-request
validations:
required: true
attributes:
label: Feature request
description: |
A clear and concise description of the feature proposal. If the feature is already part of the [Transformers](https://github.com/huggingface/transformers) library, please provide relevant links or example usage.
- type: textarea
id: motivation
validations:
required: true
attributes:
label: Motivation
description: |
Please outline the motivation for the proposal. Why is it important that we add this feature? What is your intended use case?
- 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?
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/5_question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: "🙋 Question"
description: Ask a question about the library
labels: [ "question" ]

body:
- type: textarea
id: question
validations:
required: true
attributes:
label: Question
description: |
Please enter your question here...
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
blank_issues_enabled: true
version: 2.1
contact_links:
- name: Models on the Hugging Face Hub
url: https://huggingface.co/models?library=transformers.js
about: Open a Pull request / Discussion related to a specific model checkpoint directly on the Hugging Face Hub
- name: Documentation
url: https://huggingface.co/docs/transformers.js
about: View the transformers.js documentation
12 changes: 0 additions & 12 deletions .github/workflows/delete-doc-comment-trigger.yml

This file was deleted.

14 changes: 0 additions & 14 deletions .github/workflows/delete-doc-comment.yml

This file was deleted.

Loading

0 comments on commit 290f9f3

Please sign in to comment.