File size: 32,228 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 | <!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/api/">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>API Overview - 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" 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="../method-references/" class="dropdown-item">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 active" aria-current="page" role="button" data-bs-toggle="dropdown" aria-expanded="false">Reference</a>
<ul class="dropdown-menu">
<li>
<a href="./" class="dropdown-item active" aria-current="page">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="../gallery/gabor-cluster/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../config-reference/" 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="#api" class="nav-link">API</a>
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="2"><a href="#canonical-import" class="nav-link">Canonical import</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#decompositionconfig" class="nav-link">DecompositionConfig</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#decompresult" class="nav-link">DecompResult</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#decomposeseries-config" class="nav-link">decompose(series, config)</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#methodregistry" class="nav-link">MethodRegistry</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#serialization-and-machine-facing-apis" class="nav-link">Serialization and machine-facing APIs</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#cli-summary" class="nav-link">CLI summary</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="api">API</h1>
<h2 id="canonical-import">Canonical import</h2>
<pre><code class="language-python">from detime import DecompositionConfig, DecompResult, MethodRegistry, decompose
</code></pre>
<p>The canonical package import is <code>detime</code>. The top-level <code>tsdecomp</code> import and
CLI remain compatibility aliases only through <code>0.1.x</code>.</p>
<h2 id="decompositionconfig"><code>DecompositionConfig</code></h2>
<p><code>DecompositionConfig</code> is the validated runtime contract for Python calls and
mirrors the CLI surface.</p>
<p>For the generated parameter-level reference, see
<a href="../config-reference/">Config Reference</a>. For method-level input/backend/output
comparison, see <a href="../method-matrix/">Method Matrix</a>.</p>
<ul>
<li><code>method: str</code>
Required method name such as <code>SSA</code>, <code>STD</code>, <code>STDR</code>, <code>MSSA</code>, <code>MVMD</code>, or
<code>MEMD</code>.</li>
<li><code>params: dict[str, Any] = {}</code>
Method-specific parameters. Examples include <code>period</code> for <code>STD</code>, <code>window</code>
and <code>rank</code> for <code>SSA</code>, and <code>primary_period</code> for automatic grouping.</li>
<li><code>return_components: list[str] | None = None</code>
Reserved compatibility field. Current decomposition entrypoints return the
full <code>DecompResult</code>; methods may ignore this field.</li>
<li><code>backend: "auto" | "native" | "python" | "gpu" = "auto"</code>
Backend preference. <code>auto</code> uses a native kernel when one exists, <code>python</code>
forces the Python implementation, <code>native</code> requires the native path, and
<code>gpu</code> raises unless a method explicitly supports it.</li>
<li><code>speed_mode: "exact" | "fast" = "exact"</code>
Runtime accuracy policy. For native <code>SSA</code>, <code>exact</code> follows the deterministic
SVD-backed path and <code>fast</code> uses the approximate iterative kernel.</li>
<li><code>profile: bool = False</code>
When <code>True</code>, attach runtime metadata such as <code>runtime_ms</code> to result metadata
or profile reports.</li>
<li><code>device: str | None = "cpu"</code>
Reserved execution device selector. Current retained methods are CPU
workflows unless a wrapper says otherwise.</li>
<li><code>n_jobs: int = 1</code>
Requested parallelism hint for methods or wrappers that support it.</li>
<li><code>seed: int | None = 42</code>
Random seed used by fast or approximate backends where relevant.</li>
<li><code>channel_names: list[str] | None = None</code>
Optional channel labels for multivariate inputs. These are copied into result
metadata and saved artifacts.</li>
</ul>
<p>Validation errors come from Pydantic. Invalid backend names, negative
<code>n_jobs</code>, or malformed parameter payloads fail before decomposition starts.</p>
<h2 id="decompresult"><code>DecompResult</code></h2>
<p><code>DecompResult</code> is the normalized output object returned by <code>decompose(...)</code>.</p>
<ul>
<li><code>trend: np.ndarray</code>
Trend component. Shape matches the input layout.</li>
<li><code>season: np.ndarray</code>
Seasonal or oscillatory component. Shape matches the input layout.</li>
<li><code>residual: np.ndarray</code>
Remaining unexplained component. Shape matches the input layout.</li>
<li><code>components: dict[str, np.ndarray]</code>
Method-specific extra outputs such as <code>modes</code>, <code>imfs</code>, <code>dispersion</code>, or
<code>seasonal_shape</code>.</li>
<li><code>meta: dict[str, Any]</code>
Runtime and provenance metadata. Common keys include <code>method</code>,
<code>backend_requested</code>, <code>backend_used</code>, <code>speed_mode</code>, <code>result_layout</code>,
<code>n_channels</code>, <code>channel_names</code>, and <code>runtime_ms</code> when profiling is enabled.</li>
</ul>
<p>The core reconstruction contract is:</p>
<pre><code class="language-python">result.trend + result.season + result.residual
</code></pre>
<p>which should match the original input up to the documented method tolerance.</p>
<h2 id="decomposeseries-config"><code>decompose(series, config)</code></h2>
<p><code>decompose(series, config)</code> is the public execution entrypoint.</p>
<ul>
<li>Accepted input shapes:</li>
<li>1D arrays for univariate methods.</li>
<li>2D arrays of shape <code>(time, channels)</code> for multivariate or channelwise
methods.</li>
<li>Return value:</li>
<li>One <code>DecompResult</code>.</li>
<li>Common errors:</li>
<li><code>ValueError</code> for unsupported shapes or missing required parameters.</li>
<li><code>RuntimeError</code> when <code>backend="native"</code> is forced but no native kernel is
available.</li>
<li><code>ImportError</code> for optional-backend methods such as <code>MVMD</code> and <code>MEMD</code>
without <code>de-time[multivar]</code>.</li>
</ul>
<p>Backend resolution is method-specific:</p>
<ul>
<li><code>SSA</code>, <code>STD</code>, <code>STDR</code>, <code>MA_BASELINE</code>, <code>MSSA</code>, <code>VMD</code>, and <code>GABOR_CLUSTER</code> can use native kernels.</li>
<li><code>MVMD</code> and <code>MEMD</code> are optional-backend wrappers and require the <code>multivar</code>
extra.</li>
</ul>
<h2 id="methodregistry"><code>MethodRegistry</code></h2>
<p><code>MethodRegistry</code> is the machine-readable source of truth for the installed
method catalog.</p>
<ul>
<li><code>MethodRegistry.list_methods()</code>
Return registered public method names.</li>
<li><code>MethodRegistry.list_catalog()</code>
Return the full catalog used by docs generation, recommendation, and MCP.</li>
<li><code>MethodRegistry.get_metadata(method_name)</code>
Return one catalog entry as a dictionary.</li>
<li><code>MethodRegistry.get(method_name)</code>
Return the callable decomposition implementation.</li>
<li><code>MethodRegistry.register(method_name)</code>
Decorator used by method modules to register implementations.</li>
</ul>
<p>Every catalog payload now includes:</p>
<ul>
<li><code>package</code></li>
<li><code>version</code></li>
<li><code>contract_version</code></li>
<li><code>methods</code></li>
</ul>
<p>Every method entry exposes at least:</p>
<ul>
<li><code>family</code></li>
<li><code>input_mode</code></li>
<li><code>maturity</code></li>
<li><code>implementation</code></li>
<li><code>dependency_tier</code></li>
<li><code>multivariate_support</code></li>
<li><code>native_backed</code></li>
<li><code>min_length</code></li>
<li><code>summary</code></li>
<li><code>recommended_for</code></li>
<li><code>typical_failure_modes</code></li>
<li><code>assumptions</code></li>
<li><code>not_recommended_for</code></li>
<li><code>optional_dependencies</code></li>
<li><code>references</code></li>
<li><code>package_links</code></li>
<li><code>parameter_docs</code></li>
<li><code>output_components</code></li>
<li><code>example_config</code></li>
</ul>
<h2 id="serialization-and-machine-facing-apis">Serialization and machine-facing APIs</h2>
<p>DeTime publishes three result views for bounded-context workflows:</p>
<ul>
<li><code>full</code>
Full arrays plus metadata and diagnostics.</li>
<li><code>summary</code>
Array shapes and summary statistics plus metadata and diagnostics.</li>
<li><code>meta</code>
Metadata and diagnostics only.</li>
</ul>
<p>Machine-facing entrypoints:</p>
<ul>
<li><code>detime schema --name config|result|meta|method-registry</code></li>
<li><code>detime recommend --length ... --channels ...</code></li>
<li><code>python -m detime.mcp.server</code></li>
</ul>
<p>The <code>method-registry</code> schema and payload are versioned within the current
machine-contract series <code>0.1</code>. Consumers should prefer <code>contract_version</code> over
guessing schema compatibility from the package version alone.</p>
<h2 id="cli-summary">CLI summary</h2>
<p>Supported top-level commands:</p>
<ul>
<li><code>detime run</code></li>
<li><code>detime batch</code></li>
<li><code>detime profile</code></li>
<li><code>detime version</code></li>
<li><code>detime schema</code></li>
<li><code>detime recommend</code></li>
</ul>
<p>CLI profile reports support both <code>json</code> and <code>text</code> output, and <code>detime profile
--format text</code> now affects stdout as well as <code>--output</code> files.</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>
|