Adding Examples to the Helion Docs/site

docs/GenerateExamples.py

@@ -0,0 +1,40 @@
+import os
+EXAMPLES_DIR = '../../examples'  # Adjust as needed
+RST_DIR = './examples'  # Relative to your Sphinx source dir
+example_files = [
+    'add.py',
+    'all_gather_matmul.py',
+    'attention.py',
+    'bmm.py',
+    'concatenate.py',
+    'cross_entropy.py',
+    'embedding.py',
+    'exp.py',
+    'fp8_attention.py',
+    'fp8_gemm.py',
+    'jagged_dense_add.py',
+    'jagged_mean.py',
+    'long_sum.py',
+    'matmul.py',
+    'matmul_layernorm.py',
+    'matmul_split_k.py',
+    'moe_matmul_ogs.py',
+    'rms_norm.py',
+    'segment_reduction.py',
+    'softmax.py',
+    'sum.py',
+    'template_via_closure.py',
+]
+os.makedirs(RST_DIR, exist_ok=True)
+for fname in example_files:
+    base = os.path.splitext(fname)[0]
+    # Capitalize and replace underscores with spaces for nicer titles
+    title = base.replace('_', ' ').title()
+    rst_path = os.path.join(RST_DIR, f"{base}.rst")
+    with open(rst_path, "w") as f:
+        f.write(f"""{title}
+{'=' * len(title)}
+.. literalinclude:: {os.path.join(EXAMPLES_DIR, fname)}
+   :language: python
+   :linenos:
+""")

docs/Makefile

@@ -3,12 +3,14 @@ SPHINXBUILD ?= sphinx-build
 SOURCEDIR = .
 BUILDDIR = ../site
 
-html: clean
+html: clean genEx
 	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-livehtml: clean
+livehtml: clean genEx
 	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) --open-browser --port 0
 
+genEx:
+	python GenerateExamples.py
 clean:
 	rm -rf $(BUILDDIR)/*
 

docs/examples.rst

@@ -0,0 +1,30 @@
+Examples
+========
+
+Examples showing the use of Helios in various scenarios.
+
+.. toctree::
+   :maxdepth: 1
+
+   examples/add
+   examples/all_gather_matmul
+   examples/attention
+   examples/bmm
+   examples/concatenate
+   examples/cross_entropy
+   examples/embedding
+   examples/exp
+   examples/fp8_attention
+   examples/fp8_gemm
+   examples/jagged_dense_add
+   examples/jagged_mean
+   examples/long_sum
+   examples/matmul
+   examples/matmul_layernorm
+   examples/matmul_split_k
+   examples/moe_matmul_ogs
+   examples/rms_norm
+   examples/segment_reduction
+   examples/softmax
+   examples/sum
+   examples/template_via_closure

docs/examples/add.rst

@@ -0,0 +1,5 @@
+Add
+===
+.. literalinclude:: ../../examples/add.py
+   :language: python
+   :linenos:

docs/examples/all_gather_matmul.rst

@@ -0,0 +1,5 @@
+All Gather Matmul
+=================
+.. literalinclude:: ../../examples/all_gather_matmul.py
+   :language: python
+   :linenos:

docs/examples/attention.rst

@@ -0,0 +1,5 @@
+Attention
+=========
+.. literalinclude:: ../../examples/attention.py
+   :language: python
+   :linenos:

docs/examples/bmm.rst

@@ -0,0 +1,5 @@
+Bmm
+===
+.. literalinclude:: ../../examples/bmm.py
+   :language: python
+   :linenos:

docs/examples/concatenate.rst

@@ -0,0 +1,5 @@
+Concatenate
+===========
+.. literalinclude:: ../../examples/concatenate.py
+   :language: python
+   :linenos:

docs/examples/cross_entropy.rst

@@ -0,0 +1,5 @@
+Cross Entropy
+=============
+.. literalinclude:: ../../examples/cross_entropy.py
+   :language: python
+   :linenos:

docs/examples/embedding.rst

@@ -0,0 +1,5 @@
+Embedding
+=========
+.. literalinclude:: ../../examples/embedding.py
+   :language: python
+   :linenos:

docs/examples/exp.rst

@@ -0,0 +1,5 @@
+Exp
+===
+.. literalinclude:: ../../examples/exp.py
+   :language: python
+   :linenos:

docs/examples/fp8_attention.rst

@@ -0,0 +1,5 @@
+Fp8 Attention
+=============
+.. literalinclude:: ../../examples/fp8_attention.py
+   :language: python
+   :linenos:

docs/examples/fp8_gemm.rst

@@ -0,0 +1,5 @@
+Fp8 Gemm
+========
+.. literalinclude:: ../../examples/fp8_gemm.py
+   :language: python
+   :linenos:

docs/examples/jagged_dense_add.rst

@@ -0,0 +1,5 @@
+Jagged Dense Add
+================
+.. literalinclude:: ../../examples/jagged_dense_add.py
+   :language: python
+   :linenos:

docs/examples/jagged_mean.rst

@@ -0,0 +1,5 @@
+Jagged Mean
+===========
+.. literalinclude:: ../../examples/jagged_mean.py
+   :language: python
+   :linenos:

docs/examples/long_sum.rst

@@ -0,0 +1,5 @@
+Long Sum
+========
+.. literalinclude:: ../../examples/long_sum.py
+   :language: python
+   :linenos:

docs/examples/matmul.rst

@@ -0,0 +1,5 @@
+Matmul
+======
+.. literalinclude:: ../../examples/matmul.py
+   :language: python
+   :linenos:

docs/examples/matmul_layernorm.rst

@@ -0,0 +1,5 @@
+Matmul Layernorm
+================
+.. literalinclude:: ../../examples/matmul_layernorm.py
+   :language: python
+   :linenos:

docs/examples/matmul_split_k.rst

@@ -0,0 +1,5 @@
+Matmul Split K
+==============
+.. literalinclude:: ../../examples/matmul_split_k.py
+   :language: python
+   :linenos:

docs/examples/moe_matmul_ogs.rst

@@ -0,0 +1,5 @@
+Moe Matmul Ogs
+==============
+.. literalinclude:: ../../examples/moe_matmul_ogs.py
+   :language: python
+   :linenos:

docs/examples/rms_norm.rst

@@ -0,0 +1,5 @@
+Rms Norm
+========
+.. literalinclude:: ../../examples/rms_norm.py
+   :language: python
+   :linenos:

docs/examples/segment_reduction.rst

@@ -0,0 +1,5 @@
+Segment Reduction
+=================
+.. literalinclude:: ../../examples/segment_reduction.py
+   :language: python
+   :linenos:

docs/examples/softmax.rst

@@ -0,0 +1,5 @@
+Softmax
+=======
+.. literalinclude:: ../../examples/softmax.py
+   :language: python
+   :linenos:

docs/examples/sum.rst

@@ -0,0 +1,5 @@
+Sum
+===
+.. literalinclude:: ../../examples/sum.py
+   :language: python
+   :linenos:

docs/examples/template_via_closure.rst

@@ -0,0 +1,5 @@
+Template Via Closure
+====================
+.. literalinclude:: ../../examples/template_via_closure.py
+   :language: python
+   :linenos: