Skip to content

docs: Overhaul applied/algorithms with Kalman Filter visualization and examples#446

Draft
fderuiter wants to merge 1 commit intomainfrom
curator-algorithms-docs-16021305560104861322
Draft

docs: Overhaul applied/algorithms with Kalman Filter visualization and examples#446
fderuiter wants to merge 1 commit intomainfrom
curator-algorithms-docs-16021305560104861322

Conversation

@fderuiter
Copy link
Owner

This PR overhauls the math_explorer/src/applied/algorithms/mod.rs documentation to address the "Visual Void" identified in the Curator's Log.

Changes include:

  1. Taxonomy Diagram: A Mermaid chart showing the relationship between algorithms and visualizing the Kalman Filter Predict-Update cycle.
  2. Quick Start Example: A self-contained, runnable Rust example demonstrating how to implement a KalmanModel for 1D tracking.
  3. Module Description: Clarified the purpose of the module as a collection of foundational tools.

This change reduces the "Time to First Run" for users interested in state estimation and makes the algorithms module more accessible.


PR created automatically by Jules for task 16021305560104861322 started by @fderuiter

…d examples

- Added a Mermaid diagram to `applied/algorithms/mod.rs` to visualize the module taxonomy and the Kalman Filter estimation loop.
- Added a runnable "Quick Start" example for a 1D Constant Velocity Kalman Filter.
- Updated module documentation to explain the role of general-purpose algorithms in the library.
- Recorded the documentation decision in `.jules/curator.md`.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
@google-labs-jules
Copy link
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant