Merge pull request #1 from predict-idlab/release

📦 fix setup.py + 🐛 some bug fixes + 🤖 package CI-CD

Author: jvdd

.github/workflows/ci-tsdownsample.yml

@@ -1,21 +1,27 @@
 name: CI tsdownsample
 
 on:
-  pull_request:
+  pull_request: {}
   push:
     branches:
       - main
+    tags:
+      - '**'
 
 defaults:
   run:
     shell: bash
 
 jobs:
-  Check:
+
+  Lint_and_Check:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - run: pip install -r tests/requirements-linting.txt
 
       - name: Install Rust toolchain
         uses: actions-rs/toolchain@v1
@@ -27,15 +33,11 @@ jobs:
         run: |
           rustup update nightly --no-self-update
           rustup default nightly
+      - name: Cache rust
+        uses: Swatinem/rust-cache@v2
 
-      - name: Rust toolchain info
-        run: |
-          cargo --version --verbose
-          rustc --version
-          cargo clippy --version
-          cargo fmt --version
-        
-      - name: check
-        run: cargo check --verbose
-      - name: formatting check
-        run: cargo fmt --all -- --check
+      - run: pip freeze
+      - run: make lint  # Lint Python & Rust
+      - run: make mypy  # Type check Python
+
+# https://github.com/samuelcolvin/rtoml/blob/main/.github/workflows/ci.yml

.gitignore

@@ -1,3 +1,4 @@
+venv/
 TODO.md
 main.rs
 

Makefile

@@ -0,0 +1,53 @@
+.DEFAULT_GOAL := all
+isort = isort tsdownsample tests
+black = black tsdownsample tests
+
+
+.PHONY: format
+format:
+	$(isort)
+	$(black)
+	cargo fmt
+
+.PHONY: lint-python
+lint-python:
+	ruff tsdownsample tests
+	$(isort) --check-only --df
+	$(black) --check --diff
+
+.PHONY: lint-rust
+lint-rust:
+	cargo fmt --version
+	cargo fmt --all -- --check
+	cargo clippy --version
+	cargo clippy -- -D warnings -A incomplete_features -W clippy::dbg_macro -W clippy::print_stdout
+
+.PHONY: lint
+lint: lint-python lint-rust
+
+.PHONY: mypy
+mypy:
+	mypy tsdownsample
+
+.PHONY: all
+all: lint mypy testcov
+
+.PHONY: clean
+clean:
+	rm -rf `find . -name __pycache__`
+	rm -f `find . -type f -name '*.py[co]' `
+	rm -f `find . -type f -name '*~' `
+	rm -f `find . -type f -name '.*~' `
+	rm -rf dist
+	rm -rf build
+	rm -rf target
+	rm -rf .cache
+	rm -rf .pytest_cache
+	rm -rf .mypy_cache
+	rm -rf htmlcov
+	rm -rf *.egg-info
+	rm -f .coverage
+	rm -f .coverage.*
+	rm -rf build
+	rm -f tsdownsample/*.so
+	python setup.py clean

downsample_rs/src/lttb/scalar.rs

@@ -104,18 +104,22 @@ pub fn lttb_without_x<Ty: Num>(y: ArrayView1<Ty>, n_out: usize) -> Array1<usize>
         // Slicing seems to be a lot slower
         // let avg_x: Tx = x.slice(s![avg_range_start..avg_range_end]).sum();
         let avg_y: f64 = avg_y.to_f64() / (avg_range_end - avg_range_start) as f64;
+        let avg_x: f64 = (avg_range_start + avg_range_end - 1) as f64 / 2.0;
 
         // Get the range for this bucket
         let range_offs = (every * i as f64) as usize + 1;
         let range_to = (every * (i + 1) as f64) as usize + 1;
 
         // Point a
         let point_ay = y[a].to_f64();
+        let point_ax = a as f64;
 
         let mut max_area = -1.0;
         for i in range_offs..range_to {
             // Calculate triangle area over three buckets
-            let area = ((y[i].to_f64() - point_ay) - (avg_y - point_ay)).abs();
+            let area = ((point_ax - avg_x) * (y[i].to_f64() - point_ay)
+                - (point_ax - i as f64) * (avg_y - point_ay))
+                .abs();
             if area > max_area {
                 max_area = area;
                 a = i;
@@ -167,13 +171,9 @@ mod tests {
             let n = 5_000;
             let x: Array1<i32> = Array1::from((0..n).map(|i| i as i32).collect::<Vec<i32>>());
             let y = utils::get_random_array(n, f32::MIN, f32::MAX);
-            let sampled_indices = lttb(x.view(), y.view(), 200);
+            let sampled_indices1 = lttb(x.view(), y.view(), 200);
             let sampled_indices2 = lttb_without_x(y.view(), 200);
-            // TODO: for some reason the second last point is off..
-            assert_eq!(
-                sampled_indices.slice(s![0..198]),
-                sampled_indices2.slice(s![0..198])
-            );
+            assert_eq!(sampled_indices1, sampled_indices2);
         }
     }
 }

poetry.lock

@@ -1,20 +1,71 @@
-[tool.poetry]
+[build-system]
+requires = ["setuptools", "wheel", "setuptools-rust"]
+
+[project]
 name = "tsdownsample"
-version = "0.1.0a0"
+version = "0.1.0a1"
+requires-python = ">=3.7"
 description = "Time series downsampling in rust"
-authors = ["Jeroen Van Der Donckt"]
+authors = [{name = "Jeroen Van Der Donckt"}]
 readme = "README.md"
-license = "MIT"
-repository = "https://github.com/predict-idlab/tsdownsample"
+license = {text = "MIT"}
 keywords = ["time series", "downsampling", "rust", "data science", "visualization"]
+classifiers = [
+    'Intended Audience :: Developers',
+    'License :: OSI Approved :: MIT License',
+    'Intended Audience :: Developers',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.6',  # TODO?
+    'Programming Language :: Python :: 3.7',
+    'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Operating System :: POSIX',
+    'Operating System :: MacOS :: MacOS X',
+    'Operating System :: Microsoft :: Windows'
+]
+
+[project.urls]
+homepage = "https://github.com/predict-idlab/tsdownsample"
+repository = "https://github.com/predict-idlab/tsdownsample"
 
-[tool.poetry.dependencies]
-python = "^3.7.1"
-numpy = ">=1.21"
-pandas = ">=1.3"
+# Build Python bindings for rust
+[tool.maturin]
+bindings = "pyo3"
 
-[tool.poetry.dev-dependencies]
+# Linting
+[tool.ruff]
+line-length = 88
+extend-select = ["Q"]
+ignore = ["E402", "F403"]
 
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
+# Formatting
+[tool.black]
+color = true
+line-length = 88
+skip-string-normalization = true
+skip-magic-trailing-comma = true
+
+# Sort imports
+[tool.isort]
+line_length = 88
+known_first_party = ["tsdownsample"]
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+combine_as_imports = true
+color_output = true
+skip = "tests/toml_test.py"
+
+# Static typing
+[tool.mypy]
+follow_imports = "normal"
+strict_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+check_untyped_defs = true
+no_implicit_reexport = true
+disallow_untyped_defs = true
+disallow_any_generics = false
+ignore_missing_imports = true

pyproject.toml

@@ -0,0 +1,4 @@
+numpy
+pandas
+# Build dependencies
+setuptools_rust