core-lens 0.1.dev136__tar.gz → 0.1.dev140__tar.gz

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: core-lens
-Version: 0.1.dev136
+Version: 0.1.dev140
 Summary: Query, analyse, and visualise CoreStack's microwatershed and Earth science data through a clean, composable Python API.
 Project-URL: Homepage, https://github.com/ApoorvaKashyap/core-lens
 Project-URL: Issues, https://github.com/ApoorvaKashyap/core-lens/issues

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/benchmarks/bench_aoi.py

@@ -1,5 +1,4 @@
-"""
-bench_aoi.py — Benchmark for core_lens.aoi
+"""bench_aoi.py — Benchmark for core_lens.aoi
 ===========================================
 Targets:
   - AoI.register()              entity registration + path probe

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/benchmarks/bench_export.py

@@ -1,5 +1,4 @@
-"""
-bench_export.py — Benchmark for core_lens.export.formats
+"""bench_export.py — Benchmark for core_lens.export.formats
 =========================================================
 Targets:
   - export.parquet()            Polars write_parquet (no geometry)

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/benchmarks/bench_polars_utils.py

@@ -1,5 +1,4 @@
-"""
-bench_polars_utils.py — Benchmark for core_lens.utils.polars_utils
+"""bench_polars_utils.py — Benchmark for core_lens.utils.polars_utils
 ===================================================================
 Targets:
   - _gpu_available()            module-level probe + caching

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/benchmarks/bench_result.py

@@ -1,5 +1,4 @@
-"""
-bench_result.py — Benchmark for core_lens.base.result.Result
+"""bench_result.py — Benchmark for core_lens.base.result.Result
 =============================================================
 Targets:
   - Result.df()                 zero-copy accessor

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/benchmarks/bench_schema.py

@@ -1,5 +1,4 @@
-"""
-bench_schema.py — Benchmark for core_lens.schema.detection
+"""bench_schema.py — Benchmark for core_lens.schema.detection
 ============================================================
 Targets:
   - detect()                    full schema auto-detection from Parquet metadata

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/benchmarks/bench_season.py

@@ -1,5 +1,4 @@
-"""
-bench_season.py — Benchmark for core_lens.utils.season
+"""bench_season.py — Benchmark for core_lens.utils.season
 =======================================================
 Targets:
   - SeasonConfig.__post_init__      validation cost (datetime.strptime × 6)

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/benchmarks/bench_spatial.py

@@ -1,5 +1,4 @@
-"""
-bench_spatial.py — Benchmark for core_lens.utils.spatial
+"""bench_spatial.py — Benchmark for core_lens.utils.spatial
 =========================================================
 Targets:
   - build_bbox_index()          cold build (Shapely decode path) vs pre-computed bbox path

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/benchmarks/bench_view.py

@@ -1,5 +1,4 @@
-"""
-bench_view.py — Benchmark for core_lens.base.view.View
+"""bench_view.py — Benchmark for core_lens.base.view.View
 =======================================================
 Targets:
   - View.where()                attribute filter (Polars semi-join on static file)

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/docs/source/export.md

@@ -41,7 +41,13 @@ geoparquet(
 
 # Export to GeoJSON
 geojson(spatial_res, "output.json")
+
+# Export to newline-delimited GeoJSON (GeoJSONSeq)
+geojson(spatial_res, "output.ndjson", driver="GeoJSONSeq")
 ```
 
-> [!NOTE]
-> Exporting to geospatial formats automatically uses DuckDB to cast WKB geometries to proper spatial types via the `spatial` extension. CoreLens handles the installation and loading of the extension seamlessly under the hood.
+```{note}
+Exporting to **GeoParquet** uses DuckDB to cast WKB geometries to proper spatial types via the `spatial` extension. CoreLens handles the installation and loading of the extension seamlessly under the hood.
+
+Exporting to **GeoJSON** is fully natively streamed directly from Polars and Shapely without invoking GDAL or DuckDB, making it extremely fast for large datasets. Driver-specific kwargs for GeoJSON are ignored.
+```

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/docs/source/intro.md

@@ -13,4 +13,6 @@ CoreLens provides a unified interface over microwatersheds, administrative bound
 - **Temporal & Seasonal Awareness**: Native support for agronomic seasons (Kharif, Rabi, Zaid) and time-range filtering.
 - **Spatial Statistics & Analysis**: Built-in methods for anomaly detection, spatial similarity, temporal correlation, and hypothesis testing.
 - **Interactive Visualisation**: Generate interactive maps using Lonboard with zero-copy GeoArrow rendering directly from Polars, and timeseries/scatter plots using Bokeh.
-- **High-Performance Exports**: Export results directly to Parquet, JSON, CSV, or spatially-enabled GeoParquet and GeoJSON using integrated DuckDB spatial extensions.
+- **Cloud & Local Data**: Native support for reading Parquet data from local filesystems or directly from cloud storage (e.g., `s3://`).
+- **High-Performance Exports**: Export results directly to Parquet, JSON, CSV, or spatially-enabled GeoParquet and GeoJSON (with a fast streaming writer).
+- **Advanced Caching**: Transparently caches boundaries and pre-computes spatial indices (via on-disk sidecars) to achieve sub-second query initialisation times.

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/docs/source/queries.md

@@ -58,5 +58,6 @@ joined_view = aoi.mws.spatial_join(
 # res = joined_view.annual
 ```
 
-> [!NOTE]
-> Cross-entity spatial join execution (materialisation) is currently under development and will be added in a subsequent release. Calling materialisation methods (like `.annual`, `.static`, or `.fortnightly`) on a joined view will raise a `NotImplementedError` in the current version.
+```{note}
+Cross-entity spatial join execution (materialisation) is currently under development and will be added in a subsequent release. Calling materialisation methods (like `.annual`, `.static`, or `.fortnightly`) on a joined view will raise a `NotImplementedError` in the current version.
+```

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/docs/source/quickstart.md

@@ -25,18 +25,18 @@ AoI.register(MWSEntity)
 AoI.register(TehsilEntity)
 ```
 
-Create an `AoI` (Area of Interest) by specifying the `data_root` and your boundary (either by name, bounding box, or Shapely geometry):
+Create an `AoI` (Area of Interest) by specifying the `data_root` (which can be a local path or a cloud URI like `s3://bucket/data`) and your boundary (either by name, bounding box, or Shapely geometry):
 
 ```python
-# Create an AoI scoped to a specific Tehsil
+# Create an AoI scoped to a specific Tehsil using a local path
 aoi = AoI(
     data_root="/path/to/data",
     tehsil="Pangi"
 )
 
-# Or scope it directly to a specific list of entity IDs
+# Or scope it directly to a specific list of entity IDs using an S3 bucket
 aoi_specific = AoI(
-    data_root="/path/to/data",
+    data_root="s3://my-cloud-bucket/core-lens-data",
     mws_id=["13_001", "13_002"]
 )
 

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/examples/demo_mws.py

@@ -1,5 +1,4 @@
-"""
-demo_mws.py — core_lens MWSEntity capability demonstration
+"""demo_mws.py — core_lens MWSEntity capability demonstration
 =========================================================
 Walks through every meaningful operation available on a spatiotemporal
 entity: registration, AoI construction, filtering, materialisation,

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/examples/demo_tehsil.py

@@ -1,5 +1,4 @@
-"""
-demo_tehsil.py — core_lens TehsilEntity capability demonstration
+"""demo_tehsil.py — core_lens TehsilEntity capability demonstration
 =================================================================
 Walks through every meaningful operation available on a static-only
 entity: registration, AoI construction, filtering, materialisation,

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/src/core_lens/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.1.dev136'
-__version_tuple__ = version_tuple = (0, 1, 'dev136')
+__version__ = version = '0.1.dev140'
+__version_tuple__ = version_tuple = (0, 1, 'dev140')
 
 __commit_id__ = commit_id = None

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/src/core_lens/aoi.py

@@ -47,6 +47,7 @@ class SeasonConfig:
         kharif: Kharif (monsoon) season range as ``(start_MM-DD, end_MM-DD)``.
         rabi: Rabi (winter) season range.
         zaid: Zaid (summer) season range.
+
     """
 
     kharif: tuple[str, str] = ("07-01", "10-31")
@@ -76,6 +77,7 @@ class SeasonConfig:
 
         Returns:
             str: ``"kharif"``, ``"rabi"``, or ``"zaid"``.
+
         """
         md = f"{d.month:02d}-{d.day:02d}"
         for name in ("kharif", "rabi", "zaid"):
@@ -115,6 +117,7 @@ def _default_season_config() -> SeasonConfig:
 
     Returns:
         SeasonConfig: The shared default instance.
+
     """
     global _DEFAULT_SEASON_CONFIG
     if _DEFAULT_SEASON_CONFIG is None:
@@ -167,6 +170,7 @@ def _cached_resolve_boundary(
 
     Returns:
         tuple: ``(geometry_wkb, entity_name, key_rows)``.
+
     """
     from core_lens.base.entity import _entity_name as _ename
 
@@ -284,6 +288,7 @@ class AoI:
         data_root: Resolved path to the data directory.
         geometry: Shapely polygon representing the AoI boundary.
         seasons: :class:`SeasonConfig` in effect for this AoI.
+
     """
 
     def __init__(
@@ -331,6 +336,7 @@ class AoI:
                 one boundary mode is used simultaneously.
             :class:`~core_lens.base.EntityValidationError`: If a boundary entity referenced in
                 ``entity_kwargs`` is not registered.
+
         """
         # Preserve cloud URIs as-is; resolve local paths to absolute.
         data_root_str = str(data_root)
@@ -395,6 +401,7 @@ class AoI:
 
         Returns:
             str: ``"kharif"``, ``"rabi"``, or ``"zaid"``.
+
         """
         return self.seasons.season_for(date.today())
 
@@ -404,6 +411,7 @@ class AoI:
 
         Returns:
             int: Current year as an integer.
+
         """
         return date.today().year
 
@@ -416,6 +424,7 @@ class AoI:
 
         Returns:
             Any: A Lonboard Map object.
+
         """
         import lonboard
         import geopandas as gpd
@@ -476,6 +485,7 @@ class AoI:
         Raises:
             KeyError: If *name* is not in :data:`_REGISTRY`.
             :class:`~core_lens.base.EntityValidationError`: If validation fails.
+
         """
         if name not in self._entity_instances:
             entity_cls = _REGISTRY[name]
@@ -506,6 +516,7 @@ class AoI:
         Raises:
             :class:`~core_lens.base.EntityValidationError`: If any registered
                 entity fails validation.
+
         """
         for name in _REGISTRY:
             self._get_entity(name)
@@ -562,6 +573,7 @@ class AoI:
         Raises:
             :class:`~core_lens.base.EntityValidationError`: If no registered entity can satisfy the filters.
             ValueError: If the filters match zero rows.
+
         """
         logger.debug("Resolving named boundary using kwargs: {}", entity_kwargs)
 
@@ -625,6 +637,7 @@ class AoI:
         Raises:
             :class:`~core_lens.base.EntityValidationError`: If any validation check
                 fails (absolute-path entities only at register time).
+
         """
         import pathlib as _pathlib
 
@@ -647,6 +660,7 @@ class AoI:
 
         Args:
             entity_cls (type[BaseEntity]): The entity class to remove.
+
         """
         name = _entity_name(entity_cls)
         logger.info("Deregistering entity class: {}", name)
@@ -658,6 +672,7 @@ class AoI:
 
         Returns:
             list[str]: A sorted list of entity name strings.
+
         """
         return sorted(_REGISTRY)
 
@@ -695,6 +710,7 @@ def _validate_entity_paths(entity: BaseEntity, name: str) -> None:
 
     Raises:
         EntityValidationError: If any path does not exist.
+
     """
     # --- Static path existence check ----------------------------------------
     try:
@@ -760,6 +776,7 @@ def _validate_entity(entity: BaseEntity, name: str) -> None:
 
     Raises:
         EntityValidationError: If any validation check fails.
+
     """
     # Fast path-only check first.
     _validate_entity_paths(entity, name)

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/src/core_lens/base/entity.py

@@ -65,6 +65,7 @@ def _so_key(storage_options: dict[str, Any]) -> tuple[tuple[str, Any], ...]:
 
     Returns:
         tuple[tuple[str, Any], ...]: A sorted tuple of ``(key, value)`` pairs.
+
     """
     return tuple(sorted(storage_options.items()))
 
@@ -85,6 +86,7 @@ def _cached_detect(
 
     Returns:
         SchemaProfile: Detected schema profile for the given entity paths.
+
     """
     from core_lens.schema.detection import detect
 
@@ -114,6 +116,7 @@ def _cached_build_index(
 
     Returns:
         pl.DataFrame: The bounding-box index DataFrame.
+
     """
     logger.debug("Building bbox index for {} (cache miss)", static_path)
     return build_bbox_index(
@@ -127,7 +130,7 @@ def _cached_build_index(
 
 
 class BaseEntity(ABC):
-    """Abstract base class for every entity in the core_lens plugin system.
+    r"""Abstract base class for every entity in the core_lens plugin system.
 
     An entity represents a geospatial primitive (e.g. microwatershed, village,
     district) backed by one or more Parquet/GeoParquet files.  Entities are
@@ -195,6 +198,7 @@ class BaseEntity(ABC):
                 ``polars.scan_parquet``.  For S3 the common keys are
                 ``"region"``, ``"access_key"``, and ``"secret_key"``.
                 ``None`` uses ambient credentials (env-vars / ``~/.aws/``).
+
         """
         # Store as str so cloud URIs (s3://…) are never coerced through pathlib.
         self._data_root: str | None = str(data_root) if data_root is not None else None
@@ -219,6 +223,7 @@ class BaseEntity(ABC):
 
         Raises:
             FileNotFoundError: For *local* paths that do not exist after resolution.
+
         """
         # Fully-qualified cloud URI — return as-is.
         if is_cloud_uri(path):
@@ -255,13 +260,14 @@ class BaseEntity(ABC):
     @property
     @abstractmethod
     def key_cols(self) -> list[str]:
-        """Columns that uniquely identify one instance of this entity.
+        r"""Columns that uniquely identify one instance of this entity.
 
         For built-in entities this is always a single-element list (e.g.
         ``[\"mws_id\"]``), but the contract allows composite keys for plugins.
 
         Returns:
             list[str]: A list of column name strings present in the static file.
+
         """
 
     @property
@@ -274,6 +280,7 @@ class BaseEntity(ABC):
 
         Returns:
             str: The column name as a string.
+
         """
 
     @property
@@ -287,6 +294,7 @@ class BaseEntity(ABC):
 
         Returns:
             str: A path string.
+
         """
 
     @property
@@ -299,6 +307,7 @@ class BaseEntity(ABC):
 
         Returns:
             str | None: A path string, or ``None`` if the entity has no annual data.
+
         """
         return None
 
@@ -312,6 +321,7 @@ class BaseEntity(ABC):
 
         Returns:
             str | None: A path string, or ``None`` if the entity has no fortnightly data.
+
         """
         return None
 
@@ -336,6 +346,7 @@ class BaseEntity(ABC):
 
         Returns:
             SchemaProfile: A fully-validated :class:`~core_lens.schema.profile.SchemaProfile`.
+
         """
         if not hasattr(self, "_schema_profile"):
             _so = self._storage_options or {}
@@ -372,6 +383,7 @@ class BaseEntity(ABC):
 
         Returns:
             pl.DataFrame: DataFrame with columns ``(*key_cols, minx, miny, maxx, maxy)``.
+
         """
         if not hasattr(self, "_cached_index"):
             profile = self.schema_profile  # already cached — no extra I/O
@@ -409,6 +421,7 @@ class BaseEntity(ABC):
         Raises:
             ValueError: If a kwarg cannot be resolved as either an attribute
                 column or a registered entity name.
+
         """
         from core_lens.aoi import _REGISTRY
         from core_lens.base.view import View
@@ -544,6 +557,7 @@ class BaseEntity(ABC):
 
         Raises:
             ValueError: If neither ``geometry`` nor ``bbox`` is provided.
+
         """
         import shapely.geometry as sgeom
 
@@ -584,7 +598,7 @@ class BaseEntity(ABC):
         return View(keys=keys, entity=self, entity_name=entity_name)
 
     def spatial_join(self, other: "BaseEntity", agg: dict[str, str]) -> "View":
-        """Return a lazy :class:`~core_lens.base.view.View` with a cross-entity join pending.
+        r"""Return a lazy :class:`~core_lens.base.view.View` with a cross-entity join pending.
 
         The join is recorded in the View's ``join_spec`` and computed only at
         materialisation time (``.static``, ``.annual``, or ``.fortnightly``).
@@ -601,6 +615,7 @@ class BaseEntity(ABC):
         Returns:
             View: A lazy :class:`~core_lens.base.view.View` with the join spec
             recorded for deferred execution.
+
         """
         from core_lens.base.view import View
 

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/src/core_lens/base/namespaces/plot.py

@@ -17,6 +17,7 @@ class SubplotOn(Enum):
         MONTH: Split data by month.
         SEASON: Split data by meteorological season.
         SEASON_YEAR: Split data by season and year.
+
     """
 
     YEAR = "year"
@@ -71,6 +72,7 @@ def _wkb_to_arrow_table(
 
     Returns:
         An ``arro3.core.Table`` whose geometry column is GeoArrow-typed.
+
     """
     import geoarrow.rust.core as ga
     import polars as pl
@@ -182,6 +184,7 @@ def _color_for(index: int) -> str:
 
     Returns:
         The hex color string.
+
     """
     return _PALETTE[index % len(_PALETTE)]
 
@@ -193,6 +196,7 @@ def _apply_theme(fig: Any, result: "Result", title: str) -> None:
         fig: The Bokeh figure.
         result: The parent Result object.
         title: The title text.
+
     """
     entity_name = getattr(result.entity, "__name__", "Unknown")
     if hasattr(result, "entity_name"):
@@ -202,7 +206,6 @@ def _apply_theme(fig: Any, result: "Result", title: str) -> None:
     fig.title.text_font = "Inter, sans-serif"
     fig.title.text_font_size = "14pt"
 
-    # Subtitle-style annotation in the bottom-right corner.
     from bokeh.models.annotations import Label
 
     subtitle = Label(
@@ -227,6 +230,7 @@ class PlotNamespace:
 
     Attributes:
         result: The parent Result object.
+
     """
 
     def __init__(self, result: "Result") -> None:
@@ -253,6 +257,7 @@ class PlotNamespace:
             ValueError: If ``column`` or ``subplot_on`` column not found in data.
             NotImplementedError: Lonboard does not support native subplot grids;
                 only single-value ``subplot_on`` is rendered when specified.
+
         """
         import lonboard
         from lonboard.colormap import apply_continuous_cmap
@@ -347,6 +352,7 @@ class PlotNamespace:
 
         Returns:
             Any: A Bokeh Tabs object (or a single Figure when ``aggregate=True``).
+
         """
         import polars as pl
         import polars.selectors as cs
@@ -474,7 +480,6 @@ class PlotNamespace:
             _apply_theme(fig, self.result, title)
             return fig
 
-        # --- Aggregated view --------------------------------------------------
         group_cols = [x, subplot_col] if subplot_col else [x]
         agg_pdf = (
             df.group_by(group_cols)
@@ -486,7 +491,6 @@ class PlotNamespace:
         if aggregate:
             return _make_fig(agg_pdf, "Timeseries (Aggregated Mean)")
 
-        # --- Per-entity view --------------------------------------------------
         entity_df = df.sort(x)
         unique_entities = entity_df[key_col].unique()
         if len(unique_entities) > top_n:
@@ -519,6 +523,7 @@ class PlotNamespace:
 
         Returns:
             Any: A Bokeh Figure or Tabs object.
+
         """
         import polars as pl
         import polars.selectors as cs
@@ -595,6 +600,7 @@ class PlotNamespace:
 
         Returns:
             Any: A Bokeh Figure or Tabs object.
+
         """
         import numpy as np
         import pandas as pd
@@ -665,6 +671,7 @@ class PlotNamespace:
 
         Returns:
             Any: A Bokeh Figure object.
+
         """
         import polars.selectors as cs
         from bokeh.models import BasicTicker, ColumnDataSource, LinearColorMapper
@@ -684,7 +691,6 @@ class PlotNamespace:
         corr = df.to_pandas().corr()
         cols = list(corr.columns)
 
-        # Build long-form data for rect glyphs.
         xs: list[str] = []
         ys: list[str] = []
         vals: list[float] = []
@@ -744,6 +750,7 @@ class PlotNamespace:
 
         Returns:
             Any: A Bokeh Figure object.
+
         """
         from bokeh.models import (
             BasicTicker,
@@ -769,7 +776,6 @@ class PlotNamespace:
         x_vals = [str(v) for v in pdf.columns.tolist()]
         y_vals = [str(v) for v in pdf.index.tolist()]
 
-        # Long-form
         xs2: list[str] = []
         ys2: list[str] = []
         vals2: list[float] = []
@@ -819,6 +825,7 @@ class PlotNamespace:
 
         Returns:
             Any: A Bokeh ``gridplot`` object.
+
         """
         import polars.selectors as cs
         from bokeh.layouts import gridplot

{core_lens-0.1.dev136 → core_lens-0.1.dev140}/src/core_lens/base/namespaces/stats.py

@@ -29,6 +29,7 @@ def _sf(x: object) -> float:
 
     Returns:
         float: The numeric value as a float, or NaN if the input is None.
+
     """
     if x is None:
         return float("nan")
@@ -42,6 +43,7 @@ class CorrelateMethod(Enum):
         PEARSON: Pearson correlation coefficient.
         SPEARMAN: Spearman rank correlation.
         KENDALL: Kendall Tau correlation.
+
     """
 
     PEARSON = "pearson"
@@ -58,6 +60,7 @@ class TestMethod(Enum):
         WILCOXON: Wilcoxon signed-rank test.
         KS: Kolmogorov-Smirnov test.
         CHI_SQUARE: Chi-square test.
+
     """
 
     __test__ = False
@@ -75,6 +78,7 @@ class ChangeMethod(Enum):
         ABSOLUTE: Absolute difference between periods.
         PERCENTAGE: Percentage change between periods.
         TREND: Linear trend over time.
+
     """
 
     ABSOLUTE = "absolute"
@@ -90,6 +94,7 @@ class AnomalyCrossMethod(Enum):
         IQR: Interquartile range method.
         PERCENTILE: Percentile-based method.
         THRESHOLD: Fixed threshold method.
+
     """
 
     ZSCORE = "zscore"
@@ -105,6 +110,7 @@ class AnomalyTsMethod(Enum):
         STL: Seasonal-Trend decomposition using LOESS.
         CUSUM: Cumulative sum control chart.
         MAD: Median Absolute Deviation.
+
     """
 
     STL = "stl"
@@ -120,6 +126,7 @@ class SimilarityMethod(Enum):
         COSINE: Cosine similarity.
         MAHALANOBIS: Mahalanobis distance.
         MANHATTAN: Manhattan distance.
+
     """
 
     EUCLIDEAN = "euclidean"
@@ -167,7 +174,8 @@ class StatsNamespace:
         columns: list[str] | None = None,
         by: str = "column",
     ) -> "Result":
-        """Per-column or per-entity descriptive statistics.
+        r"""Per-column or per-entity descriptive statistics.
+
         Uses polars' in-built methods for mean, std, min, max, quantiles etc.
 
         Args:
@@ -180,6 +188,7 @@ class StatsNamespace:
 
         Raises:
             ValueError: If ``by`` is not ``\"column\"`` or ``\"entity\"``.
+
         """
         df = self._r.data
         cols = columns if columns is not None else self._numeric_cols(df)
@@ -239,6 +248,7 @@ class StatsNamespace:
         Raises:
             CorrelationError: If fewer than 2 columns supplied.
             ValueError: If ``method`` is not recognised.
+
         """
         if len(columns) < 2:
             raise CorrelationError(
@@ -313,6 +323,7 @@ class StatsNamespace:
         Raises:
             ValueError: If none of ``groups``, ``periods``, ``against`` supplied,
                 or if ``method`` is not recognised.
+
         """
         import scipy.stats as sp
 
@@ -460,6 +471,7 @@ class StatsNamespace:
 
         Raises:
             ValueError: If ``method`` is not recognised or year column absent.
+
         """
         if not isinstance(method, ChangeMethod):
             raise ValueError(
@@ -566,6 +578,7 @@ class StatsNamespace:
 
         Raises:
             ValueError: If ``mode``, ``method``, or observation count invalid.
+
         """
         df = self._r.data
         key = self._r.key_cols[0]
@@ -835,6 +848,7 @@ class StatsNamespace:
         Raises:
             ValueError: If ``method`` is invalid, no columns can be resolved,
                 or ``target`` is not found.
+
         """
         if not isinstance(method, SimilarityMethod):
             raise ValueError(