Skip to content

Commit

Permalink
Merge pull request #35 from janhq/add/issue_template
Browse files Browse the repository at this point in the history
Chore: Create github issue template
  • Loading branch information
hahuyhoang411 authored Oct 25, 2024
2 parents dae5a17 + 9ecd3c2 commit 5f8293c
Show file tree
Hide file tree
Showing 2 changed files with 134 additions and 0 deletions.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: GitHub Action Bug Report
description: Report issues with GitHub Actions workflow
title: "[ACTION BUG]: "
labels: ["bug", "github-actions"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting an issue with our GitHub Action!
- type: textarea
id: error_output
attributes:
label: Error Output
description: Please provide the GitHub Actions error output
render: shell
validations:
required: true

- type: input
id: action_issue_url
attributes:
label: Coresponding Action Issue
description: Link to the issue in the action repository
placeholder: "https://github.com/XXX"
validations:
required: true

- type: textarea
id: mode_name
attributes:
label: Model Name
description: Which model are you converting?
placeholder: Describe the model and its release date
validations:
required: true

- type: input
id: llama_issue_ref
attributes:
label: Related llama.cpp Issue/PR
description: Find related llama.cpp issue or PR to the model you are converting
placeholder: "https://github.com/ggerganov/llama.cpp/issues/XXX"
validations:
required: false

- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Add any other context about the problem here
placeholder: |
- Custom build flags used
- Modified parameters
- System specifications
- Any other relevant information
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/new-model.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: "New Model"
description: "Request a new model to be converted"
title: "feat: [MODEL_NAME]"
labels: ["type: model request", "new model"]
body:
- type: markdown
attributes:
value: |
Thanks for submitting a model request!
- type: input
id: model_name
attributes:
label: Model Name
description: The name of the model you want to be added
placeholder: "e.g., homebrewltd/mini-Ichigo-llama3.2-3B-s-instruct"
validations:
required: true

- type: input
id: model_source
attributes:
label: Model Source
description: Link to the model (HuggingFace)
placeholder: "https://huggingface.co/XXX"
validations:
required: true

- type: input
id: model_repo
attributes:
label: Model Cortexso HuggingFace Repo
description: Link to the model (HuggingFace)
placeholder: "https://huggingface.co/XXX"
validations:
required: true

- type: textarea
id: model_description
attributes:
label: Model Description
description: Brief description of the model and why it should be added
placeholder: |
- Why would it be valuable to include?
validations:
required: true

- type: checkboxes
attributes:
label: "Requested Formats"
description: "Which model formats to be converted into?"
options:
- label: GGUF (llama.cpp)
- label: TensorRT (TensorRT-LLM)
- label: ONNX (Onnx Runtime)

- type: textarea
id: additional_info
attributes:
label: Additional Information
description: Any other relevant information about the model
placeholder: |
- Special requirements or dependencies
- Known limitations or issues
- Benchmark results (if available)
- Other relevant details
- type: checkboxes
id: confirmation
attributes:
label: Confirmation
options:
- label: I have created model.yml and metadata.yml files on cortex.so HugginFace repo
required: true
- label: I have run the model through the model conversion pipeline
required: true
- label: I have tested the model
required: true

0 comments on commit 5f8293c

Please sign in to comment.