✨ feature: redirect on `/` to `/docs`

.gitignore

@@ -0,0 +1,6 @@
+# Environment
+.venv
+.env
+
+# Cache
+__pycache__/

app.py

@@ -1,28 +1,31 @@
 from fastapi import FastAPI
+from fastapi.responses import RedirectResponse
 from transformers import pipeline
- 
+
 # Create a new FastAPI app instance
 app = FastAPI()
- 
+
 # Initialize the text generation pipeline
 # This function will be able to generate text
 # given an input.
-pipe = pipeline("text2text-generation", 
-model="google/flan-t5-small")
- 
-# Define a function to handle the GET request at `/generate`
-# The generate() function is defined as a FastAPI route that takes a 
-# string parameter called text. The function generates text based on the # input using the pipeline() object, and returns a JSON response 
-# containing the generated text under the key "output"
+pipe = pipeline("text2text-generation", model="google/flan-t5-small")
+
+
 @app.get("/")
+def index():
+    """
+    Documentation for the API.
+    """
+    return RedirectResponse(url="/docs")
+
+
+@app.get("/generate")
 def generate(text: str):
     """
     Using the text2text-generation pipeline from `transformers`, generate text
     from the given input text. The model used is `google/flan-t5-small`, which
     can be found [here](<https://huggingface.co/google/flan-t5-small>).
     """
-    # Use the pipeline to generate text from the given input text
     output = pipe(text)
-     
-    # Return the generated text in a JSON response
+
     return {"output": output[0]["generated_text"]}

requirements.txt

@@ -3,4 +3,5 @@ requests==2.27.*
 uvicorn[standard]==0.17.*
 sentencepiece==0.1.*
 torch==1.11.*
+# torch==2.1.*
 transformers==4.*