Repository navigation
docs: list the 0.9.0 public names in DocC and the featurization gaps - #31
Merged
Merged
Conversation
The CuboBragg, CuboCore, CuboEmbedding and CuboVirtual landing pages gain Topics groups for every public type they lacked (polar cube, radial background, resident cube, ellipse fit, calibration and cube editing, Bragg-vector classification and virtual images, featurization, NMF, Gaussian mixtures). CuboEmbedding's Scope and docs/embedding.md name what is not ported from py4DSTEM's Featurization. Done: DocC and text half of CuboKit#15. Next: exercise the new names in tools/consumer-check on a Mac. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VkKZEVGZzxyb2accSwvsbj
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.
Requested by Paul · project thread
Part of #15 (the DocC and text half; the consumer-check half needs a Mac build, see below).
What and why
PolarCube,PolarSampling,PolarPattern,PolarCubeData,RadialBackground,ResidentCube,ResidentCubeError,OriginEstimator;EllipseFitand its plane, parameters, result and error,Calibrationand its companions,CubeEditing,EditedCube, the Fourier resample types,FrameTransform;BraggVectorClassification,BraggVirtualImage,BraggVirtualDetector,BraggDetectorCenter;Featurization,FeatureMatrix,FeatureReduction,FeaturizationNMFResult,FeaturizationError,NMF,GaussianMixture,NumPyRandomState. Every symbol link was checked against the source.docs/embedding.mdname what is not ported (from_braggvectors, ICA,RobustScaler,spatial_separation,consensus,add_features,delete_features) and why, matchingdocs/parity.md.docs/open-items.md: the "DocC pages do not yet list" note now says only the consumer check is left.Not in this PR:
tools/consumer-checkdoes not exercise the new names yet. It is Swift that only builds on macOS, and this was a cloud session with no Swift toolchain, so that half stays on #15 for a Mac session. No Swift source,.github, release or CHANGELOG file is touched.Checklist
swift test -c releasepasses (no Swift change; CI runs it)Generated by Claude Code