Skip to content

Create the new AAanalysis data-flow infogram (df_seq → df_parts → df_feat → model → explain) #227

Description

@breimanntools

Problem

The current data-flow diagram on the Usage Principles page (docs/source/_artwork/diagrams/components.png, shown at usage_principles.rst:49) predates the current API vocabulary and visual style. It is the figure slated for replacement, but no replacement asset exists yet — so the page refresh (#226) is blocked on artwork that has to be designed first.

Goal

Produce one clean, current data-flow infogram asset (the canonical load → parts → feature → model → explain → plot flow) that #226 can drop straight into the Usage Principles page — in a visual style consistent with the new ecosystem map.

Requirements

  • Design a single infogram covering the canonical dataflow: df_seq (+ df_scales / df_cat) → df_parts (via SequenceFeature, split_kws) → df_feat (via CPP) → model (TreeModel) → explanation (ShapModel) → plot, with the side branches AAclust (redundancy reduction) and dPULearn (negatives from unlabeled data).
  • Use the current vocabulary and class names exactly (df_seq, df_parts, split_kws, df_feat; SequenceFeature / AAclust / CPP / dPULearn / TreeModel / ShapModel) — cross-check against docs/module_map.md.
  • Export to docs/source/_artwork/diagrams/ as both a vector (.svg) and a raster (.png) at docs page width.
  • Match the look-and-feel of the ecosystem map (_static/aaanalysis_ecosystem.html) — same palette / typography family — so the two read as one design system.
  • Keep the source/editable form (or the generating script) discoverable for future edits.

KPIs / Acceptance criteria

Scope / non-goals

Dependencies

Standards checklist

  • Artwork only; no CONFIRM-FIRST code surfaces.
  • Names verified against docs/module_map.md / current public API.

Metadata

Metadata

Assignees

No one assigned

    Labels

    prio:3Still importanttopic:coreCore featurestype:dcosImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions