Merge pull request #26 from NCAR/docs

Updates to docs

Author: kevinyang-cky

.gitignore

@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Version
+bridgescaler/_version.py

.readthedocs.yaml

@@ -9,14 +9,14 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "mambaforge-22.9"
+    python: "3.12"
+
     # You can also specify other tool versions:
     # nodejs: "19"
     # rust: "1.64"
     # golang: "1.19"
 
-conda:
-  environment: environment.yml
+
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
   configuration: doc/source/conf.py
@@ -29,6 +29,7 @@ sphinx:
 # Optional but recommended, declare the Python requirements required
 # to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#    install:
-#    - requirements: docs/requirements.txt
+python:
+  install:
+    - method: "pip"
+      path: "."

bridgescaler/VERSION

@@ -72,11 +72,11 @@ def test_deep_quantile_transformer():
     x_telephone = dqs.inverse_transform(x_transformed)
     reg_qs = QuantileTransformer(n_quantiles=1000, subsample=dim * dim * n_ex)
     def flatten_to_2D(X):
-        return np.reshape(X, newshape=(X.shape[0] * X.shape[1] * X.shape[2], X.shape[-1]))
+        return np.reshape(X, (X.shape[0] * X.shape[1] * X.shape[2], X.shape[-1]))
 
     x_flat = flatten_to_2D(x)
     x_scaled = reg_qs.fit_transform(x_flat)
-    x_tel_2 = np.reshape(reg_qs.inverse_transform(x_scaled), newshape=(x.shape[0], x.shape[1], x.shape[2], x.shape[3]))
+    x_tel_2 = np.reshape(reg_qs.inverse_transform(x_scaled), (x.shape[0], x.shape[1], x.shape[2], x.shape[3]))
     full_diff = np.abs(x - x_telephone).ravel()
     reg_diff = np.abs(x_tel_2 - x).ravel()
     assert x_transformed.shape == x.shape, "Shape mismatch"

bridgescaler/tests/deep_test.py

@@ -1,3 +1,4 @@
+from importlib.metadata import version as get_version
 # Configuration file for the Sphinx documentation builder.
 #
 # For the full list of built-in configuration values, see the documentation:
@@ -9,12 +10,13 @@
 project = 'bridgescaler'
 copyright = '2024, University Corporation for Atmopsheric Research'
 author = 'David John Gagne'
-release = '0.8.0'
+release = get_version("bridgescaler")
+version = ".".join(release.split(".")[:3])
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.napoleon']
+extensions = ['sphinx.ext.napoleon', 'autoapi.extension', 'myst_parser']
 
 templates_path = ['_templates']
 exclude_patterns = []
@@ -26,4 +28,5 @@
 
 html_theme = 'sphinx_book_theme'
 html_static_path = ['_static']
+autoapi_dirs = ["../../bridgescaler",]
 html_logo = "_static/bridgescaler_logo.png"

doc/source/conf.py

@@ -46,8 +46,14 @@ a pandas DataFrame for easy loading and combining later.
 .. code-block:: python
 
     import pandas as pd
-    from bridgescaler import print_scaler, read_scaler
+    from bridgescaler import save_scaler, print_scaler, read_scaler, load_scaler
     scaler_list = [dss_1, dss_2]
+
+    # Save and load single scalers
+    save_scaler(dss_1, "scaler.json")
+    loaded_scaler = load_scaler("scaler.json")
+
+    # Save and load multiple scalers
     df = pd.DataFrame({"scalers": [print_scaler(s) for s in scaler_list]})
     df.to_parquet("scalers.parquet")
     df_new = pd.read_parquet("scalers.parquet")

doc/source/distributed.rst

@@ -17,7 +17,7 @@ distributed scaling of data for pre-processing of AI and ML models.
    distributed.rst
    distributed_tensor.rst
    group.rst
-   modules.rst
+
 
 
 

doc/source/index.rst

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bridgescaler"
+description = "Tool to automagically save scikit-learn scaler properties to a portable, readable format."
+readme = "README.md"
+authors = [{name = "David John Gagne", email = "dgagne@ucar.edu"}]
+dynamic = ["version"]
+license = {text = "MIT"}
+keywords = ["machine learning"]
+classifiers = [
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+
+
+]
+dependencies = [
+    "scikit-learn>=1.0",
+    "numpy<2.4",
+    "pandas<3",
+    "crick",
+    "scipy",
+    "xarray",
+    "numba",
+    "sphinx",
+    "sphinx-book-theme",
+    "sphinx-autoapi",
+    "setuptools_scm",
+    "setuptools",
+    "myst_parser"
+]
+requires-python = ">=3.7"
+
+[project.urls]
+Homepage = "https://github.com/NCAR/bridgescaler"
+
+[tool.setuptools]
+packages = ["bridgescaler"]
+include-package-data = true
+zip-safe = true
+
+[tool.setuptools_scm]
+version_file = "bridgescaler/_version.py"

doc/source/modules.rst

@@ -1,7 +1,13 @@
-pandas
-numpy<2.0
+pandas<3
+numpy<2.4
 scikit-learn>=1.0
 crick
 xarray
-scipy>=1.11.0
+scipy
 numba
+sphinx
+sphinx-book-theme
+setuptools_scm
+setuptools
+sphinx-autoapi
+myst_parser