docs: improve documentation and fix typos#716
Merged
Conversation
- Add module docstrings to Blobs.py and DaskManager.py - Add explanatory docstrings to NotebookHelpers.py and ParallelQuery.py - Fix casing of ApertureDB in PyTorchData.py, KaggleData.py, Connector.py, Query.py, and examples - Add links to JSON API for FindBlob and batching in docstrings Fixes #292
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves developer-facing documentation across the Python SDK by adding missing module/class docstrings, clarifying usage for key helpers, and standardizing the “ApertureDB” name casing in docs and messages.
Changes:
- Added/expanded docstrings for
Blobs,DaskManager,NotebookHelpers, andParallelQuery, including references to relevant JSON API docs. - Standardized “ApertureDB” casing in docstrings, error messages, and example documentation/notebooks.
- Minor documentation touch-ups in examples and query-builder docs.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| examples/README.md | Fixes section heading casing for “ApertureDB”. |
| examples/DataWizard/Polygon Regions DataWizard.ipynb | Updates narrative text to use “ApertureDB” casing. |
| aperturedb/Query.py | Docstring casing update (“ApertureDB’s graph”). |
| aperturedb/PyTorchData.py | Docstring casing update to “ApertureDB”. |
| aperturedb/ParallelQuery.py | Adds more explanatory class docstring + batching doc link. |
| aperturedb/NotebookHelpers.py | Adds module-level description of notebook visualization helpers. |
| aperturedb/KaggleData.py | Docstring casing update to “ApertureDB”. |
| aperturedb/DaskManager.py | Adds missing module docstring describing purpose/behavior. |
| aperturedb/Connector.py | Error message casing update to “ApertureDB”. |
| aperturedb/Blobs.py | Adds module docstring + adds JSON API reference link in class docstring. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
27
to
+31
| | prepare_aperturedb.py | Helper to download images from coco dataset, and load them into aperturedb | ``python prepare_aperturedb.py -images_count 100`` | | ||
| | pytorch_classification.py | Pulls all images from aperturedb with a certain property set by prepare_aperturedb.py script , and classifies them using alexnet | ``python pytorch_classification.py`` | | ||
| | pytorch_classification.ipynb | It does the same operation as ``pytorch_classification.py``. Also displays the classified images | Also available to read at [Aperturedb python documentation](https://docs.aperturedata.io/HowToGuides/Advanced/pytorch_classification) | | ||
|
|
||
| ## Example 3: Similarity search using apertureDB | ||
| ## Example 3: Similarity search using ApertureDB |
luisremis
approved these changes
May 21, 2026
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.
Summary
Verification
Documentation changes verified manually in code. Tests requiring ApertureDB instance skipped.
Fixes #292