twiga 0.1.0__tar.gz

twiga-0.1.0/.coveragerc

@@ -0,0 +1,6 @@
+[run]
+omit =
+    twiga/core/plot/*
+    */__init__.py
+    twiga/pipeline/flows.py
+    twiga/pipeline/tasks.py

twiga-0.1.0/.gitignore

@@ -0,0 +1,140 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+.ruff_cache/
+pytestdebug.log
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# VS Code
+#  The following files are specific to Visual Studio Code
+.vscode/
+
+# Jetbrains IDEs
+#  The following files are specific to Jetbrains IDEs
+.idea/
+
+# PyPI configuration file
+.pypirc
+
+
+# extra files
+*.DS_Store
+*.log
+
+# Sphinx build output
+docs_sphinx/_build/
+
+# ── Twiga runtime outputs ────────────────────────────────────────────────────
+
+# Model checkpoints (joblib pickles + manifest)
+checkpoints/
+**/checkpoints/
+_checkpoint_manifest.json
+*.pkl
+
+# MLflow tracking store (local file-based backend)
+mlruns/
+mlartifacts/
+mlflow.db
+mlflow-artifacts/
+
+# Optuna SQLite study databases
+*.db
+optuna_studies/
+
+# CatBoost training artefacts
+catboost_info/
+learn_error.tsv
+test_error.tsv
+catboost_training.json
+time_left.tsv
+*.cbm
+*.cb
+
+# Evidently HTML drift / performance reports
+reports/
+**/reports/
+data_drift_*.html
+model_performance_*.html
+
+# Prefect local storage
+.prefect/
+prefect-storage/
+
+# Twiga project output directories (created by ForecasterConfig)
+logs/
+results/
+figures/
+
+# Tutorial / notebook generated artefacts
+examples/lets-plot-images/
+examples/checkpoints/
+examples/logs/
+examples/results/
+examples/figures/
+examples/tutorials/mlruns/
+examples/tutorials/mlops_demo/
+**/mlops_demo/
+
+# Generated serving scripts written by notebooks
+serve.py

twiga-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

twiga-0.1.0/.secrets.baseline

@@ -0,0 +1,144 @@
+{
+  "version": "1.5.0",
+  "plugins_used": [
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "name": "Base64HighEntropyString",
+      "limit": 4.5
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "name": "DiscordBotTokenDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "name": "GitLabTokenDetector"
+    },
+    {
+      "name": "HexHighEntropyString",
+      "limit": 3.0
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "IPPublicDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "name": "KeywordDetector",
+      "keyword_exclude": ""
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "OpenAIDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "PypiTokenDetector"
+    },
+    {
+      "name": "SendGridDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TelegramBotTokenDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "filters_used": [
+    {
+      "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
+    },
+    {
+      "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
+      "min_level": 2
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_indirect_reference"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_likely_id_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_lock_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_potential_uuid"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_sequential_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_swagger_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_templated_secret"
+    },
+    {
+      "path": "detect_secrets.filters.regex.should_exclude_file",
+      "pattern": [
+        "uv\\.lock",
+        "\\.ipynb$"
+      ]
+    }
+  ],
+  "results": {
+    "docs/mlops/serving.md": [
+      {
+        "type": "Secret Keyword",
+        "filename": "docs/mlops/serving.md",
+        "hashed_secret": "a761ce3a45d97e41840a788495e85a70d1bb3815",
+        "is_verified": false,
+        "line_number": 39
+      }
+    ]
+  },
+  "generated_at": "2026-04-19T06:51:19Z"
+}

twiga-0.1.0/CHANGELOG.md

