Add documentation for models

Author: yifanmai

docs/mkdocs_macros.py

@@ -0,0 +1,18 @@
+from collections import defaultdict
+
+from helm.proxy.models import ALL_MODELS
+
+
+def define_env(env):
+    @env.macro
+    def models_by_organization():
+        result = defaultdict(list)
+        for model in ALL_MODELS:
+            result[model.creator_organization].append(model)
+        if "Simple" in result:
+            del result["Simple"]
+        return result
+
+    @env.macro
+    def render_model_tags(model):
+        return ", ".join([f"`{tag}`" for tag in model.tags])

docs/models.md

@@ -0,0 +1,18 @@
+# Models
+
+{% for organization, models in models_by_organization().items() %}
+
+## {{ organization }}
+
+{% for model in models %}
+
+### {{ model.display_name }}
+
+- Name: `{{ model.name }}`
+- Group: `{{ model.group }}`
+- Tags: {{ render_model_tags(model) }}
+
+{{ model.description }}
+
+{% endfor %}
+{% endfor %}

docs/requirements.txt

@@ -1,2 +1,3 @@
 mkdocs==1.4.2
 mkdocstrings[python]==0.19.0
+mkdocs-macros-plugin==0.7.0

mkdocs.yml

@@ -5,13 +5,15 @@ theme:
     highlightjs: false
 plugins:
     - search
+    - macros:
+        module_name: docs/mkdocs_macros
     - mkdocstrings:
-            handlers:
-                python:
-                    show_root_heading: true
-                    show_signature_annotations: true
-                    show_bases: false
-                    show_source: false
+        handlers:
+            python:
+                show_root_heading: true
+                show_signature_annotations: true
+                show_bases: false
+                show_source: false
 extra_css:
     - docstrings.css
 markdown_extensions: