routes: Fix version and hardware metadata routes (livepeer#896)

* base/pipeline: Add name property to pipelines

* routes: Use pipeline for default pipeline/model_id

* Update docs

* Fix openapi spec

Author: victorges

docs/custom-pipeline.md

@@ -421,6 +421,8 @@ Batch pipelines extend a different base class:
 from runner.pipelines.base import Pipeline
 
 class MyBatchPipeline(Pipeline):
+    name: str = "my-batch-pipeline"
+
     def __init__(self, model_id: str, model_dir: str = "/models"):
         self.model_id = model_id
         self.model_dir = model_dir

runner/gateway.openapi.yaml

@@ -3,7 +3,7 @@ openapi: 3.1.0
 info:
   title: Livepeer AI Runner
   description: An application to run AI pipelines
-  version: 0.13.11
+  version: 0.14.0
 servers:
 - url: https://dream-gateway.livepeer.cloud
   description: Livepeer Cloud Community Gateway

runner/openapi.yaml

@@ -3,7 +3,7 @@ openapi: 3.1.0
 info:
   title: Livepeer AI Runner
   description: An application to run AI pipelines
-  version: 0.13.11
+  version: 0.14.0
 servers:
 - url: https://dream-gateway.livepeer.cloud
   description: Livepeer Cloud Community Gateway

runner/src/runner/pipelines/audio_to_text.py

@@ -59,6 +59,8 @@ class ModelConfig:
 
 
 class AudioToTextPipeline(Pipeline):
+    name: str = "audio-to-text"
+
     def __init__(self, model_id: str):
         self.model_id = model_id
         kwargs = {}

runner/src/runner/pipelines/base.py

@@ -15,6 +15,12 @@ class Version(BaseModel):
     version: str = Field(..., description="The version of the Runner")
 
 class Pipeline(ABC):
+    @property
+    @abstractmethod
+    def name(self) -> str:
+        """The pipeline name used for routing (e.g. 'text-to-image', 'live-video-to-video', etc)."""
+        ...
+
     @abstractmethod
     def __init__(self, model_id: str, model_dir: str):
         self.model_id: str # declare the field here so the type hint is available when using this abstract class

runner/src/runner/pipelines/frame_interpolation.py

@@ -2,4 +2,5 @@
 
 
 class FrameInterpolationPipeline(Pipeline):
-    pass
+    name: str = "frame-interpolation"
+    # TODO: Not implemented

runner/src/runner/pipelines/image_to_image.py

@@ -46,6 +46,8 @@ def list(cls):
 
 
 class ImageToImagePipeline(Pipeline):
+    name: str = "image-to-image"
+
     def __init__(self, model_id: str):
         self.model_id = model_id
         kwargs = {"cache_dir": get_model_dir()}

runner/src/runner/pipelines/image_to_text.py

@@ -14,6 +14,8 @@
 
 
 class ImageToTextPipeline(Pipeline):
+    name: str = "image-to-text"
+
     def __init__(self, model_id: str):
         self.model_id = model_id
         kwargs = {}

runner/src/runner/pipelines/image_to_video.py

@@ -21,6 +21,8 @@
 
 
 class ImageToVideoPipeline(Pipeline):
+    name: str = "image-to-video"
+
     def __init__(self, model_id: str):
         self.model_id = model_id
         kwargs = {"cache_dir": get_model_dir()}

runner/src/runner/pipelines/live_video_to_video.py

@@ -19,6 +19,8 @@
 proc_status_important_fields = ["State", "VmRSS", "VmSize", "Threads", "voluntary_ctxt_switches", "nonvoluntary_ctxt_switches", "CoreDumping"]
 
 class LiveVideoToVideoPipeline(Pipeline):
+    name: str = "live-video-to-video"
+
     def __init__(self, pipeline_spec: PipelineSpec):
         self.version = os.getenv("VERSION", "undefined")
         self.model_id = pipeline_spec.name # we set the parent class model_id to the pipeline name for compatibility