Skip to content

docs(readme): add 'Motivation and Problem Statement' section#247

Merged
dmitsh merged 1 commit into
mainfrom
ds-readme
Apr 16, 2026
Merged

docs(readme): add 'Motivation and Problem Statement' section#247
dmitsh merged 1 commit into
mainfrom
ds-readme

Conversation

@dmitsh
Copy link
Copy Markdown
Collaborator

@dmitsh dmitsh commented Apr 15, 2026

No description provided.

Signed-off-by: Dmitry Shmulevich <dshmulevich@nvidia.com>
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 15, 2026

Greptile Summary

This PR adds a "Motivation and Problem Statement" section to the README, explaining why topology-aware scheduling matters for GPU workloads at scale. It also renames the old "Components" section to "Architecture," updates the project's introductory sentence, and rewrites the API Server component description for clarity. All changes are documentation-only with no code impact.

Confidence Score: 5/5

Documentation-only change, safe to merge with no code impact.

All changes are to README.md prose. The new Motivation section is technically accurate, well-written, and consistent with the rest of the document. No code, logic, or configuration is modified.

No files require special attention.

Important Files Changed

Filename Overview
README.md Documentation-only change: adds Motivation section, renames Components→Architecture, updates intro and API Server descriptions — well-written and technically accurate.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    Sources["Topology Sources\n(Cloud APIs, Fabric Mgmt, System Tools)"]
    Provider["Provider\n(discovers & normalizes topology)"]
    Internal["Internal Topology Representation"]
    Engine["Engine\n(translates to scheduler format)"]
    Schedulers["Schedulers\n(Slurm / Kubernetes / Slinky)"]

    APIServer["API Server\n(aggregates requests, async results)"]
    NodeObserver["Node Observer\n(Kubernetes node watch)"]
    NodeDataBroker["Node Data Broker\n(Kubernetes node annotations)"]

    Sources --> Provider
    NodeObserver -->|"node change event"| APIServer
    NodeDataBroker -->|"node attributes"| Provider
    APIServer -->|"trigger discovery"| Provider
    Provider --> Internal
    Internal --> Engine
    Engine --> Schedulers
Loading

Reviews (1): Last reviewed commit: "docs(readme): add 'Motivation and Proble..." | Re-trigger Greptile

@dmitsh dmitsh requested a review from resker April 16, 2026 00:00
@dmitsh dmitsh merged commit fcbd9b0 into main Apr 16, 2026
1 of 4 checks passed
@dmitsh dmitsh deleted the ds-readme branch April 16, 2026 16:11
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