fix: fix quick start link and examples

.github/workflows/unit_test.yaml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: ['3.9', '3.10', '3.11', '3.12']
+        python: ['3.10', '3.11', '3.12', '3.13']
 
     steps:
       - name: Checkout

.gitignore

@@ -38,6 +38,10 @@ MANIFEST
 !web/**/lib/
 !web/**/lib/**
 
+# Sphinx
+.sphinx-deps
+web/**/public
+
 .claude
 .vscode
 

README.md

@@ -33,7 +33,7 @@ print(fib.__version__)
 
 ## Get Started
 
-This [guide](https://bench.flashinfer.ai/docs/start/quick_start) shows you how to use FlashInfer-Bench python module with the FlashInfer-Trace dataset.
+This [guide](https://bench.flashinfer.ai/docs/start/quickstart) shows you how to use FlashInfer-Bench python module with the FlashInfer-Trace dataset.
 
 ## FlashInfer Trace Dataset
 

docs/api/conf.py

@@ -0,0 +1,136 @@
+import os
+import sys
+from datetime import datetime
+from pathlib import Path
+from typing import Any, List
+
+import tomli
+
+# import tlcpack_sphinx_addon
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+repo_root = Path(__file__).resolve().parents[2]
+sys.path.insert(0, str(repo_root))
+os.environ["BUILD_DOC"] = "1"
+
+project = "FlashInfer-Bench"
+author = "FlashInfer Community"
+copyright = f"{datetime.now().year}, {author}"
+
+try:
+    from setuptools_scm import get_version as scm_get_version
+except Exception:
+    scm_get_version = None
+
+
+def _compute_version() -> str:
+    v = os.environ.get("FLASHINFER_BENCH_VERSION")
+    if v:
+        return v
+    if scm_get_version is not None:
+        try:
+            return scm_get_version(root=str(repo_root), fallback_version="0.0.0")
+        except Exception:
+            pass
+    try:
+        with open(repo_root / "pyproject.toml", "rb") as f:
+            data = tomli.load(f)
+        v = data.get("project", {}).get("version")
+        if v:
+            return v
+    except Exception:
+        pass
+    return "0.0.0+docs"
+
+
+__version__ = _compute_version()
+
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "myst_parser",
+    "sphinx_tabs.tabs",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.mathjax",
+    "sphinxcontrib.autodoc_pydantic",
+]
+
+autodoc_mock_imports = [
+    "torch",
+    "triton",
+    "flashinfer._build_meta",
+    "cuda",
+    "numpy",
+    "einops",
+    "mpi4py",
+    "safetensors",
+]
+autodoc_default_flags = ["members"]
+autodoc_class_signature = "separated"
+autodoc_member_order = "bysource"
+autodoc_default_options = {"exclude-members": "model_config"}
+autodoc_typehints = "both"
+
+autodoc_pydantic_model_show_validator_summary = False
+autodoc_pydantic_model_show_validator_members = False
+autodoc_pydantic_model_show_config_summary = False
+autodoc_pydantic_field_list_validators = False
+autodoc_pydantic_model_summary_list_order = "bysource"
+autodoc_pydantic_model_member_order = "bysource"
+
+autosummary_generate = True
+
+source_suffix = [".rst", ".md"]
+
+language = "en"
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".sphinx-deps", ".sphinx-deps/**"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# A list of ignored prefixes for module index sorting.
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+myst_enable_extensions = [
+    "dollarmath",
+    "amsmath",
+    "deflist",
+    "colon_fence",
+    "html_image",
+    "linkify",
+    "substitution",
+]
+
+myst_heading_anchors = 3
+myst_ref_domains = ["std", "py"]
+myst_all_links_external = False
+
+# -- Options for HTML output ----------------------------------------------
+
+html_theme = "shibuya"
+
+templates_path: List[Any] = ["_templates"]
+
+html_static_path = ["_static"]
+
+
+html_theme_options = {
+    "accent_color": "indigo",
+    "logo_target": "/",
+    "light_logo": "_static/brand/fib-light.png",
+    "dark_logo": "_static/brand/fib-dark.png",
+    "nav_links": [{"title": "Docs", "url": f"/docs", "external": True}],
+    "globaltoc_expand_depth": 1,
+}

docs/api/index.md

@@ -0,0 +1,10 @@
+# FlashInfer-Bench Python API
+
+```{toctree}
+:maxdepth: 2
+:caption: API Reference
+
+rst/apply
+rst/tracing
+rst/schema
+```

docs/api/requirements.txt

@@ -0,0 +1,8 @@
+autodoc_pydantic>=2.1,<3
+myst-parser[linkify]>=4,<5
+setuptools-scm>=8
+shibuya
+sphinx==7.4.*
+sphinx-tabs>=3.4.7
+sphinx-toolbox
+tomli

docs/api/rst/apply.rst

@@ -0,0 +1,15 @@
+flashinfer_bench.apply
+======================
+
+.. currentmodule:: flashinfer_bench
+
+``flashinfer_bench.apply`` provides a tool that meets two needs:
+
+1. **Apply** best-performing one from FlashInfer Trace database to the LLM engine
+2. **Trace** the kernel in the LLM engine and dump its input as FlashInfer Trace's workload format
+
+.. autofunction:: apply
+
+.. autofunction:: enable_apply
+
+.. autofunction:: disable_apply

docs/api/rst/schema.rst

@@ -0,0 +1,18 @@
+FlashInfer Trace Schema Python API
+==================================
+
+FlashInfer-Bench provides a schema for the FlashInfer Trace database. This document includes
+the Python API for the schema, including
+
+- The :class:`Definition` class, which defines the kernel specification.
+- The :class:`Solution` class, which defines the kernel solution.
+- The :class:`Trace` class, which defines the kernel execution trace.
+- The :class:`TraceSet` class, which defines a set of kernel execution traces.
+
+.. toctree::
+    :maxdepth: 2
+
+    schema_definition
+    schema_solution
+    schema_trace
+    schema_traceset

docs/api/rst/schema_definition.rst

@@ -0,0 +1,15 @@
+Definition
+==========
+
+.. currentmodule:: flashinfer_bench.data
+
+.. autopydantic_model:: Definition
+
+.. autopydantic_model:: AxisConst
+
+.. autopydantic_model:: AxisVar
+
+.. autopydantic_model:: TensorSpec
+
+.. autoclass:: flashinfer_bench.data.definition.DType
+    :members:

docs/api/rst/schema_solution.rst

@@ -0,0 +1,13 @@
+Solution
+========
+
+.. currentmodule:: flashinfer_bench.data
+
+.. autopydantic_model:: Solution
+
+.. autoclass:: SupportedLanguages
+    :members:
+
+.. autopydantic_model:: SourceFile
+
+.. autopydantic_model:: BuildSpec

docs/api/rst/schema_trace.rst

@@ -0,0 +1,29 @@
+Trace
+=====
+
+.. currentmodule:: flashinfer_bench.data
+
+.. autopydantic_model:: Trace
+
+.. autopydantic_model:: RandomInput
+
+.. autopydantic_model:: ScalarInput
+
+.. autopydantic_model:: SafetensorsInput
+
+.. autodata:: InputSpec
+
+   Union type representing all possible input specification types.
+
+.. autopydantic_model:: Workload
+
+.. autopydantic_model:: Correctness
+
+.. autopydantic_model:: Performance
+
+.. autopydantic_model:: Environment
+
+.. autoclass:: EvaluationStatus
+    :members:
+
+.. autopydantic_model:: Evaluation

docs/api/rst/schema_traceset.rst

@@ -0,0 +1,8 @@
+TraceSet
+========
+
+.. currentmodule:: flashinfer_bench.data
+
+.. autoclass:: TraceSet
+    :members:
+    :exclude-members: __init__

docs/api/rst/tracing.rst

@@ -0,0 +1,15 @@
+flashinfer_bench.tracing
+========================
+
+``flashinfer_bench.tracing`` provides tools for tracing kernel executions during LLM inference
+and collecting workload traces for the FlashInfer Trace database. This module enables:
+
+1. **Workload Collection**: Capture kernel inputs and execution patterns during runtime
+2. **Configurable Tracing**: Control what data to collect and how to deduplicate or filter traces
+3. **Filter Policies**: Apply policies to reduce redundant traces and manage dataset size
+
+.. currentmodule:: flashinfer_bench
+
+.. autofunction:: enable_tracing
+
+.. autofunction:: disable_tracing

docs/index.mdx

@@ -20,8 +20,8 @@ Useful links:
 
 ## Next Steps
 
-- Get Started: ./start/quick_start
+- Get Started: ./start/quickstart
 - Installation: ./start/installation
-- Schema (FlashInfer Trace): ./flashinfer_trace/flashinfer_trace
+- Schema (FlashInfer Trace): ./flashinfer-trace
 - Tutorials: ./tutorials/bring_your_own_kernel
 - API Reference: ./api/reference

docs/start/installation.mdx

@@ -3,7 +3,7 @@
 ## Prerequisites
 
 - OS: Linux
-- Python: 3.9, 3.10, 3.11, 3.12
+- Python: 3.10, 3.11, 3.12, 3.13
 
 ## Python Package (WIP)