This is an automated email from the ASF dual-hosted git repository.
guanmingchiu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/mahout.git
The following commit(s) were added to refs/heads/main by this push:
new bff0b88ef Reorganize website documentation under /qumat namespace
(#818)
bff0b88ef is described below
commit bff0b88ef38808263a65a24a8d2ee2352bd0e1b4
Author: Guan-Ming (Wesley) Chiu <[email protected]>
AuthorDate: Tue Jan 13 13:43:26 2026 +0800
Reorganize website documentation under /qumat namespace (#818)
---
website/_config.yml | 3 ++
website/_includes/navbar.html | 28 +++++------------
website/_includes/sidebar.html | 11 +++++++
website/_sass/mahout/_navbar.scss | 33 ++++++++++++++++++++-
website/assets/images/mascot_with_text.png | Bin 0 -> 5625834 bytes
website/index.md | 21 ++++++++-----
website/papers.md | 10 -------
website/qumat/core/api/index.md | 8 +++++
website/qumat/core/concepts/index.md | 8 +++++
website/qumat/core/examples/index.md | 8 +++++
website/qumat/core/getting-started/index.md | 8 +++++
website/qumat/core/index.md | 15 ++++++++++
website/qumat/index.md | 22 ++++++++++++++
.../An-Efficient-Quantum-Factoring-Algorithm.md | 0
...-Neutral-Atoms-For-Supervised-Classification.md | 0
...antum-machine-learning-beyond-kernel-methods.md | 0
...-the-Potential-of-LLMs-for-Quantum-Computing.md | 0
website/qumat/papers/index.md | 12 ++++++++
website/qumat/qdp/api/index.md | 8 +++++
website/qumat/qdp/concepts/index.md | 8 +++++
website/qumat/qdp/examples/index.md | 8 +++++
website/qumat/qdp/getting-started/index.md | 8 +++++
website/qumat/qdp/index.md | 13 ++++++++
.../01_introduction/index.md | 0
.../quantum-computing-primer/03_qubits/index.md | 0
.../04_quantum_gates/index.md | 0
.../05_quantum_circuits/index.md | 0
.../06_quantum_entanglement/index.md | 0
.../07_quantum_algorithms/index.md | 0
.../08_quantum_error_correction/index.md | 0
.../09_applications/index.md | 0
.../10_advanced_topics/index.md | 0
.../{ => qumat}/quantum-computing-primer/index.md | 8 +----
33 files changed, 194 insertions(+), 46 deletions(-)
diff --git a/website/_config.yml b/website/_config.yml
index 0bdddcfff..f6b81d79a 100644
--- a/website/_config.yml
+++ b/website/_config.yml
@@ -59,6 +59,9 @@ exclude:
# - vendor/gems/
# - vendor/ruby/
+collections_dir: qumat/papers
+
collections:
papers:
output: true
+ permalink: /qumat/papers/:name/
diff --git a/website/_includes/navbar.html b/website/_includes/navbar.html
index 65d1e2e84..152ce4163 100644
--- a/website/_includes/navbar.html
+++ b/website/_includes/navbar.html
@@ -31,6 +31,7 @@
</div>
</li>
+ <!-- Qumat -->
<li class="nav-item dropdown">
<a class="nav-link dropdown-toggle"
href="" id="navbarDropdownMenuLink-qumat"
@@ -39,28 +40,15 @@
aria-expanded="false">Qumat</a>
<div class="dropdown-menu"
aria-labelledby="navbarDropdownMenuLink">
<a class="dropdown-item"
- href="/quantum-computing-primer">Quantum Computing
Primer</a>
-<!-- TODO: Add More QuMat stuff here or refactor the
whole thing-->
- </div>
- </li>
- <!-- Documentation -->
- <li class="nav-item dropdown">
- <a class="nav-link dropdown-toggle"
- href="" id="navbarDropdownMenuLink-docs"
- data-toggle="dropdown"
- aria-haspopup="true"
- aria-expanded="false">Documentation</a>
- <div class="dropdown-menu"
aria-labelledby="navbarDropdownMenuLink">
- <a class="dropdown-item"
- href="/papers.html">Papers</a>
+ href="/qumat">Overview</a>
<a class="dropdown-item"
- href="/documentation/users">User Guide</a>
+ href="/qumat/core">Qumat Core</a>
<a class="dropdown-item"
- href="/documentation/developers">Developer Guide</a>
+ href="/qumat/qdp">QDP (Quantum Data Plane)</a>
<a class="dropdown-item"
- href="/docs/0.13.0/api/docs/">API Reference</a>
+ href="/qumat/quantum-computing-primer">Quantum
Computing Primer</a>
<a class="dropdown-item"
- href="/documentation/tutorials">Tutorials and
Examples</a>
+ href="/qumat/papers">Papers</a>
</div>
</li>
@@ -108,10 +96,10 @@
<a class="nav-link dropdown-toggle"
href="/news-and-events/news.html"
id="navbarDropdownMenuLink-news-events"
aria-haspopup="true"
- aria-expanded="false">Latest Project News</a>
+ aria-expanded="false">News</a>
<div class="dropdown-menu"
aria-labelledby="navbarDropdownMenuLink">
<a class="dropdown-item"
- href="/news-and-events/news.html">Latest Project
News</a>
+ href="/news-and-events/news.html">News</a>
</div>
</li>
diff --git a/website/_includes/sidebar.html b/website/_includes/sidebar.html
index 368e551aa..d73a41bbf 100644
--- a/website/_includes/sidebar.html
+++ b/website/_includes/sidebar.html
@@ -1,3 +1,14 @@
+<!-- Qumat Release Banner -->
+<div class="card mb-4 sidebar">
+ <div class="card-header">
+ 🚀 Qumat 0.4 Released!
+ </div>
+ <div class="card-body">
+ <p class="mb-2">Mahout's new quantum computing layer for building ML
circuits on simulators and real quantum hardware.</p>
+ <a href="/download/downloads.html">Download Qumat 0.4 →</a>
+ </div>
+</div>
+
<!-- Apache Software Foundation Links -->
<div class="card mb-4 sidebar">
<div class="card-header">
diff --git a/website/_sass/mahout/_navbar.scss
b/website/_sass/mahout/_navbar.scss
index 36eb0c855..1ad721ac2 100644
--- a/website/_sass/mahout/_navbar.scss
+++ b/website/_sass/mahout/_navbar.scss
@@ -21,10 +21,14 @@
}
}
border-bottom: 1px solid $gray-200;
+ .navbar-nav > .nav-item {
+ margin-left: 0.5rem;
+ margin-right: 0.5rem;
+ }
.navbar-nav > .nav-item > .nav-link {
@include font-heading;
text-transform: uppercase;
- letter-spacing: .2rem;
+ letter-spacing: .15rem;
font-size: 80%;
color: $body-color;
i {
@@ -34,4 +38,31 @@
color: $blue;
}
}
+
+ // Dropdown menu styles
+ .dropdown-menu {
+ border: 1px solid rgba(0, 0, 0, 0.1);
+ box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1);
+ border-radius: 0.25rem;
+ padding: 0.5rem 0;
+ margin-top: 0.5rem;
+
+ .dropdown-item {
+ padding: 0.5rem 1.5rem;
+ font-size: 0.9rem;
+ color: $body-color;
+ transition: all 0.2s ease;
+
+ &:hover {
+ background-color: rgba($blue, 0.1);
+ color: $blue;
+ padding-left: 1.75rem;
+ }
+
+ &:active {
+ background-color: rgba($blue, 0.2);
+ color: $blue;
+ }
+ }
+ }
}
diff --git a/website/assets/images/mascot_with_text.png
b/website/assets/images/mascot_with_text.png
new file mode 100644
index 000000000..f5c392722
Binary files /dev/null and b/website/assets/images/mascot_with_text.png differ
diff --git a/website/index.md b/website/index.md
index 185dd9a9a..ae98a8699 100644
--- a/website/index.md
+++ b/website/index.md
@@ -2,14 +2,19 @@
layout: home
---
-Apache Mahout(TM) is a <strong>distributed linear algebra framework</strong>
and <strong>mathematically expressive Scala DSL</strong> designed to let
mathematicians, statisticians, and data scientists quickly <em>implement their
own algorithms</em>. Apache Spark is the recommended out-of-the-box distributed
back-end, <em>or can be extended to other distributed backends.</em>
+<h1 class="section-heading">Apache Mahout</h1>
-- Mathematically Expressive Scala DSL
-- Support for Multiple Distributed Backends (including Apache Spark)
-- Modular Native Solvers for CPU/GPU/CUDA Acceleration
+The goal of the Apache Mahoutâ„¢ project is to build an environment for quickly
creating scalable, performant machine learning applications.
-<h2 class="section-heading">Recent News</h2>
+<h2 class="section-heading">Qumat</h2>
-{% for post in site.posts limit: 5 %}
- {% include posts/post-preview.html %}
-{% endfor %}
+<div style="text-align: center; margin: 2rem 0;">
+ <img src="/assets/images/mascot_with_text.png" alt="Apache Mahout Qumat"
style="max-width: 600px; width: 100%;">
+</div>
+
+<strong>Qumat</strong> is a high-level Python library for quantum computing
that provides:
+
+- **Qumat Core** - Build quantum circuits with standard gates and run them
on Qiskit, Cirq, or Amazon Braket with a single unified API
+- **QDP (Quantum Data Plane)** - Encode classical data into quantum states
using GPU-accelerated kernels with zero-copy tensor transfer
+
+[Learn more about Qumat →](/qumat)
diff --git a/website/papers.md b/website/papers.md
deleted file mode 100644
index 6b0d2f914..000000000
--- a/website/papers.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-layout: page
-title: Papers
----
-
-# Papers
-
-{% for paper in site.papers %}
-- [{{ paper.title }}]({{ paper.url }})
-{% endfor %}
diff --git a/website/qumat/core/api/index.md b/website/qumat/core/api/index.md
new file mode 100644
index 000000000..ce5d42997
--- /dev/null
+++ b/website/qumat/core/api/index.md
@@ -0,0 +1,8 @@
+---
+layout: page
+title: API Reference - Qumat Core
+---
+
+# API Reference
+
+<!-- TODO: Add API reference documentation for Qumat Core -->
diff --git a/website/qumat/core/concepts/index.md
b/website/qumat/core/concepts/index.md
new file mode 100644
index 000000000..878ab3741
--- /dev/null
+++ b/website/qumat/core/concepts/index.md
@@ -0,0 +1,8 @@
+---
+layout: page
+title: Core Concepts - Qumat Core
+---
+
+# Core Concepts
+
+<!-- TODO: Add core concepts documentation for Qumat Core -->
diff --git a/website/qumat/core/examples/index.md
b/website/qumat/core/examples/index.md
new file mode 100644
index 000000000..f3f220bc2
--- /dev/null
+++ b/website/qumat/core/examples/index.md
@@ -0,0 +1,8 @@
+---
+layout: page
+title: Examples - Qumat Core
+---
+
+# Examples
+
+<!-- TODO: Add examples for Qumat Core -->
diff --git a/website/qumat/core/getting-started/index.md
b/website/qumat/core/getting-started/index.md
new file mode 100644
index 000000000..66611cfe6
--- /dev/null
+++ b/website/qumat/core/getting-started/index.md
@@ -0,0 +1,8 @@
+---
+layout: page
+title: Getting Started with Qumat Core
+---
+
+# Getting Started
+
+<!-- TODO: Add getting started guide for Qumat Core -->
diff --git a/website/qumat/core/index.md b/website/qumat/core/index.md
new file mode 100644
index 000000000..2fb2fe1d8
--- /dev/null
+++ b/website/qumat/core/index.md
@@ -0,0 +1,15 @@
+---
+layout: page
+title: Qumat Core - Overview
+---
+
+# Qumat Core
+
+Qumat Core provides a unified API for building quantum circuits across
multiple backends.
+
+## Documentation
+
+- [Getting Started](/qumat/core/getting-started)
+- [Core Concepts](/qumat/core/concepts)
+- [API Reference](/qumat/core/api)
+- [Examples](/qumat/core/examples)
diff --git a/website/qumat/index.md b/website/qumat/index.md
new file mode 100644
index 000000000..50fc8509b
--- /dev/null
+++ b/website/qumat/index.md
@@ -0,0 +1,22 @@
+---
+layout: page
+title: Qumat - Quantum Computing with Mahout
+---
+
+# Qumat
+
+Qumat is a high-level Python library for quantum computing that provides:
+
+- **Quantum Circuit Abstraction** - Build quantum circuits with standard gates
(Hadamard, CNOT, Pauli, etc.) and run them on Qiskit, Cirq, or Amazon Braket
with a single unified API. Write once, execute anywhere.
+
+- **QDP (Quantum Data Plane)** - Encode classical data into quantum states
using GPU-accelerated kernels. Zero-copy tensor transfer via DLPack lets you
move data between PyTorch, NumPy, and TensorFlow without overhead.
+
+## Documentation
+
+- [Qumat Core](/qumat/core)
+- [QDP (Quantum Data Plane)](/qumat/qdp)
+
+## Additional Resources
+
+- [Research Papers](/qumat/papers)
+- [Quantum Computing Primer](/qumat/quantum-computing-primer)
diff --git a/website/_papers/An-Efficient-Quantum-Factoring-Algorithm.md
b/website/qumat/papers/_papers/An-Efficient-Quantum-Factoring-Algorithm.md
similarity index 100%
rename from website/_papers/An-Efficient-Quantum-Factoring-Algorithm.md
rename to
website/qumat/papers/_papers/An-Efficient-Quantum-Factoring-Algorithm.md
diff --git
a/website/_papers/Quantum-Kernel-Estimation-With-Neutral-Atoms-For-Supervised-Classification.md
b/website/qumat/papers/_papers/Quantum-Kernel-Estimation-With-Neutral-Atoms-For-Supervised-Classification.md
similarity index 100%
rename from
website/_papers/Quantum-Kernel-Estimation-With-Neutral-Atoms-For-Supervised-Classification.md
rename to
website/qumat/papers/_papers/Quantum-Kernel-Estimation-With-Neutral-Atoms-For-Supervised-Classification.md
diff --git a/website/_papers/Quantum-machine-learning-beyond-kernel-methods.md
b/website/qumat/papers/_papers/Quantum-machine-learning-beyond-kernel-methods.md
similarity index 100%
rename from website/_papers/Quantum-machine-learning-beyond-kernel-methods.md
rename to
website/qumat/papers/_papers/Quantum-machine-learning-beyond-kernel-methods.md
diff --git
a/website/_papers/Unleashing-the-Potential-of-LLMs-for-Quantum-Computing.md
b/website/qumat/papers/_papers/Unleashing-the-Potential-of-LLMs-for-Quantum-Computing.md
similarity index 100%
rename from
website/_papers/Unleashing-the-Potential-of-LLMs-for-Quantum-Computing.md
rename to
website/qumat/papers/_papers/Unleashing-the-Potential-of-LLMs-for-Quantum-Computing.md
diff --git a/website/qumat/papers/index.md b/website/qumat/papers/index.md
new file mode 100644
index 000000000..416fb6711
--- /dev/null
+++ b/website/qumat/papers/index.md
@@ -0,0 +1,12 @@
+---
+layout: page
+title: Qumat Research Papers
+---
+
+# Research Papers
+
+Research papers and publications related to Qumat and quantum computing.
+
+{% for paper in site.papers %}
+- [{{ paper.title }}]({{ paper.url }})
+{% endfor %}
diff --git a/website/qumat/qdp/api/index.md b/website/qumat/qdp/api/index.md
new file mode 100644
index 000000000..e4712a254
--- /dev/null
+++ b/website/qumat/qdp/api/index.md
@@ -0,0 +1,8 @@
+---
+layout: page
+title: API Reference - QDP
+---
+
+# API Reference
+
+<!-- TODO: Add API reference documentation for QDP -->
diff --git a/website/qumat/qdp/concepts/index.md
b/website/qumat/qdp/concepts/index.md
new file mode 100644
index 000000000..7972aed3f
--- /dev/null
+++ b/website/qumat/qdp/concepts/index.md
@@ -0,0 +1,8 @@
+---
+layout: page
+title: Core Concepts - QDP
+---
+
+# Core Concepts
+
+<!-- TODO: Add core concepts documentation for QDP -->
diff --git a/website/qumat/qdp/examples/index.md
b/website/qumat/qdp/examples/index.md
new file mode 100644
index 000000000..21d4473d5
--- /dev/null
+++ b/website/qumat/qdp/examples/index.md
@@ -0,0 +1,8 @@
+---
+layout: page
+title: Examples - QDP
+---
+
+# Examples
+
+<!-- TODO: Add examples for QDP -->
diff --git a/website/qumat/qdp/getting-started/index.md
b/website/qumat/qdp/getting-started/index.md
new file mode 100644
index 000000000..4477ab933
--- /dev/null
+++ b/website/qumat/qdp/getting-started/index.md
@@ -0,0 +1,8 @@
+---
+layout: page
+title: Getting Started with QDP
+---
+
+# Getting Started
+
+<!-- TODO: Add getting started guide for QDP -->
diff --git a/website/qumat/qdp/index.md b/website/qumat/qdp/index.md
new file mode 100644
index 000000000..1f73ea0cb
--- /dev/null
+++ b/website/qumat/qdp/index.md
@@ -0,0 +1,13 @@
+---
+layout: page
+title: QDP - Quantum Data Plane
+---
+
+# QDP
+
+QDP (Quantum Data Plane) is a high-performance GPU-accelerated library for
encoding classical data into quantum states.
+
+- [Getting Started](/qumat/qdp/getting-started)
+- [Core Concepts](/qumat/qdp/concepts)
+- [API Reference](/qumat/qdp/api)
+- [Examples](/qumat/qdp/examples)
diff --git a/website/quantum-computing-primer/01_introduction/index.md
b/website/qumat/quantum-computing-primer/01_introduction/index.md
similarity index 100%
rename from website/quantum-computing-primer/01_introduction/index.md
rename to website/qumat/quantum-computing-primer/01_introduction/index.md
diff --git a/website/quantum-computing-primer/03_qubits/index.md
b/website/qumat/quantum-computing-primer/03_qubits/index.md
similarity index 100%
rename from website/quantum-computing-primer/03_qubits/index.md
rename to website/qumat/quantum-computing-primer/03_qubits/index.md
diff --git a/website/quantum-computing-primer/04_quantum_gates/index.md
b/website/qumat/quantum-computing-primer/04_quantum_gates/index.md
similarity index 100%
rename from website/quantum-computing-primer/04_quantum_gates/index.md
rename to website/qumat/quantum-computing-primer/04_quantum_gates/index.md
diff --git a/website/quantum-computing-primer/05_quantum_circuits/index.md
b/website/qumat/quantum-computing-primer/05_quantum_circuits/index.md
similarity index 100%
rename from website/quantum-computing-primer/05_quantum_circuits/index.md
rename to website/qumat/quantum-computing-primer/05_quantum_circuits/index.md
diff --git a/website/quantum-computing-primer/06_quantum_entanglement/index.md
b/website/qumat/quantum-computing-primer/06_quantum_entanglement/index.md
similarity index 100%
rename from website/quantum-computing-primer/06_quantum_entanglement/index.md
rename to
website/qumat/quantum-computing-primer/06_quantum_entanglement/index.md
diff --git a/website/quantum-computing-primer/07_quantum_algorithms/index.md
b/website/qumat/quantum-computing-primer/07_quantum_algorithms/index.md
similarity index 100%
rename from website/quantum-computing-primer/07_quantum_algorithms/index.md
rename to website/qumat/quantum-computing-primer/07_quantum_algorithms/index.md
diff --git
a/website/quantum-computing-primer/08_quantum_error_correction/index.md
b/website/qumat/quantum-computing-primer/08_quantum_error_correction/index.md
similarity index 100%
rename from
website/quantum-computing-primer/08_quantum_error_correction/index.md
rename to
website/qumat/quantum-computing-primer/08_quantum_error_correction/index.md
diff --git a/website/quantum-computing-primer/09_applications/index.md
b/website/qumat/quantum-computing-primer/09_applications/index.md
similarity index 100%
rename from website/quantum-computing-primer/09_applications/index.md
rename to website/qumat/quantum-computing-primer/09_applications/index.md
diff --git a/website/quantum-computing-primer/10_advanced_topics/index.md
b/website/qumat/quantum-computing-primer/10_advanced_topics/index.md
similarity index 100%
rename from website/quantum-computing-primer/10_advanced_topics/index.md
rename to website/qumat/quantum-computing-primer/10_advanced_topics/index.md
diff --git a/website/quantum-computing-primer/index.md
b/website/qumat/quantum-computing-primer/index.md
similarity index 82%
rename from website/quantum-computing-primer/index.md
rename to website/qumat/quantum-computing-primer/index.md
index 4bef30f48..f601d2a74 100644
--- a/website/quantum-computing-primer/index.md
+++ b/website/qumat/quantum-computing-primer/index.md
@@ -2,14 +2,8 @@
layout: page
title: Quantum Computing Primer
---
- <div>
- <h2>🚀 Qumat 0.4 Released!</h2>
- <p>Mahout's new quantum computing layer for building ML circuits on
simulators and real quantum hardware.</p>
- <a href="/documentation/qumat/">Explore Qumat →</a>
- </div>
-
-# Outline for an In-Depth Primer in Quantum Computing Using `qumat`
+# Quantum Computing Primer
## [1. Introduction to Quantum Computing](01_introduction/)
- **1.1 What is Quantum Computing?**
