Repository navigation
readme: describe the fork that exists now (badges, stance, parallelism, MSRV) - #139
Merged
Merged
Conversation
The README still introduced the fork as an experiment bench whose API is expected to churn, pointed its badges at upstream `faer`, and told callers to hold `spindle::with_lock` around `Par::rayon` calls. None of that is true any more. - Badges and links point at `t4a-faer` (docs.rs and crates.io). The upstream website, `docs.rs/faer` and the upstream zulip stay, labelled as upstream documentation whose API differs in places. - The opening description is the current one: the linear algebra foundation of the tensor4all stack, published on crates.io and used by tenferro, with what differs from upstream (parallelism on `threadteam` through `Par::Team` and `faer::team::with_team`, the correctness fixes, the nightly LAPACK validation, MSRV 1.89, `x86-v4` opt-in), and pointers to `PATCHSET.md` and `upstream-reports/`. "A place for destructive experiments, compatibility not promised" becomes: every change is recorded in `PATCHSET.md`, and published versions follow semver. - The parallelism section states the route that exists (a caller owned team, `with_team` for a scoped call, `Par::Seq` at width one) instead of `Par::rayon` and `spindle::with_lock`. - The MSRV section no longer calls `x86-v4` a default feature; it is opt in while that path settles. No code changes; every relative link resolves. Short sentences, no dashes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Minimal README update, approved by the maintainer (2026-10-29); the full rewrite waits for the linearis rename. Closes #138.
Stale before this change
faerrather thant4a-faer.# parallelismsection documentedPar::rayon(n)andfaer::spindle::with_lock(n, ..), both removed by threadteam is the only parallel route: drop Par::Rayon, the spindle path and the Rayon cost model #97.x86-v4a default feature; it is opt in.What the README says now
docs.rs/faerand the upstream zulip stay, labelled "upstream documentation, for the same crate with an API that differs in places".threadteamthroughPar::Teamandfaer::team::with_team, the correctness fixes with their worklogs, the nightly LAPACK validation with known failures tracked by issue, MSRV 1.89,x86-v4opt in); thenPATCHSET.mdandupstream-reports/as the record, and "published versions follow semver".Par::Seqon the calling thread,Par::Teamon a caller owned team,with_team(width, ..)for a scoped call,par.reborrow()to lend a sub-team, and the note that a caller keeping a budget across many calls should own the team.x86-v4opt in "until that path is settled".upstream-reports/README.mdandPERFORMANCE_TIPS.md.Verification: markdown only, every relative link (
PATCHSET.md,NOTICE,upstream-reports/README.md,PERFORMANCE_TIPS.md) resolves in the tree, and the upstream URLs are the ones the repository already uses. No dashes as punctuation, short sentences.Repository description and homepage are handled by the monitoring side, not here.