@@ -0,0 +1,150 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## v0.1.0 (2026-04-19)
+
+### Feat
+
+- **nn**: add probabilistic RNN distribution variants with tests
+- MLOps pipeline, serving layer, and core analytics improvements (#16)
+- add AMI, signal characterisation, context parrot model, and fix Prefect test infrastructure
+- add MLOps Streamlit dashboard, docs overhaul, and core improvements
+- add MLOps docs, tutorial 17, and update gitignore
+- align MLOps modules to production best practices
+- add PyPI publish and Sphinx docs workflows (#15)
+- add PyPI publish and Sphinx docs workflows
+- add NGBoost probabilistic ML models (Normal, LogNormal, Exponential)
+- update experiment code with feature selection
+- update ganf step with sigma loss
+- format README file
+- update forecaster base to handle prediction scaling with different format
+- update base quantiles
+- fix quantile lightgm
+- fix quantile lightgm
+- add quantile ml
+- add basequantile for ml models
+- update pv notebook
+- **stats**: add MSTL-based get_trend_seasonality for multi-period decomposition
+- **metrics**: add Giacomini-White test; upgrade DM to 2D multivariate/univariate
+- **metrics**: implement missing point, interval, quantile, and probabilistic metrics
+- add security scanning (bandit, detect-secrets, CodeQL, pip-audit, Dependabot)
+- MLOps pipeline, serving layer, and core analytics improvements (#16)
+- add PyPI publish and Sphinx docs workflows (#15)
+- add AMI, signal characterisation, context parrot model, and fix Prefect test infrastructure
+- add MLOps Streamlit dashboard, docs overhaul, and core improvements
+- add MLOps docs, tutorial 17, and update gitignore
+- align MLOps modules to production best practices
+- add PyPI publish and Sphinx docs workflows
+- add NGBoost probabilistic ML models (Normal, LogNormal, Exponential)
+- update experiment code with feature selection
+- update ganf step with sigma loss
+- format README file
+- update forecaster base to handle prediction scaling with different format
+- update base quantiles
+- fix quantile lightgm
+- fix quantile lightgm
+- add quantile ml
+- add basequantile for ml models
+- update pv notebook
+- add neural-net models and refine twiga forecaster
+- add neural-net models and refine twiga forecaster
+
+### Fix
+
+- strip editable entry from uv export before pip-audit
+- clean up CI workflow and pytest config
+- align pre-commit default_language_version to python3.12
+- update ForecastMonitor to use Evidently Snapshot API
+- on_save_checkpoint now returns the checkpoint directory path
+- handle RawPrediction in build_forecast_result, get_prediction_array, and calibrate
+- auto-register lag/window columns in DataPipeline and handle RawPrediction in _run_predictions
+- resolve test failures from full suite run
+- replace deprecated np.trapz with np.trapezoid for NumPy 2.0 compatibility
+- failed unit test and ty check
+- clean examples folders
+- baselines and tutorials (#13)
+- baselines and tutorials
+- upadte github action and prehook
+- upadte github action
+- guard logs_path None check in create_optuna_study
+- align FPQRDistribution.forecast() with pipeline and add notebook example
+- delegate ProbabilisticNetwork.forecast() to head.forecast() for QR models
+- fix pytorch bug when loading qr model, and refactor evaluate module in forecaster while updating notebook tutorilas and other bugs
+- update readme for cuda installation
+- remove test.notebook
+- failed test
+- failed test
+- git actions by creating separate prehook config for remote repo
+- remove run myv --check from test-and-lint job
+- remove invalid uv lock --check from test-and-lint job
+- update pre-commit stage names to modern syntax
+- merge the update with main and update the code
+- **docs**: use lvert/rvert in medae docstring to avoid docutils substitution parse error
+- **metrics**: correct GW inner function return type; add GW autofunction to Sphinx page
+- convert NumPy-style docstrings to Google style in feature.py
+- resolve all Sphinx build warnings and commitizen release failure
+- update models page
+- remove TwigaSettings from core/config eager import path
+- lazy-import ShapExplainer to allow import twiga without shap extra
+- context parrot num_targets, lazy lets_plot import, base update override, docs cleanup
+- store feature names in ML regressors to eliminate sklearn mismatch warnings
+- guard optional deps so bare install no longer crashes on import
+- issue on creating timestap sequences
+- issue on creating timestap sequences
+- update uv smoke test  on publish action rc6
+- update uv smoke test  on publish action
+- update uv smoke test  on publish action
+- update uv smoke test  on publish action
+- update uv tags on publish action
+- failure github actions for publishing  on pypi
+- failure github actions for publishing  on pypi
+- failure github actions for publishing library on pypi
+- github actions for publishing library on pypi and tomly
+- github actions for publishing library on pypi
+- github actions for publishing library on pypi
+- update doc_compilation github action  and fix issues on doc compilation
+- update pydantic config and fix issues on doc compilation
+- fix all issue on sphinix docs
+- resolve doc-publish CI failures — circular import and RST math syntax
+- clean up CI workflow and pytest config
+- align pre-commit default_language_version to python3.12
+- update ForecastMonitor to use Evidently Snapshot API
+- on_save_checkpoint now returns the checkpoint directory path
+- handle RawPrediction in build_forecast_result, get_prediction_array, and calibrate
+- auto-register lag/window columns in DataPipeline and handle RawPrediction in _run_predictions
+- resolve test failures from full suite run
+- replace deprecated np.trapz with np.trapezoid for NumPy 2.0 compatibility
+- failed unit test and ty check
+- clean examples folders
+- baselines and tutorials (#13)
+- baselines and tutorials
+- upadte github action and prehook
+- upadte github action
+- guard logs_path None check in create_optuna_study
+- align FPQRDistribution.forecast() with pipeline and add notebook example
+- delegate ProbabilisticNetwork.forecast() to head.forecast() for QR models
+- fix pytorch bug when loading qr model, and refactor evaluate module in forecaster while updating notebook tutorilas and other bugs
+- update readme for cuda installation
+- remove test.notebook
+- failed test
+- failed test
+- git actions by creating separate prehook config for remote repo
+- remove run myv --check from test-and-lint job
+- remove invalid uv lock --check from test-and-lint job
+- update pre-commit stage names to modern syntax
+- merge the update with main and update the code
+
+### Refactor
+
+- remove legacy utils, add GANF experiments and paper notebooks
+- modularise plot/stats, add feature intelligence, replace mypy with ty
+- modernise XGBoost/LightGBM models with eval_set and best-practice configs
+- replace two-stage Gaussian CatBoost with RMSEWithUncertainty
+- move CharacterisationConfig to core/config, re-export TwigaSettings from core/config
+- merge torch/lightning extras into nn group, clarify public API
+- code quality — null checks, override decorators, naming, cleanup
+- remove legacy utils, add GANF experiments and paper notebooks
+- modularise plot/stats, add feature intelligence, replace mypy with ty
+- modernise XGBoost/LightGBM models with eval_set and best-practice configs
+- replace two-stage Gaussian CatBoost with RMSEWithUncertainty

twiga-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.