FEAT : Add Model Dashboard

.github/workflows/release.yaml

@@ -30,6 +30,9 @@ jobs:
           pip install
           build
           --user
+      - name: Build web
+        run: >-
+          python setup.py build_web
       - name: Build a binary wheel and a source tarball
         run: >-
           python3 -m

MANIFEST.in

@@ -10,3 +10,4 @@ include xinference/_version.py
 global-exclude conftest.py
 include xinference/locale/*.json
 include xinference/model/llm/*.json
+global-include xinference/web/ui/build/**/*

doc/source/conf.py

@@ -75,4 +75,4 @@
     ]
 }
 
-html_favicon = "_static/favicon.svg"
+html_favicon = "_static/favicon.svg"

setup.cfg

@@ -26,7 +26,7 @@ packages = find:
 install_requires =
     xoscar
     xorbits
-    gradio>=3.35.0
+    gradio>=3.39.0
     click
     tqdm>=4.27
     tabulate

setup.py

@@ -15,10 +15,16 @@
 import os
 import platform
 import sys
+import shutil
+import subprocess
+import warnings
 from sysconfig import get_config_vars
 
 from pkg_resources import parse_version
-from setuptools import setup
+from setuptools import Command, setup
+from setuptools.command.develop import develop
+from setuptools.command.install import install
+from setuptools.command.sdist import sdist
 
 # From https://github.com/pandas-dev/pandas/pull/24274:
 # For mac, ensure extensions are built for macos 10.9 when compiling on a
@@ -43,6 +49,77 @@
 repo_root = os.path.dirname(os.path.abspath(__file__))
 os.chdir(repo_root)
 
+
+class ExtraCommandMixin:
+    _extra_pre_commands = []
+
+    def run(self):
+        [self.run_command(cmd) for cmd in self._extra_pre_commands]
+        super().run()
+
+    @classmethod
+    def register_pre_command(cls, cmd):
+        cls._extra_pre_commands.append(cmd)
+
+
+class CustomInstall(ExtraCommandMixin, install):
+    pass
+
+
+class CustomDevelop(ExtraCommandMixin, develop):
+    pass
+
+
+class CustomSDist(ExtraCommandMixin, sdist):
+    pass
+
+class BuildWeb(Command):
+    """build_web command"""
+
+    user_options = []
+    _web_src_path = "xinference/web/ui"
+    _web_dest_path = "xinference/web/ui/build/index.html"
+    _commands = [
+        ["npm", "install"],
+        ["npm", "run", "build"],
+    ]
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    @classmethod
+    def run(cls):
+        if int(os.environ.get("NO_WEB_UI", "0")):
+            return
+
+        npm_path = shutil.which("npm")
+        web_src_path = os.path.join(repo_root, *cls._web_src_path.split("/"))
+        web_dest_path = os.path.join(repo_root, *cls._web_dest_path.split("/"))
+
+        if npm_path is None:
+            warnings.warn("Cannot find NPM, may affect displaying Xinference web UI")
+            return
+        else:
+            replacements = {"npm": npm_path}
+            cmd_errored = False
+            for cmd in cls._commands:
+                cmd = [replacements.get(c, c) for c in cmd]
+                proc_result = subprocess.run(cmd, cwd=web_src_path)
+                if proc_result.returncode != 0:
+                    warnings.warn(f'Failed when running `{" ".join(cmd)}`')
+                    cmd_errored = True
+                    break
+            if not cmd_errored:
+                assert os.path.exists(web_dest_path)
+
+
+CustomInstall.register_pre_command("build_web")
+CustomDevelop.register_pre_command("build_web")
+CustomSDist.register_pre_command("build_web")
+
 sys.path.append(repo_root)
 versioneer = __import__("versioneer")
 
@@ -57,7 +134,14 @@ def build_long_description():
 
 setup_options = dict(
     version=versioneer.get_version(),
-    cmdclass=versioneer.get_cmdclass(),
+    cmdclass=versioneer.get_cmdclass(
+        {
+            "build_web": BuildWeb,
+            "install": CustomInstall,
+            "develop": CustomDevelop,
+            "sdist": CustomSDist,
+        }
+    ),
     long_description=build_long_description(),
     long_description_content_type="text/markdown",
 )

xinference/client.py

@@ -763,3 +763,50 @@ def get_model(self, model_uid: str) -> RESTfulModelHandle:
             return RESTfulChatModelHandle(model_uid, self.base_url)
         else:
             raise ValueError(f"Unrecognized model ability: {desc['model_ability']}")
+
+    def describe_model(self, model_uid: str):
+        """
+        Get model information via RESTful APIs.
+
+        Parameters
+        ----------
+        model_uid: str
+            The unique id that identify the model.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the following keys:
+            - "model_type": str
+               the type of the model determined by its function, e.g. "LLM" (Large Language Model)
+            - "model_name": str
+               the name of the specific LLM model family
+            - "model_lang": List[str]
+               the languages supported by the LLM model
+            - "model_ability": List[str]
+               the ability or capabilities of the LLM model
+            - "model_description": str
+               a detailed description of the LLM model
+            - "model_format": str
+               the format specification of the LLM model
+            - "model_size_in_billions": int
+               the size of the LLM model in billions
+            - "quantization": str
+               the quantization applied to the model
+            - "revision": str
+               the revision number of the LLM model specification
+
+        Raises
+        ------
+        RuntimeError
+            Report failure to get the wanted model with given model_uid. Provide details of failure through error message.
+
+        """
+
+        url = f"{self.base_url}/v1/models/{model_uid}"
+        response = requests.get(url)
+        if response.status_code != 200:
+            raise RuntimeError(
+                f"Failed to get the model description, detail: {response.json()['detail']}"
+            )
+        return response.json()