doc: gen README

.github/workflows/gen_readme.yml

@@ -24,7 +24,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pyyaml jinja2
+        pip install jinja2 openllm
 
     - name: Run gen_readme.py
       run: python gen_readme.py

gen_readme.py

@@ -3,8 +3,12 @@
 import sys
 
 
+subprocess.check_call([sys.executable, "-m", "openllm", "repo", "remove", "default"])
 subprocess.check_call([sys.executable, "-m", "openllm", "repo", "update"])
-model_list = subprocess.check_output([sys.executable, "-m", "openllm", "model", "list"])
+model_list = subprocess.check_output(
+    [sys.executable, "-m", "openllm", "model", "list"],
+    env={"OPENLLM_TEST_REPO": "."},
+)
 
 env = Environment(loader=FileSystemLoader("."))
 template = env.get_template("readme_md.tpl")

readme_md.tpl

@@ -12,13 +12,13 @@ openllm repo add nightly https://github.com/bentoml/openllm-models@nightly
 
 ## Supported Models
 <table style="width: 100%; border-collapse: collapse;">
-  <tr>
-    <td style="background-color: #D1D5DA; padding: 10px; border-radius: 8px 8px 0 0; width: 100%;">
-      <span style="color: red;">●</span>
-      <span style="color: yellow;">●</span>
-      <span style="color: green;">●</span>
-    </td>
-  </tr>
+<tr>
+  <td style="background-color: #D1D5DA; padding: 10px; border-radius: 8px 8px 0 0; width: 100%;">
+    <span style="color: red;">●</span>
+    <span style="color: yellow;">●</span>
+    <span style="color: green;">●</span>
+  </td>
+</tr>
 <tr>
 <td>
 
@@ -33,3 +33,10 @@ $ openllm model list
 </table>
 
 
+## Development Guide
+
+Open PRs to the `nightly` branch to add new models or update existing models.
+
+You can also fork this repo and add your own models.
+
+Use `openllm repo add` to use your own model repository.