Add docs#20
Merged
Merged
Conversation
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.
Related Issues
Adds missing technical documentation for future developers.
Proposed Changes:
Related Issues
Proposed Changes:
This adds a
docs/directory with technical reference documentation for the entirepyvisimpackage. There were no existing prose docs - just the source code anddocstrings - so this is a from-scratch addition.
What's included:
docs/overview.md: a developer overview covering package layout, the coreextract → aggregate → normalize pipeline, the two abstract interfaces
(
SimilarityMetric,FeatureExtractorBase), and design decisions worth knowingbefore touching the code (NumPy-only images, the pluggable similarity function, enum
weights).
docs/encoders/: reference pages forVLADEncoder,FisherVectorEncoder,Pipeline,ImageEncoderBase, and the pretrained weights enums. Includes aVLAD-vs-Fisher Vector comparison and an explanation of the automatic PCA pairing.
docs/features/: reference pages forSIFT,RootSIFT,DeepConvFeature, andLambda, including the Hellinger normalization rationale for RootSIFT and howspatial encoding affects
output_diminDeepConvFeature.docs/dataset/: documentsOxfordFlowerDatasetand calls out the deliberatetrain/test split swap (original test →
"train", original train →"test").docs/neural_networks/: placeholder noting the Siamese network is planned but notyet implemented.
How did you test it?
Documentation only — no code changes. I read every linked source file to verify the
descriptions match the actual implementation.
Notes for the reviewer
The
OxfordFlowerDatasettrain/test swap is documented explicitly because it'snon-obvious and will bite anyone who compares retrieval numbers against papers using
the standard split. Worth double-checking that the description in
docs/dataset/oxford_flower_dataset.mdmatches what's actually in the source.Checklist
docs: add technical reference documentation for pyvisim