[Tasks] Rename generate property in task specs (#930)

hanouticelina · web-flow · commit 189618006827 · 2024-09-30T16:03:36.000+02:00
Fixes #923 This PR updates the task specs to rename the `generate` property to `generation_parameters`. This change aligns with the discussion in the issue. Key changes: - Renamed `generate` to `generation_parameters` in the specs for `automatic-speech-recognition`, `image-to-text`, `text-to-audio` and `text-to-speech` tasks.
diff --git a/packages/tasks/src/tasks/automatic-speech-recognition/inference.ts b/packages/tasks/src/tasks/automatic-speech-recognition/inference.ts
@@ -29,7 +29,7 @@ export interface AutomaticSpeechRecognitionParameters {
 	/**
 	 * Parametrization of the text generation process
 	 */
-	generate?: GenerationParameters;
+	generation_parameters?: GenerationParameters;
 	/**
 	 * Whether to output corresponding timestamps with the generated text
 	 */
diff --git a/packages/tasks/src/tasks/automatic-speech-recognition/spec/input.json b/packages/tasks/src/tasks/automatic-speech-recognition/spec/input.json
@@ -24,7 +24,7 @@
 					"type": "boolean",
 					"description": "Whether to output corresponding timestamps with the generated text"
 				},
-				"generate": {
+				"generation_parameters": {
 					"description": "Parametrization of the text generation process",
 					"$ref": "/inference/schemas/common-definitions.json#/definitions/GenerationParameters"
 				}
diff --git a/packages/tasks/src/tasks/image-to-text/inference.ts b/packages/tasks/src/tasks/image-to-text/inference.ts
@@ -28,7 +28,7 @@ export interface ImageToTextParameters {
 	/**
 	 * Parametrization of the text generation process
 	 */
-	generate?: GenerationParameters;
+	generation_parameters?: GenerationParameters;
 	/**
 	 * The amount of maximum tokens to generate.
 	 */
diff --git a/packages/tasks/src/tasks/image-to-text/spec/input.json b/packages/tasks/src/tasks/image-to-text/spec/input.json
@@ -23,7 +23,7 @@
 					"type": "integer",
 					"description": "The amount of maximum tokens to generate."
 				},
-				"generate": {
+				"generation_parameters": {
 					"description": "Parametrization of the text generation process",
 					"$ref": "/inference/schemas/common-definitions.json#/definitions/GenerationParameters"
 				}
diff --git a/packages/tasks/src/tasks/text-to-audio/inference.ts b/packages/tasks/src/tasks/text-to-audio/inference.ts
@@ -28,7 +28,7 @@ export interface TextToAudioParameters {
 	/**
 	 * Parametrization of the text generation process
 	 */
-	generate?: GenerationParameters;
+	generation_parameters?: GenerationParameters;
 	[property: string]: unknown;
 }
 
diff --git a/packages/tasks/src/tasks/text-to-audio/spec/input.json b/packages/tasks/src/tasks/text-to-audio/spec/input.json
@@ -20,7 +20,7 @@
 			"description": "Additional inference parameters for Text To Audio",
 			"type": "object",
 			"properties": {
-				"generate": {
+				"generation_parameters": {
 					"description": "Parametrization of the text generation process",
 					"$ref": "/inference/schemas/common-definitions.json#/definitions/GenerationParameters"
 				}
diff --git a/packages/tasks/src/tasks/text-to-speech/inference.ts b/packages/tasks/src/tasks/text-to-speech/inference.ts
@@ -28,7 +28,7 @@ export interface TextToSpeechParameters {
 	/**
 	 * Parametrization of the text generation process
 	 */
-	generate?: GenerationParameters;
+	generation_parameters?: GenerationParameters;
 	[property: string]: unknown;
 }
 
diff --git a/packages/tasks/src/tasks/text-to-speech/spec/input.json b/packages/tasks/src/tasks/text-to-speech/spec/input.json
@@ -20,7 +20,7 @@
 			"description": "Additional inference parameters for Text To Speech",
 			"type": "object",
 			"properties": {
-				"generate": {
+				"generation_parameters": {
 					"description": "Parametrization of the text generation process",
 					"$ref": "/inference/schemas/common-definitions.json#/definitions/GenerationParameters"
 				}

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`"type": "boolean",`
`25`	`25`	`"description": "Whether to output corresponding timestamps with the generated text"`
`26`	`26`	`},`
`27`		`- "generate": {`
	`27`	`+ "generation_parameters": {`
`28`	`28`	`"description": "Parametrization of the text generation process",`
`29`	`29`	`"$ref": "/inference/schemas/common-definitions.json#/definitions/GenerationParameters"`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`"type": "integer",`
`24`	`24`	`"description": "The amount of maximum tokens to generate."`
`25`	`25`	`},`
`26`		`- "generate": {`
	`26`	`+ "generation_parameters": {`
`27`	`27`	`"description": "Parametrization of the text generation process",`
`28`	`28`	`"$ref": "/inference/schemas/common-definitions.json#/definitions/GenerationParameters"`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ export interface TextToAudioParameters {`
`28`	`28`	`/**`
`29`	`29`	`* Parametrization of the text generation process`
`30`	`30`	`*/`
`31`		`- generate?: GenerationParameters;`
	`31`	`+ generation_parameters?: GenerationParameters;`
`32`	`32`	`[property: string]: unknown;`
`33`	`33`	`}`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`"description": "Additional inference parameters for Text To Audio",`
`21`	`21`	`"type": "object",`
`22`	`22`	`"properties": {`
`23`		`- "generate": {`
	`23`	`+ "generation_parameters": {`
`24`	`24`	`"description": "Parametrization of the text generation process",`
`25`	`25`	`"$ref": "/inference/schemas/common-definitions.json#/definitions/GenerationParameters"`
`26`	`26`	`}`