Updates to the Text Generation Endpoint (#42)

* Updated README * Updated text generation task * Major rev
Kardbord · Jul 11, 2024 · 086206c · 086206c
1 parent e3eec12
commit 086206c
Show file tree

Hide file tree

Showing 40 changed files with 177 additions and 158 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,7 @@ See the [examples](./examples) directory.
 ## Resources
 
 - [Hugging Face](https://huggingface.co/)
+  - [Inference API JSON Schema](https://huggingface.github.io/text-generation-inference/openapi.json)
   - [Model Hub](https://huggingface.co/models)
   - [Datasets](https://huggingface.co/datasets)
   - [Hugging Face Inference API](https://api-inference.huggingface.co/docs/python/html/index.html) (HF API)

diff --git a/audio_classification_test.go b/audio_classification_test.go
@@ -4,7 +4,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 func TestAudioClassificationRequest(t *testing.T) {

diff --git a/conversational_test.go b/conversational_test.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"testing"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 	"github.com/google/go-cmp/cmp"
 )
 

diff --git a/examples/audio_classification/main.go b/examples/audio_classification/main.go
@@ -5,7 +5,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/conversational/main.go b/examples/conversational/main.go
@@ -9,7 +9,7 @@ import (
 	"syscall"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/fill_mask/main.go b/examples/fill_mask/main.go
@@ -7,7 +7,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/image_classification/main.go b/examples/image_classification/main.go
@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/image_segmentation/main.go b/examples/image_segmentation/main.go
@@ -12,7 +12,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 	"golang.org/x/image/font"
 	"golang.org/x/image/font/basicfont"
 	"golang.org/x/image/math/fixed"

diff --git a/examples/image_to_text/main.go b/examples/image_to_text/main.go
@@ -6,7 +6,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/object_detection/main.go b/examples/object_detection/main.go
@@ -13,7 +13,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/question_answering/main.go b/examples/question_answering/main.go
@@ -5,7 +5,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/sentence_similarity/main.go b/examples/sentence_similarity/main.go
@@ -6,7 +6,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/speech_recognition/main.go b/examples/speech_recognition/main.go
@@ -5,7 +5,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/summarization/main.go b/examples/summarization/main.go
@@ -5,7 +5,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/table_question_answering/main.go b/examples/table_question_answering/main.go
@@ -6,7 +6,7 @@ import (
 	"text/tabwriter"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const TableRows = 2

diff --git a/examples/text_classification/main.go b/examples/text_classification/main.go
@@ -6,7 +6,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/text_generation/main.go b/examples/text_generation/main.go
@@ -3,10 +3,9 @@ package main
 import (
 	"fmt"
 	"os"
-	"strings"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"
@@ -19,13 +18,9 @@ func init() {
 }
 
 func main() {
-	inputs := []string{
-		"The answer to life, the universe, and everything is",
-		"Somebody once told me that the world is gonna roll me",
-	}
-	const numReturnSequences = 3
+	input := "The answer to life, the universe, and everything is"
 
-	fmt.Printf("Inputs: [\"%s\"]\n", strings.Join(inputs, `", "`))
+	fmt.Printf("Input: \"%s\"\n", input)
 
 	type ChanRv struct {
 		resps []*hfapigo.TextGenerationResponse
@@ -36,9 +31,8 @@ func main() {
 	fmt.Print("Sending request")
 	go func() {
 		resps, err := hfapigo.SendTextGenerationRequest(hfapigo.RecommendedTextGenerationModel, &hfapigo.TextGenerationRequest{
-			Inputs:     inputs,
-			Parameters: *hfapigo.NewTextGenerationParameters().SetNumReturnSequences(numReturnSequences),
-			Options:    *hfapigo.NewOptions().SetWaitForModel(true),
+			Input:   input,
+			Options: *hfapigo.NewOptions().SetWaitForModel(true),
 		})
 		ch <- ChanRv{resps, err}
 	}()
@@ -51,14 +45,7 @@ func main() {
 				fmt.Println(chrv.err)
 				return
 			}
-			for i := range inputs {
-				fmt.Printf("\nInput %d results:\n", i)
-				for _, gt := range chrv.resps[i].GeneratedTexts {
-					gt = strings.Replace(gt, "\n", " ", -1)
-					gt = strings.Replace(gt, "\r", " ", -1)
-					fmt.Println(gt)
-				}
-			}
+			fmt.Printf("Response: %s\n", chrv.resps[0].GeneratedText)
 			return
 		default:
 			fmt.Print(".")

diff --git a/examples/text_to_image/main.go b/examples/text_to_image/main.go
@@ -10,7 +10,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/token_classification/main.go b/examples/token_classification/main.go
@@ -6,7 +6,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/translation/main.go b/examples/translation/main.go
@@ -6,7 +6,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/examples/zeroshot/main.go b/examples/zeroshot/main.go
@@ -6,7 +6,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/fill_mask_test.go b/fill_mask_test.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"testing"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 	"github.com/google/go-cmp/cmp"
 )
 

diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/Kardbord/hfapigo/v2
+module github.com/Kardbord/hfapigo/v3
 
 go 1.17
 

diff --git a/image_classification_test.go b/image_classification_test.go
@@ -3,7 +3,7 @@ package hfapigo_test
 import (
 	"testing"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 func TestImageClassificationRequest(t *testing.T) {

diff --git a/image_segmentation_test.go b/image_segmentation_test.go
@@ -3,7 +3,7 @@ package hfapigo_test
 import (
 	"testing"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 func TestImageSegmentationRequest(t *testing.T) {

diff --git a/image_to_text_test.go b/image_to_text_test.go
@@ -4,7 +4,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 func TestImageToText(t *testing.T) {

diff --git a/object_detection_test.go b/object_detection_test.go
@@ -4,7 +4,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 func TestObjectDetectionRequest(t *testing.T) {

diff --git a/question_answering_test.go b/question_answering_test.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"testing"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 	"github.com/google/go-cmp/cmp"
 )
 

diff --git a/sentence_similarity_test.go b/sentence_similarity_test.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"testing"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 	"github.com/google/go-cmp/cmp"
 )
 

diff --git a/setup_test.go b/setup_test.go
@@ -5,7 +5,7 @@ import (
 	"os"
 	"testing"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"

diff --git a/speech_recognition_test.go b/speech_recognition_test.go
@@ -4,7 +4,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 )
 
 func TestSpeechRecognitionRequest(t *testing.T) {

diff --git a/summarization_test.go b/summarization_test.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"testing"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 	"github.com/google/go-cmp/cmp"
 )
 

diff --git a/table_question_answering_test.go b/table_question_answering_test.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"testing"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 	"github.com/google/go-cmp/cmp"
 )
 

diff --git a/text_classification_test.go b/text_classification_test.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"testing"
 
-	"github.com/Kardbord/hfapigo/v2"
+	"github.com/Kardbord/hfapigo/v3"
 	"github.com/google/go-cmp/cmp"
 )
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,7 @@ import ( @@
     	"os"
     	"time"
-    	"github.com/Kardbord/hfapigo/v2"
+    	"github.com/Kardbord/hfapigo/v3"
     )
     const HuggingFaceTokenEnv = "HUGGING_FACE_TOKEN"
@@ Expand Down @@