Skip to content
This repository has been archived by the owner on Jan 9, 2025. It is now read-only.

Commit

Permalink
chore(component): update instillShortDescription and `instillUIOrde…
Browse files Browse the repository at this point in the history
…r` in components (#40)

Because

- we will use `instillShortDescription` to display short description on
Console.

This commit

- update `instillShortDescription` and `instillUIOrder` in components
  • Loading branch information
donch1989 authored Nov 7, 2023
1 parent 98ac11e commit 98d63cf
Show file tree
Hide file tree
Showing 10 changed files with 81 additions and 447 deletions.
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ require (
github.com/ghodss/yaml v1.0.0
github.com/gofrs/uuid v4.4.0+incompatible
github.com/h2non/filetype v1.1.3
github.com/instill-ai/component v0.6.1-alpha.0.20231106153938-6032b6ce48ed
github.com/instill-ai/component v0.6.1-alpha.0.20231107045726-dc5371eae05c
github.com/instill-ai/protogen-go v0.3.3-alpha.0.20231019202606-71607ddcd93f
github.com/santhosh-tekuri/jsonschema/v5 v5.3.0
github.com/stretchr/testify v1.8.4
Expand Down
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ github.com/grpc-ecosystem/grpc-gateway/v2 v2.7.2 h1:I/pwhnUln5wbMnTyRbzswA0/JxpK
github.com/grpc-ecosystem/grpc-gateway/v2 v2.7.2/go.mod h1:lsuH8kb4GlMdSlI4alNIBBSAt5CHJtg3i+0WuN9J5YM=
github.com/h2non/filetype v1.1.3 h1:FKkx9QbD7HR/zjK1Ia5XiBsq9zdLi5Kf3zGyFTAFkGg=
github.com/h2non/filetype v1.1.3/go.mod h1:319b3zT68BvV+WRj7cwy856M2ehB3HqNOt6sy1HndBY=
github.com/instill-ai/component v0.6.1-alpha.0.20231106153938-6032b6ce48ed h1:cZfbReRzNeNdMEIFNs7oW+6ewxH87GtHGlEkLdDAEqU=
github.com/instill-ai/component v0.6.1-alpha.0.20231106153938-6032b6ce48ed/go.mod h1:aQfeKtOn74cRQJOxvua1mQGpecasDaD+l46C60ILgdA=
github.com/instill-ai/component v0.6.1-alpha.0.20231107045726-dc5371eae05c h1:vMAp210Zvvpxopftwi7WBHWmDmM4pcb8oXd/a4wx2g4=
github.com/instill-ai/component v0.6.1-alpha.0.20231107045726-dc5371eae05c/go.mod h1:aQfeKtOn74cRQJOxvua1mQGpecasDaD+l46C60ILgdA=
github.com/instill-ai/protogen-go v0.3.3-alpha.0.20231019202606-71607ddcd93f h1:hweU93u6qsg8GH/YSogOfa+wOZEnkilGsijcy1xKX7E=
github.com/instill-ai/protogen-go v0.3.3-alpha.0.20231019202606-71607ddcd93f/go.mod h1:q/YL5TZXD9nvmJ7Rih4gY3/B2HT2+GiFdxeZp9D+yE4=
github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8=
Expand Down
28 changes: 28 additions & 0 deletions pkg/huggingface/config/tasks.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$defs": {
"model": {
"description": "The Hugging Face model to be used",
"instillAcceptFormats": [
"string",
"text/*"
Expand Down Expand Up @@ -49,6 +50,7 @@
"type": "object"
},
"string_input": {
"description": "String input",
"instillAcceptFormats": [
"string",
"text/*"
Expand All @@ -68,6 +70,7 @@
"instillUIOrder": 0,
"properties": {
"audio": {
"description": "The audio file",
"instillAcceptFormats": [
"audio/*"
],
Expand Down Expand Up @@ -158,6 +161,7 @@
"array:string",
"array:text/*"
],
"instillShortDescription": "A list of strings corresponding to the earlier replies from the user.",
"instillUIOrder": 1,
"instillUpstreamTypes": [
"value",
Expand Down Expand Up @@ -221,6 +225,7 @@
"number",
"integer"
],
"instillShortDescription": "The amount of time in seconds that the query should take maximum.",
"instillUIOrder": 1,
"instillUpstreamTypes": [
"value",
Expand Down Expand Up @@ -267,6 +272,7 @@
"number",
"integer"
],
"instillShortDescription": "The temperature of the sampling operation.",
"instillUIOrder": 4,
"instillUpstreamTypes": [
"value",
Expand Down Expand Up @@ -296,6 +302,7 @@
"number",
"integer"
],
"instillShortDescription": "Float to define the tokens that are within the sample operation of text generation.",
"instillUIOrder": 6,
"instillUpstreamTypes": [
"value",
Expand Down Expand Up @@ -445,6 +452,7 @@
"instillUIOrder": 0,
"properties": {
"image": {
"description": "The image file",
"instillAcceptFormats": [
"image/*"
],
Expand Down Expand Up @@ -510,6 +518,7 @@
"instillUIOrder": 0,
"properties": {
"image": {
"description": "The image file",
"instillAcceptFormats": [
"image/*"
],
Expand Down Expand Up @@ -583,6 +592,7 @@
"instillUIOrder": 0,
"properties": {
"image": {
"description": "The image file",
"instillAcceptFormats": [
"image/*"
],
Expand Down Expand Up @@ -626,6 +636,7 @@
"instillUIOrder": 0,
"properties": {
"image": {
"description": "The image file",
"instillAcceptFormats": [
"image/*"
],
Expand Down Expand Up @@ -733,6 +744,7 @@
"instillUIOrder": 1,
"properties": {
"context": {
"description": "The context for answering the question.",
"instillAcceptFormats": [
"string",
"text/*"
Expand All @@ -747,6 +759,7 @@
"type": "string"
},
"question": {
"description": "The question",
"instillAcceptFormats": [
"string",
"text/*"
Expand Down Expand Up @@ -852,6 +865,7 @@
"string",
"text/*"
],
"instillShortDescription": "The string that you wish to compare the other strings with.",
"instillUIOrder": 1,
"instillUpstreamTypes": [
"value",
Expand Down Expand Up @@ -909,6 +923,7 @@
"instillUIOrder": 0,
"properties": {
"audio": {
"description": "The audio file",
"instillAcceptFormats": [
"audio/*"
],
Expand Down Expand Up @@ -1031,6 +1046,7 @@
"number",
"integer"
],
"instillShortDescription": "The temperature of the sampling operation.",
"instillUIOrder": 4,
"instillUpstreamTypes": [
"value",
Expand Down Expand Up @@ -1060,6 +1076,7 @@
"number",
"integer"
],
"instillShortDescription": "Float to define the tokens that are within the sample operation of text generation.",
"instillUIOrder": 6,
"instillUpstreamTypes": [
"value",
Expand Down Expand Up @@ -1302,6 +1319,7 @@
"instillAcceptFormats": [
"integer"
],
"instillShortDescription": "The amount of new tokens to be generated.",
"instillUIOrder": 1,
"instillUpstreamTypes": [
"value",
Expand All @@ -1316,6 +1334,7 @@
"number",
"integer"
],
"instillShortDescription": "The amount of time in seconds that the query should take maximum.",
"instillUIOrder": 2,
"instillUpstreamTypes": [
"value",
Expand Down Expand Up @@ -1370,6 +1389,7 @@
"number",
"integer"
],
"instillShortDescription": "The temperature of the sampling operation.",
"instillUIOrder": 6,
"instillUpstreamTypes": [
"value",
Expand Down Expand Up @@ -1397,6 +1417,7 @@
"number",
"integer"
],
"instillShortDescription": "Float to define the tokens that are within the sample operation of text generation.",
"instillUIOrder": 8,
"instillUpstreamTypes": [
"value",
Expand Down Expand Up @@ -1455,6 +1476,7 @@
"instillUIOrder": 2,
"properties": {
"guidance_scale": {
"description": "Guidance scale",
"instillAcceptFormats": [
"number",
"integer"
Expand All @@ -1468,6 +1490,7 @@
"type": "number"
},
"height": {
"description": "Image Height",
"instillAcceptFormats": [
"integer"
],
Expand All @@ -1480,6 +1503,7 @@
"type": "integer"
},
"negative_prompt": {
"description": "Negative prompt for generating the image",
"instillAcceptFormats": [
"string",
"text/*"
Expand All @@ -1494,6 +1518,7 @@
"type": "string"
},
"num_inference_steps": {
"description": "Number of inference steps",
"instillAcceptFormats": [
"integer"
],
Expand All @@ -1506,6 +1531,7 @@
"type": "integer"
},
"width": {
"description": "Image width",
"instillAcceptFormats": [
"integer"
],
Expand Down Expand Up @@ -1571,6 +1597,7 @@
"string",
"text/*"
],
"instillShortDescription": "There are several aggregation strategies: none, simple, first, average, and max.",
"instillUIOrder": 0,
"instillUpstreamTypes": [
"value",
Expand Down Expand Up @@ -1711,6 +1738,7 @@
"properties": {
"candidate_labels": {
"description": "a list of strings that are potential classes for inputs. (max 10 candidate_labels, for more, simply run multiple requests, results are going to be misleading if using too many candidate_labels anyway. If you want to keep the exact same, you can simply run multi_label=True and do the scaling on your end. )",
"instillShortDescription": "a list of strings that are potential classes for inputs.",
"instillUIOrder": 0,
"instillUpstreamTypes": [
"value",
Expand Down
Loading

0 comments on commit 98d63cf

Please sign in to comment.