docs: improve documentation and fix typos (#716)

Author: ad-claw000

aperturedb/Blobs.py

@@ -1,3 +1,9 @@
+"""
+**Module providing the Blobs entity wrapper.**
+
+This module contains the `Blobs` class which acts as an object mapper representation of blobs in ApertureDB,
+inheriting from `Entities`.
+"""
 from __future__ import annotations
 
 from aperturedb.Entities import Entities
@@ -7,7 +13,7 @@ class Blobs(Entities):
     """
     **The object mapper representation of blobs in ApertureDB.**
 
-    This class is a layer on top of the native query.
-    It facilitates interactions with blobs in the database in the pythonic way.
+    This class is a layer on top of the native JSON query (e.g., [FindBlob](/query_language/Reference/blob_commands/FindBlob)).
+    It facilitates interactions with blobs in the database in the Pythonic way.
     """
     db_object = "_Blob"

aperturedb/Connector.py

@@ -549,7 +549,7 @@ def _query(self, query, blob_array = [], try_resume=True):
         if tries == self.config.retry_max_attempts:
             # We have tried enough times, and failed. Log some state info.
             raise Exception(
-                f"Could not query apertureDB using TCP. \r\n\
+                f"Could not query ApertureDB using TCP. \r\n\
                 {self.connected=}\r\n \
                 {self.authenticated=} \r\n \
                 attempts={tries}/{self.config.retry_max_attempts} \r\n \

aperturedb/DaskManager.py

@@ -1,3 +1,10 @@
+"""
+**Module providing the DaskManager.**
+
+This module provides the `DaskManager` class responsible for setting up a
+local Dask cluster and assigning parts of data to each worker to perform
+parallel distributed processing.
+"""
 from __future__ import annotations
 import logging
 from threading import Lock

aperturedb/KaggleData.py

@@ -83,7 +83,7 @@ def generate_index(self, root: str, records_count: int = -1) -> pd.DataFrame:
 
     def generate_query(self, idx: int) -> Tuple[List[dict], List[bytes]]:
         """
-        **Takes information from one atomic record from the Data and converts it to Query for apertureDB**
+        **Takes information from one atomic record from the Data and converts it to Query for ApertureDB**
 
         Args:
             idx (int): index of the record in collection.

aperturedb/NotebookHelpers.py

@@ -1,5 +1,10 @@
 """
 **These are miscellaneous helper methods to render responses from ApertureDB in a jupyter environment.**
+
+This module provides helper classes (such as `BoundingBox`, `TemporalBoundingBox`) and functions
+(such as `display`, `draw_bboxes`, `display_video_mp4`, `display_annotated_video`)
+to help render visual results from ApertureDB queries directly within a Jupyter Notebook.
+It makes it easier to visualize bounding boxes, images, and videos without writing boilerplate code.
 """
 
 import os

aperturedb/ParallelQuery.py

@@ -19,7 +19,13 @@ class ParallelQuery(Parallelizer.Parallelizer):
     **Parallel and Batch Querier for ApertureDB**
 
     This class provides the abstraction for partitioning data into batches,
-    so that they may be processed using different threads.
+    so that they may be processed using different threads. It is useful
+    when you need to perform many queries or large bulk inserts/updates
+    and want to speed up the process by executing them concurrently.
+
+    By using `ParallelQuery`, users can fully utilize their CPU cores and
+    network bandwidth to communicate with ApertureDB in parallel.
+    For information on JSON queries and batching, see the [ApertureDB JSON API documentation](/query_language/Overview/Transactions).
 
     Args:
         client (Connector): The database connector.

aperturedb/PyTorchData.py

@@ -30,7 +30,7 @@ def __len__(self):
 
     def generate_query(self, idx: int) -> Tuple[List[dict], List[bytes]]:
         """
-        **Takes information from one atomic record from the Data and converts it to Query for apertureDB**
+        **Takes information from one atomic record from the Data and converts it to Query for ApertureDB**
 
         Args:
             idx (int): index of the record in collection.

aperturedb/Query.py

@@ -121,7 +121,7 @@ def generate_add_query(
         parent: int = 0) -> Tuple[List[object], List[bytearray], int]:
     """
     Takes the user model, and builds out a sequence of commands that creates
-    a similar structure on apertureDB's graph. For example, given the following
+    a similar structure on ApertureDB's graph. For example, given the following
 
     ```mermaid
     erDiagram

examples/DataWizard/Polygon Regions DataWizard.ipynb

@@ -6,7 +6,7 @@
    "source": [
     "# Working with Data wizard - using some of the polygon queries. \n",
     "\n",
-    "Data Wizard is the new python API way to interact with instance of apertureDB.\n",
+    "Data Wizard is the new python API way to interact with instance of ApertureDB.\n",
     "\n",
     "It tries to avoid the need to know the details of the native query mechanism\n",
     "\n",

examples/README.md

@@ -28,7 +28,7 @@ The following files are under *image_classification*
 | 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
 
 This needs a bit of extra setup.
 - Install the dependent packages using the commands as shown, in the top level path of this repo.
@@ -46,7 +46,7 @@ The following files are under *similarity_search*
 | facenet.py | Face Recognition using facenet and pytorch | Is invoked indirectly |
 | add_faces.py | A Script to load celebA dataset into aperturedb | ``python add_faces.py``|
 
-## Example 4: REST interface to apertureDB.
+## Example 4: REST interface to ApertureDB.
 
 The following files are under *rest_api*