Skip to content

Soften README's framing of the piqc/ModelSpec relationship - #9

Open
paralleliq wants to merge 1 commit into
mainfrom
fix/readme-methodology-disclosure
Open

paralleliq wants to merge 1 commit into
mainfrom
fix/readme-methodology-disclosure

Conversation

@paralleliq

Copy link
Copy Markdown
Owner

Summary

  • Removes the "detecting drift between declared and actual" mechanism language and the three-layer system diagram (Knowledge Base / ModelSpec / piqc scan) from the README
  • Replaces it with a description that still explains what ModelSpec is and that it pairs well with piqc, without describing the internal product methodology as specifically

Why

Internal review flagged that this section described how the platform's detection mechanism works, not just what ModelSpec is — closer to methodology disclosure than the "name what exists" bar we want for this repo.

🤖 Generated with Claude Code

Remove the explicit "detecting drift between declared and actual"
mechanism description and the three-layer system diagram — both
described internal product methodology more specifically than an
open-standard repo should, rather than just naming what ModelSpec is
and does on its own.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

@stavares843 stavares843 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new sentence still says ModelSpec is a common format for comparing declared vs running, which piqc doesn't do. piqc has no compare step, and its output uses apiVersion: modelspec.paralleliq.ai/v1 while this schema requires piqc.ai/v1alpha1. It also cuts against paralleliq/paralleliq#2, which drops the same implication from the org README.

Suggest keeping the "used alone" sentence and replacing the second with something like "To see what is actually running on a cluster, see piqc."

Also, if the aim is to stop publishing the three-layer framing, piqc's GOVERNANCE.md still has the same table under "Relationship to the ParalleliQ Ecosystem."

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.

2 participants