Docs/internals architecture - #307
Conversation
Signed-off-by: Sudha Rajput <rajputsudha034@gmail.com>
Signed-off-by: Sudha Rajput <rajputsudha034@gmail.com>
PR Check Summary
CI will run: build, test, clippy, fmt, cargo-deny, DCO, semver. |
📝 WalkthroughWalkthroughAdds a layered architecture page for the mohu Rust workspace, documents planned Python bindings and related references, and updates ChangesArchitecture documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Warning |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/src/internals/architecture.md`:
- Around line 3-6: Update the layered-crates description in the architecture
documentation to match the manifest dependency graph: state that mohu-ops and
mohu-stats depend on mohu-core, while mohu-random, mohu-special, and mohu-fft
depend directly on foundation crates rather than all routing through the
dispatch layer. Preserve the existing explanation of workspace layering and
composable crate usage.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: b591aa4d-7726-4de5-981f-85d5fa7dc872
📒 Files selected for processing (2)
.gitignoredocs/src/internals/architecture.md
| mohu is organized as a Cargo workspace of layered crates. Each layer only depends on | ||
| the layers below it, which keeps compile times low and makes it possible to use | ||
| pieces of mohu (e.g. just the error types, or just the dtype system) without pulling | ||
| in the whole library. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
rg -n 'mohu-(error|dtype|buffer|array|core|simd|ufunc|index|ops|fft|random|special|stats|sparse|masked|io|testing)' \
--glob 'Cargo.toml' --glob '!target/**'Repository: mohu-org/mohu
Length of output: 151
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Top-level Cargo.toml files:\n'
git ls-files '**/Cargo.toml'
printf '\nWorkspace members from root Cargo.toml:\n'
sed -n '1,220p' Cargo.toml
printf '\nDependency lines mentioning mohu crates across Cargo.toml files:\n'
rg -n 'mohu-' --glob 'Cargo.toml' --glob '!target/**' .Repository: mohu-org/mohu
Length of output: 15259
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Show all Cargo.toml files and their first 200 lines, enough to inspect workspace and dependencies.
while IFS= read -r f; do
echo "===== $f ====="
sed -n '1,200p' "$f"
echo
done < <(git ls-files '**/Cargo.toml')Repository: mohu-org/mohu
Length of output: 203
🏁 Script executed:
#!/bin/bash
set -euo pipefail
find . -name Cargo.toml -not -path '*/target/*' -print | sortRepository: mohu-org/mohu
Length of output: 690
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'architecture.md:\n'
cat -n docs/src/internals/architecture.md | sed -n '1,120p'
printf '\nCompute/dispatch crate dependencies:\n'
for f in \
crates/mohu-simd/Cargo.toml \
crates/mohu-ufunc/Cargo.toml \
crates/mohu-index/Cargo.toml \
crates/mohu-ops/Cargo.toml \
crates/mohu-fft/Cargo.toml \
crates/mohu-random/Cargo.toml \
crates/mohu-special/Cargo.toml \
crates/mohu-stats/Cargo.toml
do
echo "===== $f ====="
sed -n '1,120p' "$f"
echo
doneRepository: mohu-org/mohu
Length of output: 11113
Reword the compute-layer description to match the manifest graph. The workspace layering is fine, but the compute crates do not all route through the dispatch layer: mohu-ops and mohu-stats depend on mohu-core, while mohu-random, mohu-special, and mohu-fft depend on foundation crates directly.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/src/internals/architecture.md` around lines 3 - 6, Update the
layered-crates description in the architecture documentation to match the
manifest dependency graph: state that mohu-ops and mohu-stats depend on
mohu-core, while mohu-random, mohu-special, and mohu-fft depend directly on
foundation crates rather than all routing through the dispatch layer. Preserve
the existing explanation of workspace layering and composable crate usage.
1 participant
the issue is resolved
Summary by CodeRabbit
Documentation
Chores