Skip to content

Commit 0ebf911

Browse files
[Tasks] remove duplicate description in task parameter objects (#1045)
this PR removes redundant description in task parameter classes definition while keeping it in the parameters field reference. this avoids duplicate documentation, see: [huggingface/huggingface_hub/pull/2664#discussion](huggingface/huggingface_hub#2664 (comment)) for more context. Note : `packages/tasks/src/tasks/{task_name/inference.ts` files are auto-generated.
1 parent 21158d7 commit 0ebf911

File tree

54 files changed

+53
-135
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+53
-135
lines changed

packages/tasks/src/tasks/audio-classification/inference.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,12 @@ export interface AudioClassificationInput {
1313
*/
1414
inputs: string;
1515
/**
16-
* Additional inference parameters
16+
* Additional inference parameters for Audio Classification
1717
*/
1818
parameters?: AudioClassificationParameters;
1919
[property: string]: unknown;
2020
}
2121
/**
22-
* Additional inference parameters
23-
*
2422
* Additional inference parameters for Audio Classification
2523
*/
2624
export interface AudioClassificationParameters {

packages/tasks/src/tasks/audio-classification/spec/input.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,13 @@
1010
"type": "string"
1111
},
1212
"parameters": {
13-
"description": "Additional inference parameters",
13+
"description": "Additional inference parameters for Audio Classification",
1414
"$ref": "#/$defs/AudioClassificationParameters"
1515
}
1616
},
1717
"$defs": {
1818
"AudioClassificationParameters": {
1919
"title": "AudioClassificationParameters",
20-
"description": "Additional inference parameters for Audio Classification",
2120
"type": "object",
2221
"properties": {
2322
"function_to_apply": {

packages/tasks/src/tasks/automatic-speech-recognition/inference.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,13 @@ export interface AutomaticSpeechRecognitionInput {
1414
*/
1515
inputs: string;
1616
/**
17-
* Additional inference parameters
17+
* Additional inference parameters for Automatic Speech Recognition
1818
*/
1919
parameters?: AutomaticSpeechRecognitionParameters;
2020
[property: string]: unknown;
2121
}
2222

2323
/**
24-
* Additional inference parameters
25-
*
2624
* Additional inference parameters for Automatic Speech Recognition
2725
*/
2826
export interface AutomaticSpeechRecognitionParameters {
@@ -39,8 +37,6 @@ export interface AutomaticSpeechRecognitionParameters {
3937

4038
/**
4139
* Parametrization of the text generation process
42-
*
43-
* Ad-hoc parametrization of the text generation process
4440
*/
4541
export interface GenerationParameters {
4642
/**

packages/tasks/src/tasks/automatic-speech-recognition/spec/input.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,13 @@
1010
"type": "string"
1111
},
1212
"parameters": {
13-
"description": "Additional inference parameters",
13+
"description": "Additional inference parameters for Automatic Speech Recognition",
1414
"$ref": "#/$defs/AutomaticSpeechRecognitionParameters"
1515
}
1616
},
1717
"$defs": {
1818
"AutomaticSpeechRecognitionParameters": {
1919
"title": "AutomaticSpeechRecognitionParameters",
20-
"description": "Additional inference parameters for Automatic Speech Recognition",
2120
"type": "object",
2221
"properties": {
2322
"return_timestamps": {

packages/tasks/src/tasks/common-definitions.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
},
2727
"GenerationParameters": {
2828
"title": "GenerationParameters",
29-
"description": "Ad-hoc parametrization of the text generation process",
3029
"type": "object",
3130
"properties": {
3231
"temperature": {

packages/tasks/src/tasks/depth-estimation/inference.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export interface DepthEstimationInput {
1313
*/
1414
inputs: unknown;
1515
/**
16-
* Additional inference parameters
16+
* Additional inference parameters for Depth Estimation
1717
*/
1818
parameters?: { [key: string]: unknown };
1919
[property: string]: unknown;

packages/tasks/src/tasks/depth-estimation/spec/input.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,13 @@
99
"description": "The input image data"
1010
},
1111
"parameters": {
12-
"description": "Additional inference parameters",
12+
"description": "Additional inference parameters for Depth Estimation",
1313
"$ref": "#/$defs/DepthEstimationParameters"
1414
}
1515
},
1616
"$defs": {
1717
"DepthEstimationParameters": {
1818
"title": "DepthEstimationParameters",
19-
"description": "Additional inference parameters for Depth Estimation",
2019
"type": "object",
2120
"properties": {}
2221
}

packages/tasks/src/tasks/document-question-answering/inference.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export interface DocumentQuestionAnsweringInput {
1212
*/
1313
inputs: DocumentQuestionAnsweringInputData;
1414
/**
15-
* Additional inference parameters
15+
* Additional inference parameters for Document Question Answering
1616
*/
1717
parameters?: DocumentQuestionAnsweringParameters;
1818
[property: string]: unknown;
@@ -32,8 +32,6 @@ export interface DocumentQuestionAnsweringInputData {
3232
[property: string]: unknown;
3333
}
3434
/**
35-
* Additional inference parameters
36-
*
3735
* Additional inference parameters for Document Question Answering
3836
*/
3937
export interface DocumentQuestionAnsweringParameters {

packages/tasks/src/tasks/document-question-answering/spec/input.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,13 @@
2121
"required": ["image", "question"]
2222
},
2323
"parameters": {
24-
"description": "Additional inference parameters",
24+
"description": "Additional inference parameters for Document Question Answering",
2525
"$ref": "#/$defs/DocumentQuestionAnsweringParameters"
2626
}
2727
},
2828
"$defs": {
2929
"DocumentQuestionAnsweringParameters": {
3030
"title": "DocumentQuestionAnsweringParameters",
31-
"description": "Additional inference parameters for Document Question Answering",
3231
"type": "object",
3332
"properties": {
3433
"doc_stride": {

packages/tasks/src/tasks/fill-mask/inference.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,12 @@ export interface FillMaskInput {
1212
*/
1313
inputs: string;
1414
/**
15-
* Additional inference parameters
15+
* Additional inference parameters for Fill Mask
1616
*/
1717
parameters?: FillMaskParameters;
1818
[property: string]: unknown;
1919
}
2020
/**
21-
* Additional inference parameters
22-
*
2321
* Additional inference parameters for Fill Mask
2422
*/
2523
export interface FillMaskParameters {

0 commit comments

Comments
 (0)