{"id":51788489,"url":"https://github.com/sktime/sktime-cython","last_synced_at":"2026-07-20T20:31:59.986Z","repository":{"id":368070226,"uuid":"1273378716","full_name":"sktime/sktime-cython","owner":"sktime","description":"Cython-compiled estimators for sktime","archived":false,"fork":false,"pushed_at":"2026-06-27T17:32:40.000Z","size":44,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-29T00:14:49.137Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.sktime.net","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sktime.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-06-18T13:16:17.000Z","updated_at":"2026-06-27T17:46:48.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/sktime/sktime-cython","commit_stats":null,"previous_names":["sktime/sktime-cython"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/sktime/sktime-cython","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sktime%2Fsktime-cython","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sktime%2Fsktime-cython/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sktime%2Fsktime-cython/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sktime%2Fsktime-cython/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sktime","download_url":"https://codeload.github.com/sktime/sktime-cython/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sktime%2Fsktime-cython/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35699589,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"ssl_error","status_checked_at":"2026-07-20T02:08:09.736Z","response_time":111,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-07-20T20:31:58.781Z","updated_at":"2026-07-20T20:31:59.979Z","avatar_url":"https://github.com/sktime.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sktime-cython\n\nCython-compiled estimators for [sktime](https://github.com/sktime/sktime).\n\nThis package hosts ahead-of-time compiled implementations of sktime algorithms,\nisolating the C-compilation and binary-wheel complexity from the main `sktime`\npackage. Estimators here expose a plain numpy-in/numpy-out compute layer with\n**no sktime runtime dependency**; `sktime` keeps thin `BaseTransformer` /\n`BaseEstimator` wrappers that delegate to this package.\n\nWhy a separate package: compiled extensions need a C toolchain, per-platform\nwheels, and `cibuildwheel` release machinery. Keeping that here lets `sktime`\nstay pure-Python while still offering compiled, numba-free fast paths.\n\n## Estimators\n\n| Estimator | Compute API | Notes |\n|-----------|-------------|-------|\n| Multivariate MiniRocket | `sktime_cython.fit` / `transform` | numba-free; equivalent to `MiniRocketMultivariate`, no JIT warmup |\n\nLogic for further `sktime` cython based estimators should be added in this package,\nfor a recipe, see the [extension guide](https://github.com/sktime/sktime-cython#adding-an-estimator) below.\n\nRuntime dependency: numpy only.\n\n## Development\n\nRequires a C compiler and Python 3.10+. Run from the project root.\n\n```bash\n# editable install with the dev extra (pulls sktime + numba for equivalence\n# tests, plus pre-commit); compiles the Cython extensions via build isolation\nuv pip install -e \".[dev]\"        # or: pip install -e \".[dev]\"\n\n# install the git pre-commit hooks ONCE — this is what stops CI lint failures\npre-commit install\n\n# run the tests\npython -m pytest sktime_cython -v\n```\n\nAfter editing a `.pyx`, recompile with `pip install -e .` again (or `make build`).\n\n`make` shortcuts (auto-detect `uv`, falling back to `pip`/`python`):\n`make install`, `make build`, `make test`, `make clean`.\n\n## Before you push (avoid CI failures)\n\nCI runs the pre-commit hooks and **fails if they reformat anything**. Running\n`pre-commit install` (above) auto-runs them on every `git commit`. To check the\nwhole tree on demand:\n\n```bash\npre-commit run --all-files\n```\n\nThis runs `ruff check` (lint) and `ruff format`. If `ruff format` reports \"files\nwere modified\", it already fixed them — `git add` the changes and commit again.\n\n## CI workflows\n\n- **`test.yml`** (push / PR to `main`): a `code-quality` job running the\n  pre-commit hooks, plus a matrix that builds the Cython extensions and runs\n  pytest across Python 3.10–3.14 on Linux, macOS, and Windows.\n- **`release.yml`** (on GitHub release): builds binary wheels with\n  [`cibuildwheel`](https://cibuildwheel.pypa.io/) for all platforms, builds an\n  sdist (with `.pyx` sources), and publishes to PyPI via trusted publishing.\n\n## Adding an estimator\n\n1. Drop the kernel `.pyx` (and optional `.pyi` stub) in a subfolder of the package.\n  The package structure mirrors that of `sktime`, files should be added paralleling\n  its primary import location in `sktime`\n2. Register the kernel as an `Extension` in `setup.py`.\n3. Add a numpy compute-layer module `sktime_cython/\u003cname\u003e.py` exposing the\n   estimator's public functions. Keep them in the submodule — do not re-export\n   at the top level (avoids name collisions across estimators).\n4. Add tests in a subfolder `tests`, in the same folder as the kernel.\n\n## Package structure\n\nCython kernels and python layers should be added in a parallel location as in the\n`sktime` package.\n\nExample for minirocket:\n\n```\nsktime_cython/\n  transformations/\n    rocket/\n      __init__.py                           # public compute-layer exports\n      _minirocket.py                        # numpy fit/transform layer\n      _minirocket_multivariate_cython.pyx   # compiled kernels\n      _minirocket_multivariate_cython.pyi   # type stubs\n      tests/\n        __init__.py\n        test_minirocket.py                  # tests\n```\n\n## License\n\nBSD 3-Clause License — see [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsktime%2Fsktime-cython","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsktime%2Fsktime-cython","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsktime%2Fsktime-cython/lists"}