Abstract model outputs into a Result class

.pre-commit-config.yaml

@@ -6,7 +6,8 @@ repos:
       # Run the linter.
       - id: ruff
         types_or: [ python, pyi ]
-        args: [ --fix, --ignore=F403,F405 ]
+        args: [ --fix, --ignore=F401,F403,F405 ]
       # Run the formatter.
       - id: ruff-format
-        types_or: [ python, pyi ]
+        types_or: [ python, pyi ]
+

README.md

@@ -105,7 +105,7 @@ model.infer_batch(images, prompts) # Run batch inference
 model.launch_gradio()              # Launch Gradio interface
 ```
 
-Have a custom model? Create a class that implements the `BaseModel` interface and register it with x.infer. See [Add Your Own Model](#add-your-own-model) for more details.
+Have a custom model? Create a class that implements the `BaseXInferModel` interface and register it with x.infer. See [Add Your Own Model](#add-your-own-model) for more details.
 
 ## 🚀 Quickstart
 
@@ -273,7 +273,7 @@ curl -X 'POST' \
   -H 'Content-Type: application/json' \
   -d '{
   "image": "https://raw.githubusercontent.com/dnth/x.infer/main/assets/demo/00aa2580828a9009.jpg",
-  "infer_kwargs": {"prompt": "Caption this image"}
+  "infer_kwargs": {"text": "Caption this image"}
 }'
 ```
 
@@ -290,7 +290,7 @@ headers = {
 payload = {
     "image": "https://raw.githubusercontent.com/dnth/x.infer/main/assets/demo/00aa2580828a9009.jpg",
     "infer_kwargs": {
-        "prompt": "Caption this image"
+        "text": "Caption this image"
     }
 }
 
@@ -300,7 +300,7 @@ print(response.json())
 
 ### Add Your Own Model
 
-+ **Step 1:** Create a new model class that implements the `BaseModel` interface.
++ **Step 1:** Create a new model class that implements the `BaseXInferModel` interface.
 
 + **Step 2:** Implement the required abstract methods `load_model`, `infer`, and `infer_batch`.
 
@@ -309,7 +309,7 @@ print(response.json())
 For example:
 ```python
 @register_model("my-model", "custom", ModelInputOutput.IMAGE_TEXT_TO_TEXT)
-class MyModel(BaseModel):
+class MyModel(BaseXInferModel):
     def load_model(self):
         # Load your model here
         pass

docs/index.md

@@ -86,7 +86,7 @@ model.infer_batch(images, prompts) # Run batch inference
 model.launch_gradio()              # Launch Gradio interface
 ```
 
-Have a custom model? Create a class that implements the `BaseModel` interface and register it with x.infer. See [Add Your Own Model](#add-your-own-model) for more details.
+Have a custom model? Create a class that implements the `BaseXInferModel` interface and register it with x.infer. See [Add Your Own Model](#add-your-own-model) for more details.
 
 ## 🌟 Key Features
 <div align="center">

nbs/gradio_demo.ipynb

@@ -2,46 +2,9 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "* Running on local URL:  http://127.0.0.1:7860\n",
-      "\n",
-      "To create a public link, set `share=True` in `launch()`.\n"
-     ]
-    },
-    {
-     "data": {
-      "text/html": [
-       "<div><iframe src=\"http://127.0.0.1:7860/\" width=\"100%\" height=\"1000\" allow=\"autoplay; camera; microphone; clipboard-read; clipboard-write;\" frameborder=\"0\" allowfullscreen></iframe></div>"
-      ],
-      "text/plain": [
-       "<IPython.core.display.HTML object>"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    },
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "\u001b[32m2024-10-25 23:54:24.405\u001b[0m | \u001b[1mINFO    \u001b[0m | \u001b[36mxinfer.models\u001b[0m:\u001b[36m__init__\u001b[0m:\u001b[36m63\u001b[0m - \u001b[1mModel: bat_resnext26ts.ch_in1k\u001b[0m\n",
-      "\u001b[32m2024-10-25 23:54:24.409\u001b[0m | \u001b[1mINFO    \u001b[0m | \u001b[36mxinfer.models\u001b[0m:\u001b[36m__init__\u001b[0m:\u001b[36m64\u001b[0m - \u001b[1mDevice: cuda\u001b[0m\n",
-      "\u001b[32m2024-10-25 23:54:24.410\u001b[0m | \u001b[1mINFO    \u001b[0m | \u001b[36mxinfer.models\u001b[0m:\u001b[36m__init__\u001b[0m:\u001b[36m65\u001b[0m - \u001b[1mDtype: float16\u001b[0m\n",
-      "\u001b[32m2024-10-25 23:54:27.348\u001b[0m | \u001b[1mINFO    \u001b[0m | \u001b[36mxinfer.models\u001b[0m:\u001b[36m__init__\u001b[0m:\u001b[36m63\u001b[0m - \u001b[1mModel: bat_resnext26ts.ch_in1k\u001b[0m\n",
-      "\u001b[32m2024-10-25 23:54:27.350\u001b[0m | \u001b[1mINFO    \u001b[0m | \u001b[36mxinfer.models\u001b[0m:\u001b[36m__init__\u001b[0m:\u001b[36m64\u001b[0m - \u001b[1mDevice: cuda\u001b[0m\n",
-      "\u001b[32m2024-10-25 23:54:27.352\u001b[0m | \u001b[1mINFO    \u001b[0m | \u001b[36mxinfer.models\u001b[0m:\u001b[36m__init__\u001b[0m:\u001b[36m65\u001b[0m - \u001b[1mDtype: float16\u001b[0m\n",
-      "\u001b[32m2024-10-25 23:54:38.268\u001b[0m | \u001b[1mINFO    \u001b[0m | \u001b[36mxinfer.models\u001b[0m:\u001b[36m__init__\u001b[0m:\u001b[36m63\u001b[0m - \u001b[1mModel: bat_resnext26ts.ch_in1k\u001b[0m\n",
-      "\u001b[32m2024-10-25 23:54:38.270\u001b[0m | \u001b[1mINFO    \u001b[0m | \u001b[36mxinfer.models\u001b[0m:\u001b[36m__init__\u001b[0m:\u001b[36m64\u001b[0m - \u001b[1mDevice: cuda\u001b[0m\n",
-      "\u001b[32m2024-10-25 23:54:38.271\u001b[0m | \u001b[1mINFO    \u001b[0m | \u001b[36mxinfer.models\u001b[0m:\u001b[36m__init__\u001b[0m:\u001b[36m65\u001b[0m - \u001b[1mDtype: float16\u001b[0m\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "import xinfer\n",
     "\n",