You are viewing a plain text version of this content. The canonical link for it is here.
Posted to gsoc@community.apache.org by "Rich Huang (Jira)" <ji...@apache.org> on 2026/02/23 06:35:00 UTC
[jira] [Updated] (GSOC-327) Rust code quality and website improvements for Apache Mahout (QDP & site)
[ https://issues.apache.org/jira/browse/GSOC-327?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rich Huang updated GSOC-327:
----------------------------
Labels: Mahout gsoc2026 mentor (was: )
> Rust code quality and website improvements for Apache Mahout (QDP & site)
> -------------------------------------------------------------------------
>
> Key: GSOC-327
> URL: https://issues.apache.org/jira/browse/GSOC-327
> Project: Comdev GSOC
> Issue Type: Improvement
> Reporter: Rich Huang
> Priority: Major
> Labels: Mahout, gsoc2026, mentor
>
> h2. Background
> * *QDP:* GPU-accelerated quantum state encoding with a Rust core ({{{}qdp-core{}}}), CUDA kernels ({{{}qdp-kernels{}}}), and PyO3 bindings ({{{}qumat.qdp{}}} / {{{}_qdp{}}}). Keeping the Rust stack in good shape and visible (e.g. via rustdoc) is part of project health.
> * *Website:* Built with Docusaurus; {{docs/}} is the source of truth. Work here includes site code (config, scripts, components), fixing link and nav issues, integrating API docs, and CI.
> h2. Project context
> * *QDP encodings:* {{qdp/qdp-core/src/gpu/encodings/}} — {{QuantumEncoder}} trait, {{{}get_encoder{}}}, encodings: amplitude, angle, basis, iqp.
> * *Website:* Docusaurus 3.x; source of truth {{docs/}} (sync script copies into {{website/}} before build).
> * *QDP API:* Encoding methods {{{}"amplitude" | "angle" | "basis" | "iqp" | "iqp-z"{}}}; see {{{}docs/qdp/api.md{}}}.
> h2. Concrete improvements
> h3. Rust (QDP)
> * *Unsafe scope refactor:* Narrow {{unsafe}} blocks; keep setup/teardown outside; add {{// SAFETY:}} where needed; avoid new broad {{unsafe}} regions.
> * *Doc coverage:* Add or fix {{///}} / {{//!}} for public items (first-line summary; optional {{# Examples}} / {{{}# Panics{}}}). Use {{cargo doc --no-deps}} → {{{}target/doc/{}}}.
> * *Lints and style:* Fix {{cargo clippy}} warnings; remove dead code and unused imports; {{{}rustfmt{}}}.
> * *Small refactors:* Extract helpers, clarify names, shorten long functions; no behavior change.
> * *Tests:* Add or tighten unit tests where coverage is low; keep tests fast and deterministic.
> h3. Website
> * *Link errors:* Fix broken links, wrong URLs, and redirect issues in {{docs/}} and the built site.
> * *Site programming:* Fix or improve Docusaurus config, sync scripts, or components.
> * *Nav and sidebar:* Align labels and order with content; fix inconsistencies.
> * *Doc build in CI:* Run {{cargo doc --no-deps}} (and optionally Python doc generation); fail on errors.
> * *Placeholders:* Replace "TODO: Add API reference" with a link or short summary.
> Tracked github issue
> https://github.com/apache/mahout/issues/1080
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: gsoc-unsubscribe@community.apache.org
For additional commands, e-mail: gsoc-help@community.apache.org