File size: 41,966 Bytes
ae97a0a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 | <!DOCTYPE html>
<html lang="en" data-bs-theme="light">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="Zipeng Wu">
<link rel="canonical" href="https://systems-mechanobiology.github.io/DeTime/method-references/">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Method References - DeTime</title>
<link href="../css/bootstrap.min.css" rel="stylesheet">
<link href="../css/fontawesome.min.css" rel="stylesheet">
<link href="../css/brands.min.css" rel="stylesheet">
<link href="../css/solid.min.css" rel="stylesheet">
<link href="../css/v4-font-face.min.css" rel="stylesheet">
<link href="../css/base.css" rel="stylesheet">
<link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" >
<link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled>
<link href="../stylesheets/brand.css" rel="stylesheet">
<link href="../stylesheets/extra.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
<meta name="robots" content="index, follow, max-image-preview:large">
<meta name="keywords" content="DeTime, detime, de-time, time series decomposition, Python time series, SSA, MSSA, VMD, STL, decomposition software">
<meta property="og:site_name" content="DeTime">
<meta property="og:type" content="website">
<meta property="og:title" content="DeTime - workflow-oriented time-series decomposition for Python">
<meta property="og:description" content="DeTime is a Python and CLI toolkit for reproducible time-series decomposition across SSA, MSSA, VMD, STL, EMD, wavelet, and native C++ backed methods.">
<meta property="og:url" content="https://systems-mechanobiology.github.io/DeTime/">
<meta property="og:image" content="https://systems-mechanobiology.github.io/DeTime/assets/brand/detime-title-card.svg">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="DeTime - time-series decomposition for Python">
<meta name="twitter:description" content="Workflow-oriented Python and CLI software for reproducible trend, oscillation, residual, and component decomposition.">
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@graph": [
{
"@type": "WebSite",
"@id": "https://systems-mechanobiology.github.io/DeTime/#website",
"name": "DeTime",
"alternateName": ["detime", "de-time", "De-Time"],
"url": "https://systems-mechanobiology.github.io/DeTime/",
"description": "DeTime documentation for workflow-oriented time-series decomposition software.",
"inLanguage": "en"
},
{
"@type": "SoftwareSourceCode",
"@id": "https://systems-mechanobiology.github.io/DeTime/#software",
"name": "DeTime",
"alternateName": ["detime", "de-time", "De-Time"],
"description": "Python and CLI toolkit for reproducible time-series decomposition with native C++ backed SSA, MSSA, VMD, STD, STDR, MA baseline, and Gabor clustering paths.",
"codeRepository": "https://github.com/systems-mechanobiology/DeTime",
"url": "https://systems-mechanobiology.github.io/DeTime/",
"programmingLanguage": ["Python", "C++"],
"applicationCategory": "Scientific software",
"keywords": "DeTime, time-series decomposition, Python, SSA, MSSA, VMD, STL, EMD, wavelet, native C++",
"author": {
"@type": "Person",
"name": "Zipeng Wu"
}
}
]
}
</script>
<link rel="stylesheet" href="../stylesheets/extra.css?v=7">
</head>
<body>
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
<div class="container">
<a class="navbar-brand" href="..">DeTime</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="nav-item">
<a href=".." class="nav-link">Home</a>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Start</a>
<ul class="dropdown-menu">
<li>
<a href="../install/" class="dropdown-item">Install</a>
</li>
<li>
<a href="../quickstart/" class="dropdown-item">Quickstart</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle active" aria-current="page" role="button" data-bs-toggle="dropdown" aria-expanded="false">Methods</a>
<ul class="dropdown-menu">
<li>
<a href="../methods/" class="dropdown-item">Methods & Chooser</a>
</li>
<li>
<a href="../method-matrix/" class="dropdown-item">Method Matrix</a>
</li>
<li>
<a href="./" class="dropdown-item active" aria-current="page">Method References</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Workflows</a>
<ul class="dropdown-menu">
<li>
<a href="../notebook-gallery/" class="dropdown-item">Notebook Gallery</a>
</li>
<li>
<a href="../tutorials/univariate/" class="dropdown-item">Univariate Tutorial</a>
</li>
<li>
<a href="../tutorials/multivariate/" class="dropdown-item">Multivariate Tutorial</a>
</li>
<li>
<a href="../tutorials/cli-and-profiling/" class="dropdown-item">CLI Guide</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Quant Trading Tutorial</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/quant-trading/" class="dropdown-item">Overview</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/" class="dropdown-item">Tutorial Notebooks</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/00_decomposition_first_quant_trading_roadmap/" class="dropdown-item">Tutorial 00 Roadmap</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Strategy Lab</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/quant-trading/two-strategy-families/" class="dropdown-item">Two Strategy Families</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/01_detime_trend_following_strategy_lab/" class="dropdown-item">01 Trend-Following Lab</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/02_detime_oscillation_reversion_strategy_lab/" class="dropdown-item">02 Oscillation-Reversion Lab</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Strategy Expansion</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/quant-trading/method-specific-strategy-expansion/" class="dropdown-item">Method-Specific Strategy Expansion</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/03_detime_method_specific_strategy_variants/" class="dropdown-item">03 Method-Specific Variants</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/04_detime_component_pair_trading_cointegration/" class="dropdown-item">04 Component Pair Trading</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Tutorial Sequence</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/quant-trading/notebooks/01_market_data_and_decomposition_feature_factory/" class="dropdown-item">01 Real Market Data and Feature Factory</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/02_decomposition_aware_moving_average_macd/" class="dropdown-item">02 Decomposition-aware MA and MACD</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/03_residual_mean_reversion_rsi_bollinger/" class="dropdown-item">03 Residual Mean Reversion</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/04_turtle_donchian_breakout_volume_confirmation/" class="dropdown-item">04 Donchian Breakout</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/05_pairs_spread_decomposition_stat_arb/" class="dropdown-item">05 Pair-Spread Stat-Arb</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/06_cross_sectional_rotation_portfolio/" class="dropdown-item">06 Cross-Sectional Rotation</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Native SSA Replay</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/quant-trading/notebooks/07_native_ssa_high_return_low_drawdown_tutorial/" class="dropdown-item">07 Native SSA High-Return / Low-Drawdown</a>
</li>
</ul>
</li>
<li>
<a href="../tutorials/quant-trading/data/" class="dropdown-item">Real Data and Universes</a>
</li>
<li>
<a href="../tutorials/quant-trading/strategy-map/" class="dropdown-item">Strategy Map</a>
</li>
<li>
<a href="../tutorials/quant-trading/backtesting-frameworks/" class="dropdown-item">Backtesting Frameworks</a>
</li>
<li>
<a href="../tutorials/quant-trading/walkforward/" class="dropdown-item">Walk-Forward Validation</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Hot Trend Lab</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/hot-trend-lab/" class="dropdown-item">Overview</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/" class="dropdown-item">Rendered Notebooks</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/00_hot_trend_lab_overview/" class="dropdown-item">00 Column Overview</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/01_arxiv_category_pulse/" class="dropdown-item">01 arXiv Category Pulse</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/02_arxiv_agent_research_pulse/" class="dropdown-item">02 arXiv Agent Research Pulse</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/03_huggingface_open_model_pulse/" class="dropdown-item">03 Hugging Face Open-Model Pulse</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/04_github_ai_agent_star_velocity/" class="dropdown-item">04 GitHub Star Velocity</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/05_wikipedia_attention_hype_decay/" class="dropdown-item">05 Wikipedia Attention Decay</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/06_crypto_stablecoin_liquidity_pulse/" class="dropdown-item">06 Crypto Stablecoin Liquidity</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/07_ai_infrastructure_market_pulse/" class="dropdown-item">07 AI Infrastructure Market Pulse</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/data-sources/" class="dropdown-item">Real Data Sources</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/arxiv-research-pulse/" class="dropdown-item">arXiv Research Pulse</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/open-model-and-developer-attention/" class="dropdown-item">Open Models and Developer Attention</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/wiki-market-crypto-attention/" class="dropdown-item">Public Attention, Markets, and Crypto</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/release-calendar/" class="dropdown-item">Release Calendar</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Gallery</a>
<ul class="dropdown-menu">
<li>
<a href="../gallery/ssa/" class="dropdown-item">SSA</a>
</li>
<li>
<a href="../gallery/std/" class="dropdown-item">STD</a>
</li>
<li>
<a href="../gallery/stdr/" class="dropdown-item">STDR</a>
</li>
<li>
<a href="../gallery/mssa/" class="dropdown-item">MSSA</a>
</li>
<li>
<a href="../gallery/stl/" class="dropdown-item">STL</a>
</li>
<li>
<a href="../gallery/mstl/" class="dropdown-item">MSTL</a>
</li>
<li>
<a href="../gallery/robust-stl/" class="dropdown-item">ROBUST_STL</a>
</li>
<li>
<a href="../gallery/emd/" class="dropdown-item">EMD</a>
</li>
<li>
<a href="../gallery/ceemdan/" class="dropdown-item">CEEMDAN</a>
</li>
<li>
<a href="../gallery/vmd/" class="dropdown-item">VMD</a>
</li>
<li>
<a href="../gallery/wavelet/" class="dropdown-item">WAVELET</a>
</li>
<li>
<a href="../gallery/ma-baseline/" class="dropdown-item">MA_BASELINE</a>
</li>
<li>
<a href="../gallery/mvmd/" class="dropdown-item">MVMD</a>
</li>
<li>
<a href="../gallery/memd/" class="dropdown-item">MEMD</a>
</li>
<li>
<a href="../gallery/gabor-cluster/" class="dropdown-item">GABOR_CLUSTER</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Reference</a>
<ul class="dropdown-menu">
<li>
<a href="../api/" class="dropdown-item">API Overview</a>
</li>
<li>
<a href="../config-reference/" class="dropdown-item">Config Reference</a>
</li>
<li>
<a href="../machine-api/" class="dropdown-item">Machine API</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Project</a>
<ul class="dropdown-menu">
<li>
<a href="../comparisons/" class="dropdown-item">Compare Alternatives</a>
</li>
<li>
<a href="../reproducibility/" class="dropdown-item">Reproducibility</a>
</li>
<li>
<a href="../architecture/" class="dropdown-item">Architecture</a>
</li>
<li>
<a href="../migration/" class="dropdown-item">Migration from `tsdecomp`</a>
</li>
<li>
<a href="../contributing/" class="dropdown-item">Contributing</a>
</li>
<li>
<a href="../citation/" class="dropdown-item">Citation / Release Notes</a>
</li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav ms-md-auto">
<li class="nav-item">
<a href="#" class="nav-link" data-bs-toggle="modal" data-bs-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="nav-item">
<a rel="prev" href="../method-matrix/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../notebook-gallery/" class="nav-link">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li class="nav-item">
<a href="https://github.com/systems-mechanobiology/DeTime" class="nav-link">systems-mechanobiology/DeTime</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>
<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="1"><a href="#method-references" class="nav-link">Method References</a>
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="2"><a href="#flagship-methods" class="nav-link">Flagship methods</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#stable-wrappers-and-retained-methods" class="nav-link">Stable wrappers and retained methods</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#optional-backend-methods" class="nav-link">Optional backend methods</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#experimental-methods" class="nav-link">Experimental methods</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="method-references">Method References</h1>
<p>This page is generated from <code>MethodRegistry.list_catalog()</code> so citations,
upstream package links, and method metadata stay aligned.</p>
<p>Current package version target: <code>0.1.1</code>.</p>
<p>These links cover the method families and upstream packages used or compared
in the public DeTime workflow surface. <code>MA_BASELINE</code> is an in-package smoke
baseline and therefore has no separate upstream citation.</p>
<h2 id="flagship-methods">Flagship methods</h2>
<h3 id="mssa"><code>MSSA</code></h3>
<ul>
<li>Summary: Multivariate SSA for shared-structure decomposition across channels.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://link.springer.com/book/10.1007/978-3-662-62436-4">Golyandina and Zhigljavsky (2020), Singular Spectrum Analysis for Time Series</a> - Primary SSA/MSSA reference used for the multivariate extension.</p>
<p>Related packages:
- <a href="https://github.com/ADSCIAN/ssalib">SSALib</a> - SSA-focused package; useful comparison point for SSA-family workflows.</p>
<h3 id="ssa"><code>SSA</code></h3>
<ul>
<li>Summary: Singular spectrum analysis for structured univariate decomposition.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://link.springer.com/book/10.1007/978-3-662-62436-4">Golyandina and Zhigljavsky (2020), Singular Spectrum Analysis for Time Series</a> - Primary SSA reference; the second edition also covers multivariate SSA (MSSA).</p>
<p>Related packages:
- <a href="https://github.com/ADSCIAN/ssalib">SSALib</a> - Specialist SSA package used as an external comparison point.</p>
<h3 id="std"><code>STD</code></h3>
<ul>
<li>Summary: Fast seasonal-trend decomposition with dispersion-aware diagnostics.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://doi.org/10.48550/arXiv.2204.10398">Dudek (2022), STD: A Seasonal-Trend-Dispersion Decomposition of Time Series</a> - Primary reference for STD and the robust seasonal-trend-dispersion family.</p>
<p>Related packages:
- none declared</p>
<h3 id="stdr"><code>STDR</code></h3>
<ul>
<li>Summary: Robust seasonal-trend decomposition for noisier periodic signals.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://doi.org/10.48550/arXiv.2204.10398">Dudek (2022), STD: A Seasonal-Trend-Dispersion Decomposition of Time Series</a> - Primary reference for STD and the robust seasonal-trend-dispersion family.</p>
<p>Related packages:
- none declared</p>
<h2 id="stable-wrappers-and-retained-methods">Stable wrappers and retained methods</h2>
<h3 id="ceemdan"><code>CEEMDAN</code></h3>
<ul>
<li>Summary: Noise-assisted EMD variant for more stable IMF extraction.</li>
<li>Optional/runtime dependencies: PyEMD</li>
</ul>
<p>Primary references:
- <a href="https://pyemd.readthedocs.io/en/latest/ceemdan.html">Torres et al. (2011), A complete ensemble empirical mode decomposition with adaptive noise</a> - PyEMD CEEMDAN docs cite the original ICASSP 2011 paper.
- <a href="https://pyemd.readthedocs.io/en/latest/ceemdan.html">Colominas, Schlotthauer, and Torres (2014), Improved complete ensemble EMD: A suitable tool for biomedical signal processing</a> - Improved CEEMDAN variant adopted by the PyEMD implementation used by DeTime.</p>
<p>Related packages:
- <a href="https://github.com/laszukdawid/PyEMD">PyEMD</a> - Upstream Python package wrapped by DeTime for EMD-family methods.</p>
<h3 id="emd"><code>EMD</code></h3>
<ul>
<li>Summary: Empirical mode decomposition under the DeTime result contract.</li>
<li>Optional/runtime dependencies: PyEMD</li>
</ul>
<p>Primary references:
- <a href="https://doi.org/10.1098/rspa.1998.0193">Huang et al. (1998), The empirical mode decomposition and the Hilbert spectrum for nonlinear and non-stationary time series analysis</a> - Primary empirical mode decomposition reference.</p>
<p>Related packages:
- <a href="https://github.com/laszukdawid/PyEMD">PyEMD</a> - Upstream Python package wrapped by DeTime for EMD-family methods.</p>
<h3 id="ma_baseline"><code>MA_BASELINE</code></h3>
<ul>
<li>Summary: Simple moving-average baseline for smoke tests and lightweight workflows.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- none declared</p>
<p>Related packages:
- none declared</p>
<h3 id="mstl"><code>MSTL</code></h3>
<ul>
<li>Summary: Statsmodels MSTL wrapped into the DeTime workflow surface.</li>
<li>Optional/runtime dependencies: statsmodels</li>
</ul>
<p>Primary references:
- <a href="https://arxiv.org/abs/2107.13462">Bandara, Hyndman, and Bergmeir (2021), MSTL: A Seasonal-Trend Decomposition Algorithm for Time Series with Multiple Seasonal Patterns</a> - Primary MSTL reference used by the statsmodels implementation.</p>
<p>Related packages:
- <a href="https://www.statsmodels.org/">statsmodels</a> - Official project site for the upstream MSTL implementation.</p>
<h3 id="robust_stl"><code>ROBUST_STL</code></h3>
<ul>
<li>Summary: Robust STL-style decomposition wrapped for reproducible workflows.</li>
<li>Optional/runtime dependencies: statsmodels</li>
</ul>
<p>Primary references:
- <a href="https://www.statsmodels.org/dev/generated/statsmodels.tsa.seasonal.STL.html">Cleveland et al. (1990), STL: A Seasonal-Trend Decomposition Procedure Based on LOESS</a> - Robust STL in DeTime builds on the same STL literature and upstream implementation family.</p>
<p>Related packages:
- <a href="https://www.statsmodels.org/">statsmodels</a> - Official project site for the upstream STL implementation family.</p>
<h3 id="stl"><code>STL</code></h3>
<ul>
<li>Summary: Classical STL wrapped into the DeTime workflow contract.</li>
<li>Optional/runtime dependencies: statsmodels</li>
</ul>
<p>Primary references:
- <a href="https://www.statsmodels.org/dev/generated/statsmodels.tsa.seasonal.STL.html">Cleveland et al. (1990), STL: A Seasonal-Trend Decomposition Procedure Based on LOESS</a> - Statsmodels STL docs cite the original Journal of Official Statistics paper.</p>
<p>Related packages:
- <a href="https://www.statsmodels.org/">statsmodels</a> - Official project site for the upstream STL implementation.</p>
<h3 id="vmd"><code>VMD</code></h3>
<ul>
<li>Summary: Variational mode decomposition integrated into the common workflow layer.</li>
<li>Optional/runtime dependencies: vmdpy, sktime</li>
</ul>
<p>Primary references:
- <a href="https://doi.org/10.1109/TSP.2013.2288675">Dragomiretskiy and Zosso (2014), Variational Mode Decomposition</a> - Primary variational mode decomposition reference.</p>
<p>Related packages:
- <a href="https://www.sktime.net/en/stable/">sktime</a> - Current maintained ecosystem for <code>vmdpy</code>, which the archived project directs users toward.
- <a href="https://github.com/vrcarva/vmdpy">vmdpy</a> - Archived Python VMD package used by the current DeTime wrapper.</p>
<h3 id="wavelet"><code>WAVELET</code></h3>
<ul>
<li>Summary: Wavelet-based decomposition exposed through the common output contract.</li>
<li>Optional/runtime dependencies: PyWavelets</li>
</ul>
<p>Primary references:
- <a href="https://ieeexplore.ieee.org/document/192463">Mallat (1989), A theory for multiresolution signal decomposition: the wavelet representation</a> - Foundational wavelet multiresolution reference.
- <a href="https://doi.org/10.21105/joss.01237">Lee et al. (2019), PyWavelets: A Python package for wavelet analysis</a> - Package citation for the upstream wavelet implementation used by DeTime.</p>
<p>Related packages:
- <a href="https://pywavelets.readthedocs.io/en/latest/">PyWavelets</a> - Official documentation for the upstream wavelet package.</p>
<h2 id="optional-backend-methods">Optional backend methods</h2>
<h3 id="memd"><code>MEMD</code></h3>
<ul>
<li>Summary: Optional multivariate EMD backend for shared oscillatory structure.</li>
<li>Optional/runtime dependencies: PySDKit</li>
</ul>
<p>Primary references:
- <a href="https://doi.org/10.1098/rspa.2009.0502">Rehman and Mandic (2010), Multivariate empirical mode decomposition</a> - Primary MEMD reference for the multivariate EMD extension.</p>
<p>Related packages:
- <a href="https://pysdkit.readthedocs.io/en/latest/">PySDKit</a> - Optional multivariate backend used by DeTime for MEMD.</p>
<h3 id="mvmd"><code>MVMD</code></h3>
<ul>
<li>Summary: Optional multivariate VMD backend for shared frequency structure.</li>
<li>Optional/runtime dependencies: PySDKit</li>
</ul>
<p>Primary references:
- <a href="https://arxiv.org/abs/1907.04509">Rehman and Aftab (2019), Multivariate Variational Mode Decomposition</a> - Primary MVMD reference for the multivariate VMD extension.</p>
<p>Related packages:
- <a href="https://pysdkit.readthedocs.io/en/latest/">PySDKit</a> - Optional multivariate backend used by DeTime for MVMD.</p>
<h2 id="experimental-methods">Experimental methods</h2>
<h3 id="amd_block"><code>AMD_BLOCK</code></h3>
<ul>
<li>Summary: AMD-inspired multiscale smoothing head with periodic-template seasonal reconstruction.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://arxiv.org/abs/2406.03751">Hu et al. (2024), Adaptive Multi-Scale Decomposition Framework for Time Series Forecasting</a> - Source framework for adaptive multiscale decomposition.</p>
<p>Related packages:
- none declared</p>
<h3 id="autoformer_block"><code>AUTOFORMER_BLOCK</code></h3>
<ul>
<li>Summary: Standalone moving-average decomposition head extracted from the Autoformer architecture.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://proceedings.neurips.cc/paper_files/paper/2021/hash/bcc0d400288793e8bdcd7c19a8ac0c2b-Abstract.html">Wu et al. (2021), Autoformer: Decomposition Transformers with Auto-Correlation for Long-Term Series Forecasting</a> - Source architecture for the moving-average decomposition block exposed by AUTOFORMER_BLOCK.</p>
<p>Related packages:
- none declared</p>
<h3 id="delelstm_block"><code>DELELSTM_BLOCK</code></h3>
<ul>
<li>Summary: DeLELSTM-inspired Holt trend plus periodic-template seasonal decomposition head.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://arxiv.org/abs/2308.13797">Wang et al. (2023), DeLELSTM: Decomposition-based Linear Explainable LSTM to Capture Instantaneous and Long-term Effects in Time Series</a> - Source model for decomposition-based explainable LSTM effects.</p>
<p>Related packages:
- none declared</p>
<h3 id="dlinear_block"><code>DLINEAR_BLOCK</code></h3>
<ul>
<li>Summary: Standalone moving-average decomposition head extracted from DLinear-style forecasting blocks.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://ojs.aaai.org/index.php/AAAI/article/view/26317">Zeng et al. (2023), Are Transformers Effective for Time Series Forecasting?</a> - Introduces the LTSF-Linear family, including the DLinear decomposition-based linear model.</p>
<p>Related packages:
- none declared</p>
<h3 id="freqmoe_block"><code>FREQMOE_BLOCK</code></h3>
<ul>
<li>Summary: FreqMoE-inspired frequency mixture head for trend plus multi-band seasonal reconstruction.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://arxiv.org/abs/2501.15125">Liu (2025), FreqMoE: Enhancing Time Series Forecasting through Frequency Decomposition Mixture of Experts</a> - Source architecture for frequency decomposition mixture-of-experts forecasting.</p>
<p>Related packages:
- none declared</p>
<h3 id="gabor_cluster"><code>GABOR_CLUSTER</code></h3>
<ul>
<li>Summary: Experimental clustering-based decomposition path.</li>
<li>Optional/runtime dependencies: faiss</li>
</ul>
<p>Primary references:
- <a href="https://www.rctn.org/w/images/b/b6/Gabor.pdf">Gabor (1946), Theory of Communication</a> - Historical reference for the Gabor time-frequency representation family.
- <a href="https://arxiv.org/abs/2401.08281">Douze et al. (2024), The Faiss library</a> - Reference for the similarity-search backend used by the experimental clustering path.</p>
<p>Related packages:
- <a href="https://github.com/facebookresearch/faiss">Faiss</a> - Vector similarity search library required by the experimental clustering backend.</p>
<h3 id="inparformer_block"><code>INPARFORMER_BLOCK</code></h3>
<ul>
<li>Summary: InParformer-inspired moving-average trend plus periodic-template seasonal decomposition head.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://ojs.aaai.org/index.php/AAAI/article/view/25845">Cao et al. (2023), InParformer: Evolutionary Decomposition Transformers with Interactive Parallel Attention for Long-Term Time Series Forecasting</a> - Source architecture for evolutionary seasonal-trend decomposition in a transformer forecaster.</p>
<p>Related packages:
- none declared</p>
<h3 id="leddam_block"><code>LEDDAM_BLOCK</code></h3>
<ul>
<li>Summary: LEDDAM LD smoothing block exposed as a Gaussian-kernel decomposition operator.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://arxiv.org/abs/2402.12694">Yu et al. (2024), Revitalizing Multivariate Time Series Forecasting: Learnable Decomposition with Inter-Series Dependencies and Intra-Series Variations Modeling</a> - Introduces LEDDAM, the learnable decomposition and dual-attention module.</p>
<p>Related packages:
- none declared</p>
<h3 id="moving_average_decomposition_block"><code>MOVING_AVERAGE_DECOMPOSITION_BLOCK</code></h3>
<ul>
<li>Summary: Generic neural forecasting moving-average decomposition block exposed as a DeTime method.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://proceedings.neurips.cc/paper_files/paper/2021/hash/bcc0d400288793e8bdcd7c19a8ac0c2b-Abstract.html">Wu et al. (2021), Autoformer: Decomposition Transformers with Auto-Correlation for Long-Term Series Forecasting</a> - Primary source for treating moving-average series decomposition as an internal neural forecasting block.
- <a href="https://ojs.aaai.org/index.php/AAAI/article/view/26317">Zeng et al. (2023), Are Transformers Effective for Time Series Forecasting?</a> - Uses decomposition-based linear forecasting as a simple long-term forecasting baseline.</p>
<p>Related packages:
- none declared</p>
<h3 id="nbeats_interpretable"><code>NBEATS_INTERPRETABLE</code></h3>
<ul>
<li>Summary: Torch-backed interpretable N-BEATS trend and seasonality stacks used as a learned decomposition prior.</li>
<li>Optional/runtime dependencies: torch</li>
</ul>
<p>Primary references:
- <a href="https://openreview.net/forum?id=r1ecqn4YwB">Oreshkin et al. (2020), N-BEATS: Neural basis expansion analysis for interpretable time series forecasting</a> - Source for interpretable trend and seasonality basis stacks.</p>
<p>Related packages:
- none declared</p>
<h3 id="parsimony_block"><code>PARSIMONY_BLOCK</code></h3>
<ul>
<li>Summary: Parsimony-inspired trend head with compact harmonic seasonal projection.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://arxiv.org/abs/2401.11929">Deng et al. (2024), Parsimony or Capability? Decomposition Delivers Both in Long-term Time Series Forecasting</a> - Source paper for parameter-efficient decomposition in long-term forecasting.</p>
<p>Related packages:
- none declared</p>
<h3 id="st_mtm_block"><code>ST_MTM_BLOCK</code></h3>
<ul>
<li>Summary: ST-MTM-inspired smoothing head combining trend smoothing and smoothed periodic seasonality.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://arxiv.org/abs/2507.00013">Seo and Lim (2025), ST-MTM: Masked Time Series Modeling with Seasonal-Trend Decomposition for Time Series Forecasting</a> - Source method for seasonal-trend masked time-series modeling.</p>
<p>Related packages:
- none declared</p>
<h3 id="timekan_block"><code>TIMEKAN_BLOCK</code></h3>
<ul>
<li>Summary: TimeKAN-inspired decomposition head blending template and harmonic seasonal estimates.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://arxiv.org/abs/2502.06910">Huang et al. (2025), TimeKAN: KAN-based Frequency Decomposition Learning Architecture for Long-term Time Series Forecasting</a> - Source method for KAN-based frequency decomposition learning.</p>
<p>Related packages:
- none declared</p>
<h3 id="times2d_block"><code>TIMES2D_BLOCK</code></h3>
<ul>
<li>Summary: Times2D-inspired multi-period harmonic decomposition head.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://arxiv.org/abs/2504.00118">Nematirad, Pahwa, and Natarajan (2025), Times2D: Multi-Period Decomposition and Derivative Mapping for General Time Series Forecasting</a> - Source method for multi-period decomposition and 2D time-series mapping.</p>
<p>Related packages:
- none declared</p>
<h3 id="waveform_block"><code>WAVEFORM_BLOCK</code></h3>
<ul>
<li>Summary: WaveForM-inspired wavelet multiresolution decomposition head.</li>
<li>Optional/runtime dependencies: PyWavelets</li>
</ul>
<p>Primary references:
- <a href="https://ojs.aaai.org/index.php/AAAI/article/view/26276">Yang et al. (2023), WaveForM: Graph Enhanced Wavelet Learning for Long Sequence Forecasting of Multivariate Time Series</a> - Source architecture for graph-enhanced wavelet learning.</p>
<p>Related packages:
- none declared</p>
<h3 id="waveletmixer_block"><code>WAVELETMIXER_BLOCK</code></h3>
<ul>
<li>Summary: WaveletMixer-inspired multiresolution decomposition head using mixed wavelet detail levels.</li>
<li>Optional/runtime dependencies: PyWavelets</li>
</ul>
<p>Primary references:
- <a href="https://ojs.aaai.org/index.php/AAAI/article/view/34434">Zhang et al. (2025), WaveletMixer: A Multi-Resolution Wavelets Based MLP-Mixer for Multivariate Long-Term Time Series Forecasting</a> - Source method for multi-resolution wavelet mixer forecasting.</p>
<p>Related packages:
- none declared</p>
<h3 id="xpatch_block"><code>XPATCH_BLOCK</code></h3>
<ul>
<li>Summary: xPatch-inspired exponential smoothing head for standalone trend and local-season decomposition.</li>
<li>Optional/runtime dependencies: none</li>
</ul>
<p>Primary references:
- <a href="https://arxiv.org/abs/2412.17323">Stitsyuk and Choi (2024), xPatch: Dual-Stream Time Series Forecasting with Exponential Seasonal-Trend Decomposition</a> - Source architecture for exponential seasonal-trend decomposition.</p>
<p>Related packages:
- none declared</p></div>
</div>
</div>
<footer class="col-md-12">
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="../js/bootstrap.bundle.min.js"></script>
<script>
var base_url = "..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../js/base.js"></script>
<script src="../search/main.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="searchModalLabel">Search</h4>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<p>From here you can search these documents. Enter your search terms below.</p>
<form>
<div class="form-group">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>
|