From 764d86289c2032c5a77f504b1d1d8c585a45ecdb Mon Sep 17 00:00:00 2001
From: Aaron <29749331+aarnphm@users.noreply.github.com>
Date: Mon, 12 Jun 2023 16:57:24 -0400
Subject: [PATCH] chore(readme): update table with model_ids matrix

Signed-off-by: Aaron <29749331+aarnphm@users.noreply.github.com>
---
 README.md              | 50 ++++++++++++++++++++++++++++++++++++++++--
 tools/update-readme.py |  9 +++++---
 2 files changed, 54 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 3f9d6a36..e455f7ae 100644
--- a/README.md
+++ b/README.md
@@ -103,14 +103,14 @@ openllm query 'Explain to me the difference between "further" and "farther"'
 
 Visit `http://0.0.0.0:3000/docs.json` for OpenLLM's API specification.
 
-Users can also specify different variants of the model to be served, by providing the 
+Users can also specify different variants of the model to be served, by providing the
 `--model-id` argument, e.g.:
 
 ```bash
 openllm start flan-t5 --model-id google/flan-t5-large
 ```
 
-Use the `openllm models` command to see the list of models and their variants supported 
+Use the `openllm models` command to see the list of models and their variants supported
 in OpenLLM.
 
 
@@ -128,6 +128,7 @@ dependencies can be installed with the instructions below:
 <th>CPU</th>
 <th>GPU</th>
 <th>Installation</th>
+<th>Model Ids</th>
 </tr>
 <tr>
 
@@ -140,6 +141,15 @@ dependencies can be installed with the instructions below:
 pip install "openllm[flan-t5]"
 ```
 
+</td>
+<td>
+
+<li><code>google/flan-t5-small</code></li>
+<li><code>google/flan-t5-base</code></li>
+<li><code>google/flan-t5-large</code></li>
+<li><code>google/flan-t5-xl</code></li>
+<li><code>google/flan-t5-xxl</code></li>
+
 </td>
 </tr>
 <tr>
@@ -153,6 +163,13 @@ pip install "openllm[flan-t5]"
 pip install openllm
 ```
 
+</td>
+<td>
+
+<li><code>databricks/dolly-v2-3b</code></li>
+<li><code>databricks/dolly-v2-7b</code></li>
+<li><code>databricks/dolly-v2-12b</code></li>
+
 </td>
 </tr>
 <tr>
@@ -166,6 +183,13 @@ pip install openllm
 pip install "openllm[chatglm]"
 ```
 
+</td>
+<td>
+
+<li><code>thudm/chatglm-6b</code></li>
+<li><code>thudm/chatglm-6b-int8</code></li>
+<li><code>thudm/chatglm-6b-int4</code></li>
+
 </td>
 </tr>
 <tr>
@@ -179,6 +203,12 @@ pip install "openllm[chatglm]"
 pip install "openllm[starcoder]"
 ```
 
+</td>
+<td>
+
+<li><code>bigcode/starcoder</code></li>
+<li><code>bigcode/starcoderbase</code></li>
+
 </td>
 </tr>
 <tr>
@@ -192,6 +222,14 @@ pip install "openllm[starcoder]"
 pip install "openllm[falcon]"
 ```
 
+</td>
+<td>
+
+<li><code>tiiuae/falcon-7b</code></li>
+<li><code>tiiuae/falcon-40b</code></li>
+<li><code>tiiuae/falcon-7b-instruct</code></li>
+<li><code>tiiuae/falcon-40b-instruct</code></li>
+
 </td>
 </tr>
 <tr>
@@ -205,6 +243,14 @@ pip install "openllm[falcon]"
 pip install openllm
 ```
 
+</td>
+<td>
+
+<li><code>stabilityai/stablelm-tuned-alpha-3b</code></li>
+<li><code>stabilityai/stablelm-tuned-alpha-7b</code></li>
+<li><code>stabilityai/stablelm-base-alpha-3b</code></li>
+<li><code>stabilityai/stablelm-base-alpha-7b</code></li>
+
 </td>
 </tr>
 </table>
diff --git a/tools/update-readme.py b/tools/update-readme.py
index 687a396d..c45fb433 100755
--- a/tools/update-readme.py
+++ b/tools/update-readme.py
@@ -38,12 +38,13 @@ def main() -> int:
         readme = f.readlines()
 
     start_index, stop_index = readme.index(START_COMMENT), readme.index(END_COMMENT)
-    formatted: dict[t.Literal["Model", "CPU", "GPU", "URL", "Installation"], list[str]] = {
+    formatted: dict[t.Literal["Model", "CPU", "GPU", "URL", "Installation", "Model Ids"], list[str]] = {
         "Model": [],
         "URL": [],
         "CPU": [],
         "GPU": [],
         "Installation": [],
+        "Model Ids": [],
     }
     max_install_len_div = 0
     for name, config in openllm.CONFIG_MAPPING.items():
@@ -52,6 +53,7 @@ def main() -> int:
         formatted["URL"].append(config.__openllm_url__)
         formatted["GPU"].append("✅")
         formatted["CPU"].append("✅" if not config.__openllm_requires_gpu__ else "❌")
+        formatted["Model Ids"].append(config.__openllm_model_ids__)
         if dashed in deps:
             instruction = f'```bash\npip install "openllm[{dashed}]"\n```'
         else:
@@ -67,8 +69,8 @@ def main() -> int:
     meta.extend([f"<th>{header}</th>\n" for header in formatted.keys() if header not in ("URL",)])
     meta += ["</tr>\n"]
     # NOTE: rows
-    for name, url, cpu, gpu, installation in t.cast(
-        t.Iterable[t.Tuple[str, str, str, str, str]], zip(*formatted.values())
+    for name, url, cpu, gpu, installation, model_ids in t.cast(
+        t.Iterable[t.Tuple[str, str, str, str, str, str]], zip(*formatted.values())
     ):
         meta += "<tr>\n"
         meta.extend(
@@ -79,6 +81,7 @@ def main() -> int:
                 f"<td>\n\n{installation}\n\n</td>\n",
             ]
         )
+        meta.append("<td>\n\n" + "\n".join(["<li><code>" + lid + "</code></li>" for lid in model_ids]) + "\n\n</td>\n")
         meta += "</tr>\n"
     meta.extend(["</table>\n", "\n"])