dwker/v2realbot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
66a4cb5d7c78af5377880e6b78ca0037f1c5fa3d
v2realbot/v2realbot/static/js/vbt/api/generic/splitting/base/index.html
T
David Brazda 66a4cb5d7c update of vbt doc
2024-04-25 06:24:51 +02:00

966 lines
527 KiB
HTML
Raw Blame History

<!doctype html><html lang=en class=no-js>
<!-- Mirrored from vectorbt.pro/pvt_321460c7/api/generic/splitting/base/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 05 Mar 2024 10:58:37 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=utf-8" /><!-- /Added by HTTrack -->
<head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Base class for splitting"><meta name=author content="Oleg Polakow"><link href=https://vectorbt.pro/api/generic/splitting/base/ rel=canonical><link href=../index.html rel=prev><link href=../decorators/index.html rel=next><link rel=icon href=../../../../assets/logo/favicon.png><meta name=generator content="mkdocs-1.5.3, mkdocs-material-9.5.2+insiders-4.47.1"><title>base - VectorBT PRO</title><link rel=stylesheet href=../../../../assets/stylesheets/main.78d85e4f.min.css><link rel=stylesheet href=../../../../assets/stylesheets/palette.ab4e12ef.min.css><link rel=preconnect href=https://fonts.gstatic.com/ crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&amp;display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../../../assets/stylesheets/extra.css><link rel=stylesheet href=../../../../assets/stylesheets/custom-light.css><link rel=stylesheet href=../../../../assets/stylesheets/custom-dark.css><link rel=stylesheet href=../../../../assets/stylesheets/pygments-light.css><link rel=stylesheet href=../../../../assets/stylesheets/pygments-dark.css><script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><script id=__analytics>function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-0C5VNYCFHL"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-0C5VNYCFHL",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-0C5VNYCFHL",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script><script>var consent;"undefined"==typeof __md_analytics||(consent=__md_get("__consent"))&&consent.analytics&&__md_analytics()</script><meta name=robots content=noindex><meta property=og:title content=base><meta property=og:type content=website><meta content=https://vectorbt.pro/api/generic/splitting/base/ property=og:url><meta property=og:image:url content=https://vectorbt.pro/pvt_321460c7/assets/logo/social-new.png><meta property=og:image:type content=image/png><meta property=og:description content="Base class for splitting"><meta property=og:locale content=en-GB><link rel=apple-touch-icon sizes=180x180 href=../../../../assets/logo/apple-touch-icon.png><link rel=icon type=image/svg+xml href=../../../../assets/logo/favicon.svg><link rel=icon type=image/png sizes=32x32 href=../../../../assets/logo/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=../../../../assets/logo/favicon-16x16.png><link rel=manifest href=../../../../assets/logo/site.webmanifest><link rel=mask-icon href=../../../../assets/logo/safari-pinned-tab.svg color=#1e1f22><link rel="shortcut icon" href=../../../../assets/logo/favicon.ico><meta name=msapplication-TileColor content=#1e1f22><meta name=msapplication-config content=https://vectorbt.pro/pvt_321460c7/assets/logo/browserconfig.xml><meta name=theme-color content=#1e1f22><link href=https://unpkg.com/aos@2.3.4/dist/aos.css rel=stylesheet><script src=https://unpkg.com/aos@2.3.4/dist/aos.js></script><link href=http://fonts.cdnfonts.com/css/uni-neue rel=stylesheet><link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.2/css/all.min.css integrity="sha512-1sCRPdkRXhBV2PBLUdRb4tMg1w2YPf37qatUFeS7zlBy7jJI8Lf4VHwWfZZfpXtYSLy85pkm9GaYVYMfw5BC1A==" crossorigin=anonymous referrerpolicy=no-referrer><script src=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.2/js/all.min.js integrity="sha512-8pHNiqTlsrRjVD4A/3va++W1sMbUHwWxxRPWNyVlql3T+Hgfd81Qc6FC5WMXDC+tSauxxzp1tgiAvSKFu1qIlA==" crossorigin=anonymous referrerpolicy=no-referrer></script><script src=https://cdnjs.cloudflare.com/ajax/libs/lazysizes/5.3.2/lazysizes.min.js integrity="sha512-q583ppKrCRc7N5O0n2nzUiJ+suUv7Et1JGels4bXOaMFQcamPk9HjdUknZuuFjBNs7tsMuadge5k9RzdmO+1GQ==" crossorigin=anonymous referrerpolicy=no-referrer></script><link rel=preconnect href=https://fonts.googleapis.com/><link rel=preconnect href=https://fonts.gstatic.com/ crossorigin></head> <body dir=ltr data-md-color-scheme=custom-dark data-md-color-primary=custom-dark data-md-color-accent=custom-dark> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#vectorbtpro.generic.splitting.base class=md-skip> Skip to content </a> </div> <div data-md-component=announce> <aside class=md-banner> <div class="md-banner__inner md-grid md-typeset"> <button class="md-banner__button md-icon" aria-label="Don't show this again"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg> </button> <i>New</i>: Star-import, signal unraveling, Python 3.12 support, and <a href=../../../../features/index.html><strong>more</strong></a> <span class="twemoji announce-icon"><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 384 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="m153.6 29.9 16-21.3c4-5.4 10.4-8.6 17.1-8.6C198.4 0 208 9.6 208 21.3v22.2c0 13.1 5.4 25.7 14.9 34.7l84.7 80.8c48.8 46.6 76.4 111.2 76.4 178.7C384 434 306 512 209.7 512H192C86 512 0 426 0 320v-3.8c0-48.8 19.4-95.6 53.9-130.1l3.5-3.5c4.2-4.2 10-6.6 16-6.6 12.5 0 22.6 10.1 22.6 22.6V288c0 35.3 28.7 64 64 64s64-28.7 64-64v-3.9c0-18-7.2-35.3-19.9-48l-38.6-38.6c-24-24-37.5-56.7-37.5-90.7 0-27.7 9-54.8 25.6-76.9z"/></svg></span> </div> <script>var content,el=document.querySelector("[data-md-component=announce]");el&&(content=el.querySelector(".md-typeset"),__md_hash(content.innerHTML)===__md_get("__announce")&&(el.hidden=!0))</script> </aside> </div> <!-- Determine class according to configuration --> <!-- Header --> <header class=md-header data-md-component=header> <nav class="md-header__inner md-grid" aria-label=header.title> <!-- Link to home --> <a href=../../../../index.html title="VectorBT PRO" class="md-header__button md-logo" aria-label="VectorBT PRO" data-md-component=logo> <img src=../../../../assets/logo/logo.svg alt=logo class=logo> </a> <!-- Button to open drawer --> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <!-- Header title --> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> VectorBT PRO <span class=md-version> v2024.2.22 </span> <a href=https://vectorbt.pro/ > <span class=unlock-icon><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M224 64c-44.2 0-80 35.8-80 80v48h240c35.3 0 64 28.7 64 64v192c0 35.3-28.7 64-64 64H64c-35.3 0-64-28.7-64-64V256c0-35.3 28.7-64 64-64h16v-48C80 64.5 144.5 0 224 0c57.5 0 107 33.7 130.1 82.3 7.6 16 .8 35.1-15.2 42.6s-35.1.8-42.6-15.2C283.4 82.6 255.9 64 224 64zm32 320c17.7 0 32-14.3 32-32s-14.3-32-32-32h-64c-17.7 0-32 14.3-32 32s14.3 32 32 32h64z"/></svg></span> </a> </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> base </span> </div> </div> </div> <!-- Color palette --> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media data-md-color-scheme=custom-dark data-md-color-primary=custom-dark data-md-color-accent=custom-dark aria-label="Switch to light mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_2 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg> </label> <input class=md-option data-md-color-media data-md-color-scheme=custom-light data-md-color-primary=custom-light data-md-color-accent=custom-light aria-label="Switch to dark mode" type=radio name=__palette id=__palette_2> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg> </label> </form> <!-- Site language selector --> <!-- Button to open search modal --> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> </label> <!-- Search interface --> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </label> <nav class=md-search__options aria-label=Search> <a href=javascript:void(0) class="md-search__icon md-icon" title=Share aria-label=Share data-clipboard data-clipboard-text data-md-component=search-share tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7 0-.24-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91 1.61 0 2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08Z"/></svg> </a> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg> </button> </nav> <div class=md-search__suggest data-md-component=search-suggest></div> </form> <div class=md-search__output> <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <!-- Repository information --> <div class=md-header__source> <a href=https://github.com/polakowo/vectorbt.pro title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 496 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg> </div> <div class=md-source__repository> vectorbt.pro </div> </a> </div> </nav> <!-- Navigation tabs (sticky) --> </header> <div class=md-container data-md-component=container> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class=md-grid> <ul class=md-tabs__list> <li class=md-tabs__item> <a href=../../../../index.html class=md-tabs__link> Getting started </a> </li> <li class=md-tabs__item> <a href=../../../../features/overview/index.html class=md-tabs__link> Features </a> </li> <li class=md-tabs__item> <a href=../../../../tutorials/basic-rsi/index.html class=md-tabs__link> Tutorials </a> </li> <li class=md-tabs__item> <a href=../../../../documentation/fundamentals/index.html class=md-tabs__link> Documentation </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href=../../../index.html class=md-tabs__link> API </a> </li> <li class=md-tabs__item> <a href=../../../../cookbook/overview/index.html class=md-tabs__link> Cookbook </a> </li> <li class=md-tabs__item> <a href=../../../../terms/terms-of-use/index.html class=md-tabs__link> Terms </a> </li> </ul> </div> </nav> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=../../../../index.html title="VectorBT PRO" class="md-nav__button md-logo" aria-label="VectorBT PRO" data-md-component=logo> <img src=../../../../assets/logo/logo.svg alt=logo class=logo> </a> VectorBT PRO </label> <div class=md-nav__source> <a href=https://github.com/polakowo/vectorbt.pro title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 496 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg> </div> <div class=md-source__repository> vectorbt.pro </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_1> <label class=md-nav__link for=__nav_1 id=__nav_1_label tabindex> <span class=md-ellipsis> Getting started </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_1_label aria-expanded=false> <label class=md-nav__title for=__nav_1> <span class="md-nav__icon md-icon"></span> Getting started </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../index.html class=md-nav__link> <span class=md-ellipsis> Getting started </span> </a> </li> <li class=md-nav__item> <a href=../../../../getting-started/installation/index.html class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_1_3> <label class=md-nav__link for=__nav_1_3 id=__nav_1_3_label tabindex> <span class=md-ellipsis> Release notes </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_3_label aria-expanded=false> <label class=md-nav__title for=__nav_1_3> <span class="md-nav__icon md-icon"></span> Release notes </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../getting-started/release-notes/index.html class=md-nav__link> <span class=md-ellipsis> Latest </span> </a> </li> <li class=md-nav__item> <a href=../../../../getting-started/release-notes/2023/index.html class=md-nav__link> <span class=md-ellipsis> 2023 </span> </a> </li> <li class=md-nav__item> <a href=../../../../getting-started/release-notes/2022/index.html class=md-nav__link> <span class=md-ellipsis> 2022 </span> </a> </li> <li class=md-nav__item> <a href=../../../../getting-started/release-notes/2021/index.html class=md-nav__link> <span class=md-ellipsis> 2021 </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2> <label class=md-nav__link for=__nav_2 id=__nav_2_label tabindex> <span class=md-ellipsis> Features </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2> <span class="md-nav__icon md-icon"></span> Features </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../features/overview/index.html class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../../../features/data/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 3C7.58 3 4 4.79 4 7s3.58 4 8 4 8-1.79 8-4-3.58-4-8-4M4 9v3c0 2.21 3.58 4 8 4s8-1.79 8-4V9c0 2.21-3.58 4-8 4s-8-1.79-8-4m0 5v3c0 2.21 3.58 4 8 4s8-1.79 8-4v-3c0 2.21-3.58 4-8 4s-8-1.79-8-4Z"/></svg> <span class=md-ellipsis> Data </span> </a> </li> <li class=md-nav__item> <a href=../../../../features/indicators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m3 14 .5.07L8.07 9.5a1.95 1.95 0 0 1 .52-1.91c.78-.79 2.04-.79 2.82 0 .53.52.7 1.26.52 1.91l2.57 2.57.5-.07c.18 0 .35 0 .5.07l3.57-3.57C19 8.35 19 8.18 19 8a2 2 0 0 1 2-2 2 2 0 0 1 2 2 2 2 0 0 1-2 2c-.18 0-.35 0-.5-.07l-3.57 3.57c.07.15.07.32.07.5a2 2 0 0 1-2 2 2 2 0 0 1-2-2l.07-.5-2.57-2.57c-.32.07-.68.07-1 0L4.93 15.5 5 16a2 2 0 0 1-2 2 2 2 0 0 1-2-2 2 2 0 0 1 2-2Z"/></svg> <span class=md-ellipsis> Indicators </span> </a> </li> <li class=md-nav__item> <a href=../../../../features/portfolio/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17.45 15.18 22 7.31V21H2V3h2v12.54L9.5 6 16 9.78l4.24-7.33 1.73 1-5.23 9.05-6.51-3.75L4.31 19h2.26l4.39-7.56 6.49 3.74Z"/></svg> <span class=md-ellipsis> Portfolio </span> </a> </li> <li class=md-nav__item> <a href=../../../../features/optimization/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16h-.58l-.81-.81A7.07 7.07 0 0 0 18 11c0-3.87-3.13-7-7-7-1.5 0-3 .5-4.21 1.4-3.09 2.32-3.72 6.71-1.4 9.8 2.32 3.09 6.71 3.72 9.8 1.4l.81.81V18l5 5 2-2-5-5m-7 0c-2.76 0-5-2.24-5-5s2.24-5 5-5 5 2.24 5 5-2.24 5-5 5M3 6 1 8V1h7L6 3H3v3m18-5v7l-2-2V3h-3l-2-2h7M6 19l2 2H1v-7l2 2v3h3Z"/></svg> <span class=md-ellipsis> Optimization </span> </a> </li> <li class=md-nav__item> <a href=../../../../features/analysis/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M7.2 11.2c1.77 0 3.2 1.43 3.2 3.2 0 1.77-1.43 3.2-3.2 3.2-1.77 0-3.2-1.43-3.2-3.2 0-1.77 1.43-3.2 3.2-3.2m7.6 4.8a2 2 0 0 1 2 2 2 2 0 0 1-2 2 2 2 0 0 1-2-2 2 2 0 0 1 2-2m.4-12A4.8 4.8 0 0 1 20 8.8c0 2.65-2.15 4.8-4.8 4.8a4.8 4.8 0 0 1-4.8-4.8c0-2.65 2.15-4.8 4.8-4.8Z"/></svg> <span class=md-ellipsis> Analysis </span> </a> </li> <li class=md-nav__item> <a href=../../../../features/productivity/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 16.5c0 .38-.21.71-.53.88l-7.9 4.44c-.16.12-.36.18-.57.18-.21 0-.41-.06-.57-.18l-7.9-4.44A.991.991 0 0 1 3 16.5v-9c0-.38.21-.71.53-.88l7.9-4.44c.16-.12.36-.18.57-.18.21 0 .41.06.57.18l7.9 4.44c.32.17.53.5.53.88v9M12 7a5 5 0 0 0-5 5 5 5 0 0 0 5 5 5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg> <span class=md-ellipsis> Productivity </span> </a> </li> <li class=md-nav__item> <a href=../../../../features/performance/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 16a3 3 0 0 1-3-3c0-1.12.61-2.1 1.5-2.61l9.71-5.62-5.53 9.58c-.5.98-1.51 1.65-2.68 1.65m0-13c1.81 0 3.5.5 4.97 1.32l-2.1 1.21C14 5.19 13 5 12 5a8 8 0 0 0-8 8c0 2.21.89 4.21 2.34 5.65h.01c.39.39.39 1.02 0 1.41-.39.39-1.03.39-1.42.01A9.969 9.969 0 0 1 2 13 10 10 0 0 1 12 3m10 10c0 2.76-1.12 5.26-2.93 7.07-.39.38-1.02.38-1.41-.01a.996.996 0 0 1 0-1.41A7.95 7.95 0 0 0 20 13c0-1-.19-2-.54-2.9L20.67 8C21.5 9.5 22 11.18 22 13Z"/></svg> <span class=md-ellipsis> Performance </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex> <span class=md-ellipsis> Tutorials </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=false> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> Tutorials </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../tutorials/basic-rsi/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m3.5 18.5 6-6 4 4L22 6.92 20.59 5.5l-7.09 8-4-4L2 17l1.5 1.5Z"/></svg> <span class=md-ellipsis> Basic RSI strategy </span> </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3_2> <label class=md-nav__link for=__nav_3_2 id=__nav_3_2_label tabindex> <span class=md-ellipsis> SuperFast SuperTrend </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_2_label aria-expanded=false> <label class=md-nav__title for=__nav_3_2> <span class="md-nav__icon md-icon"></span> SuperFast SuperTrend </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../tutorials/superfast-supertrend/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 9.47V11h3.76L13 14.53V13H9.24L11 9.47M13 1 6 15h5v8l7-14h-5V1Z"/></svg> <span class=md-ellipsis> SuperFast SuperTrend </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/superfast-supertrend/streaming/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 9.47V11h3.76L13 14.53V13H9.24L11 9.47M13 1 6 15h5v8l7-14h-5V1Z"/></svg> <span class=md-ellipsis> Streaming </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/superfast-supertrend/multithreading/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 9.47V11h3.76L13 14.53V13H9.24L11 9.47M13 1 6 15h5v8l7-14h-5V1Z"/></svg> <span class=md-ellipsis> Multithreading </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/superfast-supertrend/pipelines/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 9.47V11h3.76L13 14.53V13H9.24L11 9.47M13 1 6 15h5v8l7-14h-5V1Z"/></svg> <span class=md-ellipsis> Pipelines </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3_3> <label class=md-nav__link for=__nav_3_3 id=__nav_3_3_label tabindex> <span class=md-ellipsis> Signal development </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_3_label aria-expanded=false> <label class=md-nav__title for=__nav_3_3> <span class="md-nav__icon md-icon"></span> Signal development </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../tutorials/signal-development/generation/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 10c-1.1 0-2 .9-2 2s.9 2 2 2 2-.9 2-2-.9-2-2-2m6 2c0-3.3-2.7-6-6-6s-6 2.7-6 6c0 2.2 1.2 4.1 3 5.2l1-1.7c-1.2-.7-2-2-2-3.4 0-2.2 1.8-4 4-4s4 1.8 4 4c0 1.5-.8 2.8-2 3.4l1 1.7c1.8-1 3-3 3-5.2M12 2C6.5 2 2 6.5 2 12c0 3.7 2 6.9 5 8.6l1-1.7c-2.4-1.4-4-4-4-6.9 0-4.4 3.6-8 8-8s8 3.6 8 8c0 3-1.6 5.5-4 6.9l1 1.7c3-1.7 5-4.9 5-8.6 0-5.5-4.5-10-10-10Z"/></svg> <span class=md-ellipsis> Generation </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/signal-development/pre-analysis/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 10c-1.1 0-2 .9-2 2s.9 2 2 2 2-.9 2-2-.9-2-2-2m6 2c0-3.3-2.7-6-6-6s-6 2.7-6 6c0 2.2 1.2 4.1 3 5.2l1-1.7c-1.2-.7-2-2-2-3.4 0-2.2 1.8-4 4-4s4 1.8 4 4c0 1.5-.8 2.8-2 3.4l1 1.7c1.8-1 3-3 3-5.2M12 2C6.5 2 2 6.5 2 12c0 3.7 2 6.9 5 8.6l1-1.7c-2.4-1.4-4-4-4-6.9 0-4.4 3.6-8 8-8s8 3.6 8 8c0 3-1.6 5.5-4 6.9l1 1.7c3-1.7 5-4.9 5-8.6 0-5.5-4.5-10-10-10Z"/></svg> <span class=md-ellipsis> Pre-analysis </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../../../tutorials/stop-signals/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 23h-2V1h2v22m-4-4H5V5h4V3H5c-1.11 0-2 .89-2 2v14a2 2 0 0 0 2 2h4v-2M19 7v2h2V7h-2m0-2h2a2 2 0 0 0-2-2v2m2 10h-2v2h2v-2m-2-4v2h2v-2h-2m-2-8h-2v2h2V3m2 18c1.11 0 2-.89 2-2h-2v2m-2-2h-2v2h2v-2Z"/></svg> <span class=md-ellipsis> Stop signals </span> </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3_5> <label class=md-nav__link for=__nav_3_5 id=__nav_3_5_label tabindex> <span class=md-ellipsis> MTF analysis </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_5_label aria-expanded=false> <label class=md-nav__title for=__nav_3_5> <span class="md-nav__icon md-icon"></span> MTF analysis </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../tutorials/mtf-analysis/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 2h2v18h18v2H2V2m5 8h10v3H7v-3m4 5h10v3H11v-3M6 4h16v4h-2V6H8v2H6V4Z"/></svg> <span class=md-ellipsis> MTF analysis </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/mtf-analysis/alignment/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 2h2v18h18v2H2V2m5 8h10v3H7v-3m4 5h10v3H11v-3M6 4h16v4h-2V6H8v2H6V4Z"/></svg> <span class=md-ellipsis> Alignment </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/mtf-analysis/aggregation/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 2h2v18h18v2H2V2m5 8h10v3H7v-3m4 5h10v3H11v-3M6 4h16v4h-2V6H8v2H6V4Z"/></svg> <span class=md-ellipsis> Aggregation </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3_6> <label class=md-nav__link for=__nav_3_6 id=__nav_3_6_label tabindex> <span class=md-ellipsis> Portfolio optimization </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_6_label aria-expanded=false> <label class=md-nav__title for=__nav_3_6> <span class="md-nav__icon md-icon"></span> Portfolio optimization </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../tutorials/portfolio-optimization/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M22 21H2V3h2v16h2v-2h4v2h2v-3h4v3h2v-2h4v4m-4-7h4v2h-4v-2m-6-8h4v3h-4V6m4 9h-4v-5h4v5M6 10h4v2H6v-2m4 6H6v-3h4v3Z"/></svg> <span class=md-ellipsis> Portfolio optimization </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/portfolio-optimization/integrations/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M22 21H2V3h2v16h2v-2h4v2h2v-3h4v3h2v-2h4v4m-4-7h4v2h-4v-2m-6-8h4v3h-4V6m4 9h-4v-5h4v5M6 10h4v2H6v-2m4 6H6v-3h4v3Z"/></svg> <span class=md-ellipsis> Integrations </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/portfolio-optimization/dynamic/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M22 21H2V3h2v16h2v-2h4v2h2v-3h4v3h2v-2h4v4m-4-7h4v2h-4v-2m-6-8h4v3h-4V6m4 9h-4v-5h4v5M6 10h4v2H6v-2m4 6H6v-3h4v3Z"/></svg> <span class=md-ellipsis> Dynamic </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../../../tutorials/pairs-trading/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M22 6.92 20.59 5.5l-2.85 3.22C15.68 6.4 12.83 5 9.61 5 6.72 5 4.07 6.16 2 8l1.42 1.42C5.12 7.93 7.27 7 9.61 7c2.74 0 5.09 1.26 6.77 3.24L13.5 13.5l-4-4L2 17l1.5 1.5 6-6 4 4 4.05-4.57c.75 1.35 1.25 2.9 1.45 4.57h2c-.22-2.32-.95-4.41-2.04-6.16L22 6.92Z"/></svg> <span class=md-ellipsis> Pairs trading </span> </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3_8> <label class=md-nav__link for=__nav_3_8 id=__nav_3_8_label tabindex> <span class=md-ellipsis> Patterns and projections </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_8_label aria-expanded=false> <label class=md-nav__title for=__nav_3_8> <span class="md-nav__icon md-icon"></span> Patterns and projections </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../tutorials/patterns-and-projections/patterns/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m23 7.5-6.47-.54L14 1l-2.53 5.96L5 7.5l4.9 4.27-1.46 6.33L14 14.74l5.56 3.36-1.47-6.33L23 7.5m-6.86 4.73.4 1.71-1.51-.91-1.03-.62-1.03.62-1.51.91.39-1.71.28-1.18-.91-.79L9.88 9.1l1.76-.15 1.2-.1.47-1.11.69-1.62.69 1.62.47 1.11 1.2.1 1.75.15-1.33 1.16-.92.79.28 1.18M1.16 12c-.299-.5-.171-1.11.29-1.41l2.73-1.8 1.57 1.36-3.2 2.11c-.17.11-.36.17-.55.17-.32 0-.64-.16-.84-.43m.29 8.16 5.86-3.85L7 17.76l-.34 1.37-4.11 2.71c-.17.11-.36.16-.55.16-.32 0-.64-.16-.84-.45a1.013 1.013 0 0 1 .29-1.39m5.87-8.66.92.81-.27 1.19-5.42 3.55c-.17.11-.36.16-.55.16-.32 0-.64-.15-.84-.45a1 1 0 0 1 .29-1.38l5.87-3.88Z"/></svg> <span class=md-ellipsis> Patterns </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/patterns-and-projections/projections/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m23 7.5-6.47-.54L14 1l-2.53 5.96L5 7.5l4.9 4.27-1.46 6.33L14 14.74l5.56 3.36-1.47-6.33L23 7.5m-6.86 4.73.4 1.71-1.51-.91-1.03-.62-1.03.62-1.51.91.39-1.71.28-1.18-.91-.79L9.88 9.1l1.76-.15 1.2-.1.47-1.11.69-1.62.69 1.62.47 1.11 1.2.1 1.75.15-1.33 1.16-.92.79.28 1.18M1.16 12c-.299-.5-.171-1.11.29-1.41l2.73-1.8 1.57 1.36-3.2 2.11c-.17.11-.36.17-.55.17-.32 0-.64-.16-.84-.43m.29 8.16 5.86-3.85L7 17.76l-.34 1.37-4.11 2.71c-.17.11-.36.16-.55.16-.32 0-.64-.16-.84-.45a1.013 1.013 0 0 1 .29-1.39m5.87-8.66.92.81-.27 1.19-5.42 3.55c-.17.11-.36.16-.55.16-.32 0-.64-.15-.84-.45a1 1 0 0 1 .29-1.38l5.87-3.88Z"/></svg> <span class=md-ellipsis> Projections </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3_9> <label class=md-nav__link for=__nav_3_9 id=__nav_3_9_label tabindex> <span class=md-ellipsis> Cross-validation </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_9_label aria-expanded=false> <label class=md-nav__title for=__nav_3_9> <span class="md-nav__icon md-icon"></span> Cross-validation </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../tutorials/cross-validation/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M.41 13.41 6 19l1.41-1.42L1.83 12m20.41-6.42L11.66 16.17 7.5 12l-1.43 1.41L11.66 19l12-12M18 7l-1.41-1.42-6.35 6.35 1.42 1.41L18 7Z"/></svg> <span class=md-ellipsis> Cross-validation </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/cross-validation/splitter/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M.41 13.41 6 19l1.41-1.42L1.83 12m20.41-6.42L11.66 16.17 7.5 12l-1.43 1.41L11.66 19l12-12M18 7l-1.41-1.42-6.35 6.35 1.42 1.41L18 7Z"/></svg> <span class=md-ellipsis> Splitter </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/cross-validation/applications/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M.41 13.41 6 19l1.41-1.42L1.83 12m20.41-6.42L11.66 16.17 7.5 12l-1.43 1.41L11.66 19l12-12M18 7l-1.41-1.42-6.35 6.35 1.42 1.41L18 7Z"/></svg> <span class=md-ellipsis> Applications </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../../../tutorials/more-tutorials/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M10.6 13.4a1 1 0 0 1-1.4 1.4 4.8 4.8 0 0 1 0-7l3.5-3.6a5.1 5.1 0 0 1 7.1 0 5.1 5.1 0 0 1 0 7.1l-1.5 1.5a6.4 6.4 0 0 0-.4-2.4l.5-.5a3.2 3.2 0 0 0 0-4.3 3.2 3.2 0 0 0-4.3 0l-3.5 3.6a2.9 2.9 0 0 0 0 4.2M23 18v2h-3v3h-2v-3h-3v-2h3v-3h2v3m-3.8-4.3a4.8 4.8 0 0 0-1.4-4.5 1 1 0 0 0-1.4 1.4 2.9 2.9 0 0 1 0 4.2l-3.5 3.6a3.2 3.2 0 0 1-4.3 0 3.2 3.2 0 0 1 0-4.3l.5-.4a7.3 7.3 0 0 1-.4-2.5l-1.5 1.5a5.1 5.1 0 0 0 0 7.1 5.1 5.1 0 0 0 7.1 0l1.8-1.8a6 6 0 0 1 3.1-4.3Z"/></svg> <span class=md-ellipsis> More tutorials </span> </a> </li> <li class=md-nav__item> <a href=../../../../tutorials/to-be-continued/index.html class=md-nav__link> <span class=md-ellipsis> To be continued... </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_4> <label class=md-nav__link for=__nav_4 id=__nav_4_label tabindex> <span class=md-ellipsis> Documentation </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Documentation </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../documentation/fundamentals/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 7a2 2 0 0 0-2 2v8h2v-4h2v4h2V9a2 2 0 0 0-2-2H3m0 2h2v2H3m12-.5V9a2 2 0 0 0-2-2H9v10h4a2 2 0 0 0 2-2v-1.5a1.54 1.54 0 0 0-1.5-1.5 1.54 1.54 0 0 0 1.5-1.5M13 15h-2v-2h2v2m0-4h-2V9h2m6-2a2 2 0 0 0-2 2v6a2 2 0 0 0 2 2h2a2 2 0 0 0 2-2v-1h-2v1h-2V9h2v1h2V9a2 2 0 0 0-2-2Z"/></svg> <span class=md-ellipsis> Fundamentals </span> </a> </li> <li class=md-nav__item> <a href=../../../../documentation/building-blocks/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 16.5c0 .38-.21.71-.53.88l-7.9 4.44c-.16.12-.36.18-.57.18-.21 0-.41-.06-.57-.18l-7.9-4.44A.991.991 0 0 1 3 16.5v-9c0-.38.21-.71.53-.88l7.9-4.44c.16-.12.36-.18.57-.18.21 0 .41.06.57.18l7.9 4.44c.32.17.53.5.53.88v9M12 4.15 6.04 7.5 12 10.85l5.96-3.35L12 4.15M5 15.91l6 3.38v-6.71L5 9.21v6.7m14 0v-6.7l-6 3.37v6.71l6-3.38Z"/></svg> <span class=md-ellipsis> Building blocks </span> </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_4_3> <label class=md-nav__link for=__nav_4_3 id=__nav_4_3_label tabindex> <span class=md-ellipsis> Data </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_3_label aria-expanded=false> <label class=md-nav__title for=__nav_4_3> <span class="md-nav__icon md-icon"></span> Data </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../documentation/data/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 3C7.58 3 4 4.79 4 7s3.58 4 8 4 8-1.79 8-4-3.58-4-8-4M4 9v3c0 2.21 3.58 4 8 4s8-1.79 8-4V9c0 2.21-3.58 4-8 4s-8-1.79-8-4m0 5v3c0 2.21 3.58 4 8 4s8-1.79 8-4v-3c0 2.21-3.58 4-8 4s-8-1.79-8-4Z"/></svg> <span class=md-ellipsis> Data </span> </a> </li> <li class=md-nav__item> <a href=../../../../documentation/data/local/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 20H4a2 2 0 0 1-2-2V6c0-1.11.89-2 2-2h6l2 2h7a2 2 0 0 1 2 2H4v10l2.14-8h17.07l-2.28 8.5c-.23.87-1.01 1.5-1.93 1.5Z"/></svg> <span class=md-ellipsis> Local </span> </a> </li> <li class=md-nav__item> <a href=../../../../documentation/data/remote/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M16.36 14c.08-.66.14-1.32.14-2 0-.68-.06-1.34-.14-2h3.38c.16.64.26 1.31.26 2s-.1 1.36-.26 2m-5.15 5.56c.6-1.11 1.06-2.31 1.38-3.56h2.95a8.03 8.03 0 0 1-4.33 3.56M14.34 14H9.66c-.1-.66-.16-1.32-.16-2 0-.68.06-1.35.16-2h4.68c.09.65.16 1.32.16 2 0 .68-.07 1.34-.16 2M12 19.96c-.83-1.2-1.5-2.53-1.91-3.96h3.82c-.41 1.43-1.08 2.76-1.91 3.96M8 8H5.08A7.923 7.923 0 0 1 9.4 4.44C8.8 5.55 8.35 6.75 8 8m-2.92 8H8c.35 1.25.8 2.45 1.4 3.56A8.008 8.008 0 0 1 5.08 16m-.82-2C4.1 13.36 4 12.69 4 12s.1-1.36.26-2h3.38c-.08.66-.14 1.32-.14 2 0 .68.06 1.34.14 2M12 4.03c.83 1.2 1.5 2.54 1.91 3.97h-3.82c.41-1.43 1.08-2.77 1.91-3.97M18.92 8h-2.95a15.65 15.65 0 0 0-1.38-3.56c1.84.63 3.37 1.9 4.33 3.56M12 2C6.47 2 2 6.5 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2Z"/></svg> <span class=md-ellipsis> Remote </span> </a> </li> <li class=md-nav__item> <a href=../../../../documentation/data/synthetic/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m19 1-1.26 2.75L15 5l2.74 1.26L19 9l1.25-2.74L23 5l-2.75-1.25M9 4 6.5 9.5 1 12l5.5 2.5L9 20l2.5-5.5L17 12l-5.5-2.5M19 15l-1.26 2.74L15 19l2.74 1.25L19 23l1.25-2.75L23 19l-2.75-1.26"/></svg> <span class=md-ellipsis> Synthetic </span> </a> </li> <li class=md-nav__item> <a href=../../../../documentation/data/scheduling/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 20a7 7 0 0 1-7-7 7 7 0 0 1 7-7 7 7 0 0 1 7 7 7 7 0 0 1-7 7m7.03-12.61 1.42-1.42c-.45-.51-.9-.97-1.41-1.41L17.62 6c-1.55-1.26-3.5-2-5.62-2a9 9 0 0 0-9 9 9 9 0 0 0 9 9c5 0 9-4.03 9-9 0-2.12-.74-4.07-1.97-5.61M11 14h2V8h-2m4-7H9v2h6V1Z"/></svg> <span class=md-ellipsis> Scheduling </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_4_4> <label class=md-nav__link for=__nav_4_4 id=__nav_4_4_label tabindex> <span class=md-ellipsis> Indicators </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4_4> <span class="md-nav__icon md-icon"></span> Indicators </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../documentation/indicators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m3 14 .5.07L8.07 9.5a1.95 1.95 0 0 1 .52-1.91c.78-.79 2.04-.79 2.82 0 .53.52.7 1.26.52 1.91l2.57 2.57.5-.07c.18 0 .35 0 .5.07l3.57-3.57C19 8.35 19 8.18 19 8a2 2 0 0 1 2-2 2 2 0 0 1 2 2 2 2 0 0 1-2 2c-.18 0-.35 0-.5-.07l-3.57 3.57c.07.15.07.32.07.5a2 2 0 0 1-2 2 2 2 0 0 1-2-2l.07-.5-2.57-2.57c-.32.07-.68.07-1 0L4.93 15.5 5 16a2 2 0 0 1-2 2 2 2 0 0 1-2-2 2 2 0 0 1 2-2Z"/></svg> <span class=md-ellipsis> Indicators </span> </a> </li> <li class=md-nav__item> <a href=../../../../documentation/indicators/development/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 3c-1.11 0-2 .89-2 2v4c0 1.11.89 2 2 2h4c1.11 0 2-.89 2-2V5c0-1.11-.89-2-2-2m.2 1.5 1.06 1.05L5.27 9.5 2.74 6.95 3.81 5.9l1.47 1.49M4 13c-1.11 0-2 .89-2 2v4c0 1.11.89 2 2 2h4c1.11 0 2-.89 2-2v-4c0-1.11-.89-2-2-2m-4 2h4v4H4m8-14h10v2H12m0 12v-2h10v2m-10-8h10v2H12Z"/></svg> <span class=md-ellipsis> Development </span> </a> </li> <li class=md-nav__item> <a href=../../../../documentation/indicators/analysis/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 8c-1.5 0-2.3 1.4-1.9 2.5l-3.6 3.6c-.3-.1-.7-.1-1 0l-2.6-2.6c.4-1.1-.4-2.5-1.9-2.5-1.4 0-2.3 1.4-1.9 2.5L3.5 16c-1.1-.3-2.5.5-2.5 2 0 1.1.9 2 2 2 1.4 0 2.3-1.4 1.9-2.5l4.5-4.6c.3.1.7.1 1 0l2.6 2.6c-.3 1 .5 2.5 2 2.5s2.3-1.4 1.9-2.5l3.6-3.6c1.1.3 2.5-.5 2.5-1.9 0-1.1-.9-2-2-2m-6 1 .9-2.1L18 6l-2.1-.9L15 3l-.9 2.1L12 6l2.1.9L15 9M3.5 11 4 9l2-.5L4 8l-.5-2L3 8l-2 .5L3 9l.5 2Z"/></svg> <span class=md-ellipsis> Analysis </span> </a> </li> <li class=md-nav__item> <a href=../../../../documentation/indicators/parsers/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m14.6 16.6 4.6-4.6-4.6-4.6L16 6l6 6-6 6-1.4-1.4m-5.2 0L4.8 12l4.6-4.6L8 6l-6 6 6 6 1.4-1.4Z"/></svg> <span class=md-ellipsis> Parsers </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_4_5> <label class=md-nav__link for=__nav_4_5 id=__nav_4_5_label tabindex> <span class=md-ellipsis> Portfolio </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_5_label aria-expanded=false> <label class=md-nav__title for=__nav_4_5> <span class="md-nav__icon md-icon"></span> Portfolio </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../documentation/portfolio/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17.45 15.18 22 7.31V21H2V3h2v12.54L9.5 6 16 9.78l4.24-7.33 1.73 1-5.23 9.05-6.51-3.75L4.31 19h2.26l4.39-7.56 6.49 3.74Z"/></svg> <span class=md-ellipsis> Portfolio </span> </a> </li> <li class=md-nav__item> <a href=../../../../documentation/portfolio/from-orders/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 2v20h20V2H2m18 10h-4v4h4v4h-4v-4h-4v4H8v-4H4v-4h4V8H4V4h4v4h4V4h4v4h4v4m-4-4v4h-4V8h4m-4 4v4H8v-4h4Z"/></svg> <span class=md-ellipsis> From orders </span> </a> </li> <li class=md-nav__item> <a href=../../../../documentation/portfolio/from-signals/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 10c-1.1 0-2 .9-2 2s.9 2 2 2 2-.9 2-2-.9-2-2-2m6 2c0-3.3-2.7-6-6-6s-6 2.7-6 6c0 2.2 1.2 4.1 3 5.2l1-1.7c-1.2-.7-2-2-2-3.4 0-2.2 1.8-4 4-4s4 1.8 4 4c0 1.5-.8 2.8-2 3.4l1 1.7c1.8-1 3-3 3-5.2M12 2C6.5 2 2 6.5 2 12c0 3.7 2 6.9 5 8.6l1-1.7c-2.4-1.4-4-4-4-6.9 0-4.4 3.6-8 8-8s8 3.6 8 8c0 3-1.6 5.5-4 6.9l1 1.7c3-1.7 5-4.9 5-8.6 0-5.5-4.5-10-10-10Z"/></svg> <span class=md-ellipsis> From signals </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../../../documentation/to-be-continued/index.html class=md-nav__link> <span class=md-ellipsis> To be continued... </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5 checked> <label class=md-nav__link for=__nav_5 id=__nav_5_label tabindex> <span class=md-ellipsis> API </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_5_label aria-expanded=true> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> API </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../index.html class=md-nav__link> <span class=md-ellipsis> API </span> </a> </li> <li class=md-nav__item> <a href=../../../_settings/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M6 2c-1.11 0-2 .89-2 2v16a2 2 0 0 0 2 2h6.68a7 7 0 0 1-.68-3 7 7 0 0 1 7-7 7 7 0 0 1 1 .08V8l-6-6H6m7 1.5L18.5 9H13V3.5M18 14a.26.26 0 0 0-.26.21l-.19 1.32c-.3.13-.59.29-.85.47l-1.24-.5c-.11 0-.24 0-.31.13l-1 1.73c-.06.11-.04.24.06.32l1.06.82a4.193 4.193 0 0 0 0 1l-1.06.82a.26.26 0 0 0-.06.32l1 1.73c.06.13.19.13.31.13l1.24-.5c.26.18.54.35.85.47l.19 1.32c.02.12.12.21.26.21h2c.11 0 .22-.09.24-.21l.19-1.32c.3-.13.57-.29.84-.47l1.23.5c.13 0 .26 0 .33-.13l1-1.73a.26.26 0 0 0-.06-.32l-1.07-.82c.02-.17.04-.33.04-.5 0-.17-.01-.33-.04-.5l1.06-.82a.26.26 0 0 0 .06-.32l-1-1.73c-.06-.13-.19-.13-.32-.13l-1.23.5c-.27-.18-.54-.35-.85-.47l-.19-1.32A.236.236 0 0 0 20 14h-2m1 3.5c.83 0 1.5.67 1.5 1.5s-.67 1.5-1.5 1.5c-.84 0-1.5-.67-1.5-1.5s.67-1.5 1.5-1.5Z"/></svg> <span class=md-ellipsis> _settings </span> </a> </li> <li class=md-nav__item> <a href=../../../_opt_deps/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M6 2c-1.11 0-2 .89-2 2v16a2 2 0 0 0 2 2h6.68a7 7 0 0 1-.68-3 7 7 0 0 1 7-7 7 7 0 0 1 1 .08V8l-6-6H6m7 1.5L18.5 9H13V3.5M18 14a.26.26 0 0 0-.26.21l-.19 1.32c-.3.13-.59.29-.85.47l-1.24-.5c-.11 0-.24 0-.31.13l-1 1.73c-.06.11-.04.24.06.32l1.06.82a4.193 4.193 0 0 0 0 1l-1.06.82a.26.26 0 0 0-.06.32l1 1.73c.06.13.19.13.31.13l1.24-.5c.26.18.54.35.85.47l.19 1.32c.02.12.12.21.26.21h2c.11 0 .22-.09.24-.21l.19-1.32c.3-.13.57-.29.84-.47l1.23.5c.13 0 .26 0 .33-.13l1-1.73a.26.26 0 0 0-.06-.32l-1.07-.82c.02-.17.04-.33.04-.5 0-.17-.01-.33-.04-.5l1.06-.82a.26.26 0 0 0 .06-.32l-1-1.73c-.06-.13-.19-.13-.32-.13l-1.23.5c-.27-.18-.54-.35-.85-.47l-.19-1.32A.236.236 0 0 0 20 14h-2m1 3.5c.83 0 1.5.67 1.5 1.5s-.67 1.5-1.5 1.5c-.84 0-1.5-.67-1.5-1.5s.67-1.5 1.5-1.5Z"/></svg> <span class=md-ellipsis> _opt_deps </span> </a> </li> <li class=md-nav__item> <a href=../../../accessors/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 5H8l4-4 4 4h-3v4.43c-.75.46-1.42 1.03-2 1.69V5m11 6-4-4v3a6.747 6.747 0 0 0-7 6.17A3.006 3.006 0 0 0 9.17 20 3.006 3.006 0 0 0 13 21.83 3.01 3.01 0 0 0 14.83 18c-.3-.86-.98-1.53-1.83-1.83.47-4 4.47-4.2 4.95-4.2v3L22 11m-11.37.59A7.632 7.632 0 0 0 6 10V7l-4 4 4 4v-3c1.34.03 2.63.5 3.64 1.4.25-.64.58-1.25.99-1.81Z"/></svg> <span class=md-ellipsis> accessors </span> </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_5> <label class=md-nav__link for=__nav_5_5 id=__nav_5_5_label tabindex> <span class=md-ellipsis> base </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5_5> <span class="md-nav__icon md-icon"></span> base </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../base/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3M4 5h2v2H4m14 0h2v2h-2M8 17h2v2H8Z"/></svg> <span class=md-ellipsis> base </span> </a> </li> <li class=md-nav__item> <a href=../../../base/accessors/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 5H8l4-4 4 4h-3v4.43c-.75.46-1.42 1.03-2 1.69V5m11 6-4-4v3a6.747 6.747 0 0 0-7 6.17A3.006 3.006 0 0 0 9.17 20 3.006 3.006 0 0 0 13 21.83 3.01 3.01 0 0 0 14.83 18c-.3-.86-.98-1.53-1.83-1.83.47-4 4.47-4.2 4.95-4.2v3L22 11m-11.37.59A7.632 7.632 0 0 0 6 10V7l-4 4 4 4v-3c1.34.03 2.63.5 3.64 1.4.25-.64.58-1.25.99-1.81Z"/></svg> <span class=md-ellipsis> accessors </span> </a> </li> <li class=md-nav__item> <a href=../../../base/chunking/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16v-3h-3v9h-2V2h2v9h3V8l4 4-4 4M2 12l4 4v-3h3v9h2V2H9v9H6V8l-4 4Z"/></svg> <span class=md-ellipsis> chunking </span> </a> </li> <li class=md-nav__item> <a href=../../../base/combining/index.html class=md-nav__link> <span class=md-ellipsis> combining </span> </a> </li> <li class=md-nav__item> <a href=../../../base/decorators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3H2m2 2h2v2H4V5m14 2h2v2h-2V7m0 8v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2M8 17h2v2H8v-2Z"/></svg> <span class=md-ellipsis> decorators </span> </a> </li> <li class=md-nav__item> <a href=../../../base/flex_indexing/index.html class=md-nav__link> <span class=md-ellipsis> flex_indexing </span> </a> </li> <li class=md-nav__item> <a href=../../../base/indexes/index.html class=md-nav__link> <span class=md-ellipsis> indexes <span class=dobjtype>module</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/base/indexes.py target=_blank title="Jump to source"><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></a> </span> </a> </li> <li class=md-nav__item> <a href=../../../base/indexing/index.html class=md-nav__link> <span class=md-ellipsis> indexing </span> </a> </li> <li class=md-nav__item> <a href=../../../base/merging/index.html class=md-nav__link> <span class=md-ellipsis> merging </span> </a> </li> <li class=md-nav__item> <a href=../../../base/preparing/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 4V3a1 1 0 0 0-1-1H5a1 1 0 0 0-1 1v4a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1V6h1v4H9v11a1 1 0 0 0 1 1h2a1 1 0 0 0 1-1v-9h8V4h-3Z"/></svg> <span class=md-ellipsis> preparing </span> </a> </li> <li class=md-nav__item> <a href=../../../base/reshaping/index.html class=md-nav__link> <span class=md-ellipsis> reshaping </span> </a> </li> <li class=md-nav__item> <a href=../../../base/wrapping/index.html class=md-nav__link> <span class=md-ellipsis> wrapping </span> </a> </li> <li class="md-nav__item md-nav__item--pruned md-nav__item--nested"> <a href=../../../base/grouping/index.html class=md-nav__link> <span class=md-ellipsis> grouping </span> <span class="md-nav__icon md-icon"></span> </a> </li> <li class="md-nav__item md-nav__item--pruned md-nav__item--nested"> <a href=../../../base/resampling/index.html class=md-nav__link> <span class=md-ellipsis> resampling </span> <span class="md-nav__icon md-icon"></span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_6> <label class=md-nav__link for=__nav_5_6 id=__nav_5_6_label tabindex> <span class=md-ellipsis> data </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_6_label aria-expanded=false> <label class=md-nav__title for=__nav_5_6> <span class="md-nav__icon md-icon"></span> data </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../data/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 3C7.58 3 4 4.79 4 7s3.58 4 8 4 8-1.79 8-4-3.58-4-8-4M4 9v3c0 2.21 3.58 4 8 4s8-1.79 8-4V9c0 2.21-3.58 4-8 4s-8-1.79-8-4m0 5v3c0 2.21 3.58 4 8 4s8-1.79 8-4v-3c0 2.21-3.58 4-8 4s-8-1.79-8-4Z"/></svg> <span class=md-ellipsis> data </span> </a> </li> <li class=md-nav__item> <a href=../../../data/base/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3M4 5h2v2H4m14 0h2v2h-2M8 17h2v2H8Z"/></svg> <span class=md-ellipsis> base </span> </a> </li> <li class=md-nav__item> <a href=../../../data/decorators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3H2m2 2h2v2H4V5m14 2h2v2h-2V7m0 8v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2M8 17h2v2H8v-2Z"/></svg> <span class=md-ellipsis> decorators </span> </a> </li> <li class=md-nav__item> <a href=../../../data/nb/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m6 20 4.16-12.09L9.34 6H8V4h2c.42 0 .78.26.93.63L16.66 18H18v2h-2c-.43 0-.79-.27-.93-.64l-3.74-8.71L8.12 20H6Z"/></svg> <span class=md-ellipsis> nb </span> </a> </li> <li class=md-nav__item> <a href=../../../data/saver/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 20a7 7 0 0 1-7-7 7 7 0 0 1 7-7 7 7 0 0 1 7 7 7 7 0 0 1-7 7m7.03-12.61 1.42-1.42c-.45-.51-.9-.97-1.41-1.41L17.62 6c-1.55-1.26-3.5-2-5.62-2a9 9 0 0 0-9 9 9 9 0 0 0 9 9c5 0 9-4.03 9-9 0-2.12-.74-4.07-1.97-5.61M11 14h2V8h-2m4-7H9v2h6V1Z"/></svg> <span class=md-ellipsis> saver </span> </a> </li> <li class=md-nav__item> <a href=../../../data/updater/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 20a7 7 0 0 1-7-7 7 7 0 0 1 7-7 7 7 0 0 1 7 7 7 7 0 0 1-7 7m7.03-12.61 1.42-1.42c-.45-.51-.9-.97-1.41-1.41L17.62 6c-1.55-1.26-3.5-2-5.62-2a9 9 0 0 0-9 9 9 9 0 0 0 9 9c5 0 9-4.03 9-9 0-2.12-.74-4.07-1.97-5.61M11 14h2V8h-2m4-7H9v2h6V1Z"/></svg> <span class=md-ellipsis> updater </span> </a> </li> <li class="md-nav__item md-nav__item--pruned md-nav__item--nested"> <a href=../../../data/custom/index.html class=md-nav__link> <span class=md-ellipsis> custom </span> <span class="md-nav__icon md-icon"></span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_7 checked> <label class=md-nav__link for=__nav_5_7 id=__nav_5_7_label tabindex> <span class=md-ellipsis> generic </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_7_label aria-expanded=true> <label class=md-nav__title for=__nav_5_7> <span class="md-nav__icon md-icon"></span> generic </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 2h4v2H4v16h2v2H2V2m18 2h-2V2h4v20h-4v-2h2V4M9 5h1v5h1v1H8v-1h1V6l-1 .5v-1L9 5m6 8h1v5h1v1h-3v-1h1v-4l-1 .5v-1l1-.5m-6 0c1.1 0 2 1.34 2 3s-.9 3-2 3-2-1.34-2-3 .9-3 2-3m0 1c-.55 0-1 .9-1 2s.45 2 1 2 1-.9 1-2-.45-2-1-2m6-9c1.1 0 2 1.34 2 3s-.9 3-2 3-2-1.34-2-3 .9-3 2-3m0 1c-.55 0-1 .9-1 2s.45 2 1 2 1-.9 1-2-.45-2-1-2Z"/></svg> <span class=md-ellipsis> generic </span> </a> </li> <li class=md-nav__item> <a href=../../accessors/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 5H8l4-4 4 4h-3v4.43c-.75.46-1.42 1.03-2 1.69V5m11 6-4-4v3a6.747 6.747 0 0 0-7 6.17A3.006 3.006 0 0 0 9.17 20 3.006 3.006 0 0 0 13 21.83 3.01 3.01 0 0 0 14.83 18c-.3-.86-.98-1.53-1.83-1.83.47-4 4.47-4.2 4.95-4.2v3L22 11m-11.37.59A7.632 7.632 0 0 0 6 10V7l-4 4 4 4v-3c1.34.03 2.63.5 3.64 1.4.25-.64.58-1.25.99-1.81Z"/></svg> <span class=md-ellipsis> accessors </span> </a> </li> <li class=md-nav__item> <a href=../../analyzable/index.html class=md-nav__link> <span class=md-ellipsis> analyzable </span> </a> </li> <li class=md-nav__item> <a href=../../decorators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3H2m2 2h2v2H4V5m14 2h2v2h-2V7m0 8v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2M8 17h2v2H8v-2Z"/></svg> <span class=md-ellipsis> decorators </span> </a> </li> <li class=md-nav__item> <a href=../../drawdowns/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M8 2h8a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2m0 8v4h8v-4H8m0 6v4h8v-4H8M8 4v4h8V4H8Z"/></svg> <span class=md-ellipsis> drawdowns </span> </a> </li> <li class=md-nav__item> <a href=../../enums/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M5 3h2v2H5v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5h2v2H5c-1.07-.27-2-.9-2-2v-4a2 2 0 0 0-2-2H0v-2h1a2 2 0 0 0 2-2V5a2 2 0 0 1 2-2m14 0a2 2 0 0 1 2 2v4a2 2 0 0 0 2 2h1v2h-1a2 2 0 0 0-2 2v4a2 2 0 0 1-2 2h-2v-2h2v-5a2 2 0 0 1 2-2 2 2 0 0 1-2-2V5h-2V3h2m-7 12a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m-4 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m8 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1Z"/></svg> <span class=md-ellipsis> enums </span> </a> </li> <li class=md-nav__item> <a href=../../plots_builder/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13.04 19.61a2.682 2.682 0 0 0-2.54-1.81c-1.5 0-2.7 1.2-2.7 2.7V22H4a2 2 0 0 1-2-2v-3.8h1.5c1.5 0 2.7-1.2 2.7-2.7S5 10.8 3.5 10.8H2V7c0-1.1.9-2 2-2h4V3.5a2.5 2.5 0 0 1 5 0V5h4a2 2 0 0 1 2 2v4h1.5a2.5 2.5 0 0 1 2.5 2.5c0 .32-.06.62-.17.89A5.991 5.991 0 0 0 19 13c-3.31 0-6 2.69-6 6 0 .2 0 .41.04.61M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2Z"/></svg> <span class=md-ellipsis> plots_builder </span> </a> </li> <li class=md-nav__item> <a href=../../plotting/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M7.2 11.2c1.77 0 3.2 1.43 3.2 3.2 0 1.77-1.43 3.2-3.2 3.2-1.77 0-3.2-1.43-3.2-3.2 0-1.77 1.43-3.2 3.2-3.2m7.6 4.8a2 2 0 0 1 2 2 2 2 0 0 1-2 2 2 2 0 0 1-2-2 2 2 0 0 1 2-2m.4-12A4.8 4.8 0 0 1 20 8.8c0 2.65-2.15 4.8-4.8 4.8a4.8 4.8 0 0 1-4.8-4.8c0-2.65 2.15-4.8 4.8-4.8Z"/></svg> <span class=md-ellipsis> plotting </span> </a> </li> <li class=md-nav__item> <a href=../../price_records/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M8 2h8a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2m0 8v4h8v-4H8m0 6v4h8v-4H8M8 4v4h8V4H8Z"/></svg> <span class=md-ellipsis> price_records </span> </a> </li> <li class=md-nav__item> <a href=../../ranges/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M8 2h8a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2m0 8v4h8v-4H8m0 6v4h8v-4H8M8 4v4h8V4H8Z"/></svg> <span class=md-ellipsis> ranges </span> </a> </li> <li class=md-nav__item> <a href=../../stats_builder/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13.04 19.61a2.682 2.682 0 0 0-2.54-1.81c-1.5 0-2.7 1.2-2.7 2.7V22H4a2 2 0 0 1-2-2v-3.8h1.5c1.5 0 2.7-1.2 2.7-2.7S5 10.8 3.5 10.8H2V7c0-1.1.9-2 2-2h4V3.5a2.5 2.5 0 0 1 5 0V5h4a2 2 0 0 1 2 2v4h1.5a2.5 2.5 0 0 1 2.5 2.5c0 .32-.06.62-.17.89A5.991 5.991 0 0 0 19 13c-3.31 0-6 2.69-6 6 0 .2 0 .41.04.61M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2Z"/></svg> <span class=md-ellipsis> stats_builder </span> </a> </li> <li class="md-nav__item md-nav__item--pruned md-nav__item--nested"> <a href=../../nb/index.html class=md-nav__link> <span class=md-ellipsis> nb </span> <span class="md-nav__icon md-icon"></span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_7_13 checked> <label class=md-nav__link for=__nav_5_7_13 id=__nav_5_7_13_label tabindex=0> <span class=md-ellipsis> splitting </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=3 aria-labelledby=__nav_5_7_13_label aria-expanded=true> <label class=md-nav__title for=__nav_5_7_13> <span class="md-nav__icon md-icon"></span> splitting </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 14h2v6H3v-6h2v4h14v-4M3 4v6h2V6h14v4h2V4H3m8 7v2H8v2l-3-3 3-3v2h3m5 0V9l3 3-3 3v-2h-3v-2h3Z"/></svg> <span class=md-ellipsis> splitting </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3M4 5h2v2H4m14 0h2v2h-2M8 17h2v2H8Z"/></svg> <span class=md-ellipsis> base </span> <span class="md-nav__icon md-icon"></span> </label> <a href=index.html class="md-nav__link md-nav__link--active"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3M4 5h2v2H4m14 0h2v2h-2M8 17h2v2H8Z"/></svg> <span class=md-ellipsis> base </span> </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.FixRange class=md-nav__link> <span class=md-ellipsis> FixRange() </span> </a> <nav class=md-nav aria-label=FixRange()> <ul class=md-nav__list> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.FixRange.range_ class=md-nav__link> <span class=md-ellipsis> range_ </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.RelRange class=md-nav__link> <span class=md-ellipsis> RelRange() </span> </a> <nav class=md-nav aria-label=RelRange()> <ul class=md-nav__list> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.RelRange.is_gap class=md-nav__link> <span class=md-ellipsis> is_gap </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.RelRange.length class=md-nav__link> <span class=md-ellipsis> length </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.RelRange.length_space class=md-nav__link> <span class=md-ellipsis> length_space </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.RelRange.offset class=md-nav__link> <span class=md-ellipsis> offset </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.RelRange.offset_anchor class=md-nav__link> <span class=md-ellipsis> offset_anchor </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.RelRange.offset_space class=md-nav__link> <span class=md-ellipsis> offset_space </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.RelRange.out_of_bounds class=md-nav__link> <span class=md-ellipsis> out_of_bounds </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.RelRange.to_slice class=md-nav__link> <span class=md-ellipsis> to_slice() </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.SKLSplitter class=md-nav__link> <span class=md-ellipsis> SKLSplitter() </span> </a> <nav class=md-nav aria-label=SKLSplitter()> <ul class=md-nav__list> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.SKLSplitter.get_n_splits class=md-nav__link> <span class=md-ellipsis> get_n_splits() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.SKLSplitter.get_splitter class=md-nav__link> <span class=md-ellipsis> get_splitter() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.SKLSplitter.split class=md-nav__link> <span class=md-ellipsis> split() </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter class=md-nav__link> <span class=md-ellipsis> Splitter() </span> </a> <nav class=md-nav aria-label=Splitter()> <ul class=md-nav__list> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.apply class=md-nav__link> <span class=md-ellipsis> apply() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.bounds class=md-nav__link> <span class=md-ellipsis> bounds </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.bounds_arr class=md-nav__link> <span class=md-ellipsis> bounds_arr </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.break_up_splits class=md-nav__link> <span class=md-ellipsis> break_up_splits() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.column_stack class=md-nav__link> <span class=md-ellipsis> column_stack() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.coverage class=md-nav__link> <span class=md-ellipsis> coverage </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.duration class=md-nav__link> <span class=md-ellipsis> duration </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.from_expanding class=md-nav__link> <span class=md-ellipsis> from_expanding() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.from_grouper class=md-nav__link> <span class=md-ellipsis> from_grouper() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.from_n_expanding class=md-nav__link> <span class=md-ellipsis> from_n_expanding() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.from_n_random class=md-nav__link> <span class=md-ellipsis> from_n_random() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.from_n_rolling class=md-nav__link> <span class=md-ellipsis> from_n_rolling() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.from_ranges class=md-nav__link> <span class=md-ellipsis> from_ranges() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.from_rolling class=md-nav__link> <span class=md-ellipsis> from_rolling() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.from_single class=md-nav__link> <span class=md-ellipsis> from_single() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.from_sklearn class=md-nav__link> <span class=md-ellipsis> from_sklearn() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.from_split_func class=md-nav__link> <span class=md-ellipsis> from_split_func() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.from_splits class=md-nav__link> <span class=md-ellipsis> from_splits() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_bounds class=md-nav__link> <span class=md-ellipsis> get_bounds() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_bounds_arr class=md-nav__link> <span class=md-ellipsis> get_bounds_arr() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_coverage class=md-nav__link> <span class=md-ellipsis> get_coverage() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_duration class=md-nav__link> <span class=md-ellipsis> get_duration() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_iter_set_mask_arrs class=md-nav__link> <span class=md-ellipsis> get_iter_set_mask_arrs() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_iter_set_masks class=md-nav__link> <span class=md-ellipsis> get_iter_set_masks() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_iter_split_mask_arrs class=md-nav__link> <span class=md-ellipsis> get_iter_split_mask_arrs() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_iter_split_masks class=md-nav__link> <span class=md-ellipsis> get_iter_split_masks() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_mask class=md-nav__link> <span class=md-ellipsis> get_mask() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_mask_arr class=md-nav__link> <span class=md-ellipsis> get_mask_arr() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_n_sets class=md-nav__link> <span class=md-ellipsis> get_n_sets() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_n_splits class=md-nav__link> <span class=md-ellipsis> get_n_splits() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_obj_index class=md-nav__link> <span class=md-ellipsis> get_obj_index() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_overlap_matrix class=md-nav__link> <span class=md-ellipsis> get_overlap_matrix() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_range_bounds class=md-nav__link> <span class=md-ellipsis> get_range_bounds() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_range_coverage class=md-nav__link> <span class=md-ellipsis> get_range_coverage() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_range_mask class=md-nav__link> <span class=md-ellipsis> get_range_mask() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_ready_obj_range class=md-nav__link> <span class=md-ellipsis> get_ready_obj_range() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_ready_range class=md-nav__link> <span class=md-ellipsis> get_ready_range() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_set_coverage class=md-nav__link> <span class=md-ellipsis> get_set_coverage() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_set_grouper class=md-nav__link> <span class=md-ellipsis> get_set_grouper() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_set_labels class=md-nav__link> <span class=md-ellipsis> get_set_labels() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_split_coverage class=md-nav__link> <span class=md-ellipsis> get_split_coverage() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_split_grouper class=md-nav__link> <span class=md-ellipsis> get_split_grouper() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.get_split_labels class=md-nav__link> <span class=md-ellipsis> get_split_labels() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.index class=md-nav__link> <span class=md-ellipsis> index </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.index_bounds class=md-nav__link> <span class=md-ellipsis> index_bounds </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.index_duration class=md-nav__link> <span class=md-ellipsis> index_duration </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.indexing_func class=md-nav__link> <span class=md-ellipsis> indexing_func() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.indexing_func_meta class=md-nav__link> <span class=md-ellipsis> indexing_func_meta() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.is_range_relative class=md-nav__link> <span class=md-ellipsis> is_range_relative() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.iter_set_mask_arrs class=md-nav__link> <span class=md-ellipsis> iter_set_mask_arrs </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.iter_set_masks class=md-nav__link> <span class=md-ellipsis> iter_set_masks </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.iter_split_mask_arrs class=md-nav__link> <span class=md-ellipsis> iter_split_mask_arrs </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.iter_split_masks class=md-nav__link> <span class=md-ellipsis> iter_split_masks </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.map_bounds_to_index class=md-nav__link> <span class=md-ellipsis> map_bounds_to_index() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.mask class=md-nav__link> <span class=md-ellipsis> mask </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.mask_arr class=md-nav__link> <span class=md-ellipsis> mask_arr </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.merge_sets class=md-nav__link> <span class=md-ellipsis> merge_sets() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.merge_split class=md-nav__link> <span class=md-ellipsis> merge_split() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.metrics class=md-nav__link> <span class=md-ellipsis> metrics </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.n_sets class=md-nav__link> <span class=md-ellipsis> n_sets </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.n_splits class=md-nav__link> <span class=md-ellipsis> n_splits </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.parse_and_inject_takeables class=md-nav__link> <span class=md-ellipsis> parse_and_inject_takeables() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.plot class=md-nav__link> <span class=md-ellipsis> plot() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.plot_coverage class=md-nav__link> <span class=md-ellipsis> plot_coverage() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.plots_defaults class=md-nav__link> <span class=md-ellipsis> plots_defaults </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.range_coverage class=md-nav__link> <span class=md-ellipsis> range_coverage </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.range_overlap_matrix class=md-nav__link> <span class=md-ellipsis> range_overlap_matrix </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.remap_range class=md-nav__link> <span class=md-ellipsis> remap_range() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.resolve_column_stack_kwargs class=md-nav__link> <span class=md-ellipsis> resolve_column_stack_kwargs() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.resolve_row_stack_kwargs class=md-nav__link> <span class=md-ellipsis> resolve_row_stack_kwargs() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.row_stack class=md-nav__link> <span class=md-ellipsis> row_stack() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.select_indices class=md-nav__link> <span class=md-ellipsis> select_indices() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.select_range class=md-nav__link> <span class=md-ellipsis> select_range() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.set_coverage class=md-nav__link> <span class=md-ellipsis> set_coverage </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.set_labels class=md-nav__link> <span class=md-ellipsis> set_labels </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.set_overlap_matrix class=md-nav__link> <span class=md-ellipsis> set_overlap_matrix </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.shuffle_splits class=md-nav__link> <span class=md-ellipsis> shuffle_splits() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.split_coverage class=md-nav__link> <span class=md-ellipsis> split_coverage </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.split_labels class=md-nav__link> <span class=md-ellipsis> split_labels </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.split_overlap_matrix class=md-nav__link> <span class=md-ellipsis> split_overlap_matrix </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.split_range class=md-nav__link> <span class=md-ellipsis> split_range() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.split_set class=md-nav__link> <span class=md-ellipsis> split_set() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.splits class=md-nav__link> <span class=md-ellipsis> splits </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.splits_arr class=md-nav__link> <span class=md-ellipsis> splits_arr </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.stats_defaults class=md-nav__link> <span class=md-ellipsis> stats_defaults </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.subplots class=md-nav__link> <span class=md-ellipsis> subplots </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.take class=md-nav__link> <span class=md-ellipsis> take() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.take_range class=md-nav__link> <span class=md-ellipsis> take_range() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.to_fixed class=md-nav__link> <span class=md-ellipsis> to_fixed() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Splitter.to_grouped class=md-nav__link> <span class=md-ellipsis> to_grouped() </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Takeable class=md-nav__link> <span class=md-ellipsis> Takeable() </span> </a> <nav class=md-nav aria-label=Takeable()> <ul class=md-nav__list> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Takeable.check_obj class=md-nav__link> <span class=md-ellipsis> check_obj() </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Takeable.freq class=md-nav__link> <span class=md-ellipsis> freq </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Takeable.index class=md-nav__link> <span class=md-ellipsis> index </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Takeable.obj class=md-nav__link> <span class=md-ellipsis> obj </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Takeable.point_wise class=md-nav__link> <span class=md-ellipsis> point_wise </span> </a> </li> <li class=md-nav__item> <a href=#vectorbtpro.generic.splitting.base.Takeable.remap_to_obj class=md-nav__link> <span class=md-ellipsis> remap_to_obj </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../decorators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3H2m2 2h2v2H4V5m14 2h2v2h-2V7m0 8v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2M8 17h2v2H8v-2Z"/></svg> <span class=md-ellipsis> decorators </span> </a> </li> <li class=md-nav__item> <a href=../nb/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m6 20 4.16-12.09L9.34 6H8V4h2c.42 0 .78.26.93.63L16.66 18H18v2h-2c-.43 0-.79-.27-.93-.64l-3.74-8.71L8.12 20H6Z"/></svg> <span class=md-ellipsis> nb </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_8> <label class=md-nav__link for=__nav_5_8 id=__nav_5_8_label tabindex> <span class=md-ellipsis> indicators </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_8_label aria-expanded=false> <label class=md-nav__title for=__nav_5_8> <span class="md-nav__icon md-icon"></span> indicators </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../indicators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m3 14 .5.07L8.07 9.5a1.95 1.95 0 0 1 .52-1.91c.78-.79 2.04-.79 2.82 0 .53.52.7 1.26.52 1.91l2.57 2.57.5-.07c.18 0 .35 0 .5.07l3.57-3.57C19 8.35 19 8.18 19 8a2 2 0 0 1 2-2 2 2 0 0 1 2 2 2 2 0 0 1-2 2c-.18 0-.35 0-.5-.07l-3.57 3.57c.07.15.07.32.07.5a2 2 0 0 1-2 2 2 2 0 0 1-2-2l.07-.5-2.57-2.57c-.32.07-.68.07-1 0L4.93 15.5 5 16a2 2 0 0 1-2 2 2 2 0 0 1-2-2 2 2 0 0 1 2-2Z"/></svg> <span class=md-ellipsis> indicators </span> </a> </li> <li class=md-nav__item> <a href=../../../indicators/configs/index.html class=md-nav__link> <span class=md-ellipsis> configs </span> </a> </li> <li class=md-nav__item> <a href=../../../indicators/enums/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M5 3h2v2H5v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5h2v2H5c-1.07-.27-2-.9-2-2v-4a2 2 0 0 0-2-2H0v-2h1a2 2 0 0 0 2-2V5a2 2 0 0 1 2-2m14 0a2 2 0 0 1 2 2v4a2 2 0 0 0 2 2h1v2h-1a2 2 0 0 0-2 2v4a2 2 0 0 1-2 2h-2v-2h2v-5a2 2 0 0 1 2-2 2 2 0 0 1-2-2V5h-2V3h2m-7 12a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m-4 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m8 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1Z"/></svg> <span class=md-ellipsis> enums </span> </a> </li> <li class=md-nav__item> <a href=../../../indicators/expr/index.html class=md-nav__link> <span class=md-ellipsis> expr </span> </a> </li> <li class=md-nav__item> <a href=../../../indicators/factory/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 18v2h4v-2H4m0-4v2h10v-2H4m6 4v2h4v-2h-4m6-4v2h4v-2h-4m0 4v2h4v-2h-4M2 22V8l5 4V8l5 4V8l5 4 1-10h3l1 10v10H2Z"/></svg> <span class=md-ellipsis> factory </span> </a> </li> <li class=md-nav__item> <a href=../../../indicators/nb/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m6 20 4.16-12.09L9.34 6H8V4h2c.42 0 .78.26.93.63L16.66 18H18v2h-2c-.43 0-.79-.27-.93-.64l-3.74-8.71L8.12 20H6Z"/></svg> <span class=md-ellipsis> nb </span> </a> </li> <li class=md-nav__item> <a href=../../../indicators/talib_/index.html class=md-nav__link> <span class=md-ellipsis> talib_ </span> </a> </li> <li class="md-nav__item md-nav__item--pruned md-nav__item--nested"> <a href=../../../indicators/custom/index.html class=md-nav__link> <span class=md-ellipsis> custom </span> <span class="md-nav__icon md-icon"></span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_9> <label class=md-nav__link for=__nav_5_9 id=__nav_5_9_label tabindex> <span class=md-ellipsis> labels </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_9_label aria-expanded=false> <label class=md-nav__title for=__nav_5_9> <span class="md-nav__icon md-icon"></span> labels </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../labels/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 18h9l-2 2H4c-.5 0-1.03-.21-1.41-.59C2.21 19.03 2 18.5 2 18V8h2v10M17.63 4.84C17.27 4.33 16.67 4 16 4H8c-1.1 0-2 .9-2 2v8c0 1.1.9 2 2 2h8c.67 0 1.27-.34 1.63-.85L22 10l-4.37-5.16M16 14H8V6h8l3.55 4Z"/></svg> <span class=md-ellipsis> labels </span> </a> </li> <li class=md-nav__item> <a href=../../../labels/enums/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M5 3h2v2H5v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5h2v2H5c-1.07-.27-2-.9-2-2v-4a2 2 0 0 0-2-2H0v-2h1a2 2 0 0 0 2-2V5a2 2 0 0 1 2-2m14 0a2 2 0 0 1 2 2v4a2 2 0 0 0 2 2h1v2h-1a2 2 0 0 0-2 2v4a2 2 0 0 1-2 2h-2v-2h2v-5a2 2 0 0 1 2-2 2 2 0 0 1-2-2V5h-2V3h2m-7 12a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m-4 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m8 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1Z"/></svg> <span class=md-ellipsis> enums </span> </a> </li> <li class=md-nav__item> <a href=../../../labels/nb/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m6 20 4.16-12.09L9.34 6H8V4h2c.42 0 .78.26.93.63L16.66 18H18v2h-2c-.43 0-.79-.27-.93-.64l-3.74-8.71L8.12 20H6Z"/></svg> <span class=md-ellipsis> nb </span> </a> </li> <li class="md-nav__item md-nav__item--pruned md-nav__item--nested"> <a href=../../../labels/generators/index.html class=md-nav__link> <span class=md-ellipsis> generators </span> <span class="md-nav__icon md-icon"></span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_10> <label class=md-nav__link for=__nav_5_10 id=__nav_5_10_label tabindex> <span class=md-ellipsis> messaging </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_10_label aria-expanded=false> <label class=md-nav__title for=__nav_5_10> <span class="md-nav__icon md-icon"></span> messaging </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../messaging/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 2a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2H6l-4 4V4a2 2 0 0 1 2-2h16M4 4v13.17L5.17 16H20V4H4m2 3h12v2H6V7m0 4h9v2H6v-2Z"/></svg> <span class=md-ellipsis> messaging </span> </a> </li> <li class=md-nav__item> <a href=../../../messaging/telegram/index.html class=md-nav__link> <span class=md-ellipsis> telegram </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_11> <label class=md-nav__link for=__nav_5_11 id=__nav_5_11_label tabindex> <span class=md-ellipsis> ohlcv </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_11_label aria-expanded=false> <label class=md-nav__title for=__nav_5_11> <span class="md-nav__icon md-icon"></span> ohlcv </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../ohlcv/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M8 2v3h2v14H8v3H6v-3H4V5h2V2h2m8 0v5h-2v10h2v5h2v-5h2V7h-2V2h-2Z"/></svg> <span class=md-ellipsis> ohlcv </span> </a> </li> <li class=md-nav__item> <a href=../../../ohlcv/accessors/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 5H8l4-4 4 4h-3v4.43c-.75.46-1.42 1.03-2 1.69V5m11 6-4-4v3a6.747 6.747 0 0 0-7 6.17A3.006 3.006 0 0 0 9.17 20 3.006 3.006 0 0 0 13 21.83 3.01 3.01 0 0 0 14.83 18c-.3-.86-.98-1.53-1.83-1.83.47-4 4.47-4.2 4.95-4.2v3L22 11m-11.37.59A7.632 7.632 0 0 0 6 10V7l-4 4 4 4v-3c1.34.03 2.63.5 3.64 1.4.25-.64.58-1.25.99-1.81Z"/></svg> <span class=md-ellipsis> accessors </span> </a> </li> <li class=md-nav__item> <a href=../../../ohlcv/nb/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m6 20 4.16-12.09L9.34 6H8V4h2c.42 0 .78.26.93.63L16.66 18H18v2h-2c-.43 0-.79-.27-.93-.64l-3.74-8.71L8.12 20H6Z"/></svg> <span class=md-ellipsis> nb </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_12> <label class=md-nav__link for=__nav_5_12 id=__nav_5_12_label tabindex> <span class=md-ellipsis> portfolio </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_12_label aria-expanded=false> <label class=md-nav__title for=__nav_5_12> <span class="md-nav__icon md-icon"></span> portfolio </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../portfolio/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17.45 15.18 22 7.31V21H2V3h2v12.54L9.5 6 16 9.78l4.24-7.33 1.73 1-5.23 9.05-6.51-3.75L4.31 19h2.26l4.39-7.56 6.49 3.74Z"/></svg> <span class=md-ellipsis> portfolio </span> </a> </li> <li class=md-nav__item> <a href=../../../portfolio/base/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3M4 5h2v2H4m14 0h2v2h-2M8 17h2v2H8Z"/></svg> <span class=md-ellipsis> base </span> </a> </li> <li class=md-nav__item> <a href=../../../portfolio/call_seq/index.html class=md-nav__link> <span class=md-ellipsis> call_seq </span> </a> </li> <li class=md-nav__item> <a href=../../../portfolio/chunking/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16v-3h-3v9h-2V2h2v9h3V8l4 4-4 4M2 12l4 4v-3h3v9h2V2H9v9H6V8l-4 4Z"/></svg> <span class=md-ellipsis> chunking </span> </a> </li> <li class=md-nav__item> <a href=../../../portfolio/decorators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3H2m2 2h2v2H4V5m14 2h2v2h-2V7m0 8v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2M8 17h2v2H8v-2Z"/></svg> <span class=md-ellipsis> decorators </span> </a> </li> <li class=md-nav__item> <a href=../../../portfolio/enums/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M5 3h2v2H5v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5h2v2H5c-1.07-.27-2-.9-2-2v-4a2 2 0 0 0-2-2H0v-2h1a2 2 0 0 0 2-2V5a2 2 0 0 1 2-2m14 0a2 2 0 0 1 2 2v4a2 2 0 0 0 2 2h1v2h-1a2 2 0 0 0-2 2v4a2 2 0 0 1-2 2h-2v-2h2v-5a2 2 0 0 1 2-2 2 2 0 0 1-2-2V5h-2V3h2m-7 12a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m-4 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m8 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1Z"/></svg> <span class=md-ellipsis> enums </span> </a> </li> <li class=md-nav__item> <a href=../../../portfolio/logs/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M8 2h8a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2m0 8v4h8v-4H8m0 6v4h8v-4H8M8 4v4h8V4H8Z"/></svg> <span class=md-ellipsis> logs </span> </a> </li> <li class=md-nav__item> <a href=../../../portfolio/orders/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M8 2h8a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2m0 8v4h8v-4H8m0 6v4h8v-4H8M8 4v4h8V4H8Z"/></svg> <span class=md-ellipsis> orders </span> </a> </li> <li class=md-nav__item> <a href=../../../portfolio/preparing/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 4V3a1 1 0 0 0-1-1H5a1 1 0 0 0-1 1v4a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1V6h1v4H9v11a1 1 0 0 0 1 1h2a1 1 0 0 0 1-1v-9h8V4h-3Z"/></svg> <span class=md-ellipsis> preparing </span> </a> </li> <li class=md-nav__item> <a href=../../../portfolio/trades/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M8 2h8a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2m0 8v4h8v-4H8m0 6v4h8v-4H8M8 4v4h8V4H8Z"/></svg> <span class=md-ellipsis> trades </span> </a> </li> <li class="md-nav__item md-nav__item--pruned md-nav__item--nested"> <a href=../../../portfolio/nb/index.html class=md-nav__link> <span class=md-ellipsis> nb </span> <span class="md-nav__icon md-icon"></span> </a> </li> <li class="md-nav__item md-nav__item--pruned md-nav__item--nested"> <a href=../../../portfolio/pfopt/index.html class=md-nav__link> <span class=md-ellipsis> pfopt </span> <span class="md-nav__icon md-icon"></span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_13> <label class=md-nav__link for=__nav_5_13 id=__nav_5_13_label tabindex> <span class=md-ellipsis> px </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_13_label aria-expanded=false> <label class=md-nav__title for=__nav_5_13> <span class="md-nav__icon md-icon"></span> px </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../px/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M7.2 11.2c1.77 0 3.2 1.43 3.2 3.2 0 1.77-1.43 3.2-3.2 3.2-1.77 0-3.2-1.43-3.2-3.2 0-1.77 1.43-3.2 3.2-3.2m7.6 4.8a2 2 0 0 1 2 2 2 2 0 0 1-2 2 2 2 0 0 1-2-2 2 2 0 0 1 2-2m.4-12A4.8 4.8 0 0 1 20 8.8c0 2.65-2.15 4.8-4.8 4.8a4.8 4.8 0 0 1-4.8-4.8c0-2.65 2.15-4.8 4.8-4.8Z"/></svg> <span class=md-ellipsis> px </span> </a> </li> <li class=md-nav__item> <a href=../../../px/accessors/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 5H8l4-4 4 4h-3v4.43c-.75.46-1.42 1.03-2 1.69V5m11 6-4-4v3a6.747 6.747 0 0 0-7 6.17A3.006 3.006 0 0 0 9.17 20 3.006 3.006 0 0 0 13 21.83 3.01 3.01 0 0 0 14.83 18c-.3-.86-.98-1.53-1.83-1.83.47-4 4.47-4.2 4.95-4.2v3L22 11m-11.37.59A7.632 7.632 0 0 0 6 10V7l-4 4 4 4v-3c1.34.03 2.63.5 3.64 1.4.25-.64.58-1.25.99-1.81Z"/></svg> <span class=md-ellipsis> accessors </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_14> <label class=md-nav__link for=__nav_5_14 id=__nav_5_14_label tabindex> <span class=md-ellipsis> records </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_14_label aria-expanded=false> <label class=md-nav__title for=__nav_5_14> <span class="md-nav__icon md-icon"></span> records </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../records/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M8 2h8a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2m0 8v4h8v-4H8m0 6v4h8v-4H8M8 4v4h8V4H8Z"/></svg> <span class=md-ellipsis> records </span> </a> </li> <li class=md-nav__item> <a href=../../../records/base/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3M4 5h2v2H4m14 0h2v2h-2M8 17h2v2H8Z"/></svg> <span class=md-ellipsis> base </span> </a> </li> <li class=md-nav__item> <a href=../../../records/chunking/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16v-3h-3v9h-2V2h2v9h3V8l4 4-4 4M2 12l4 4v-3h3v9h2V2H9v9H6V8l-4 4Z"/></svg> <span class=md-ellipsis> chunking </span> </a> </li> <li class=md-nav__item> <a href=../../../records/col_mapper/index.html class=md-nav__link> <span class=md-ellipsis> col_mapper </span> </a> </li> <li class=md-nav__item> <a href=../../../records/decorators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3H2m2 2h2v2H4V5m14 2h2v2h-2V7m0 8v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2M8 17h2v2H8v-2Z"/></svg> <span class=md-ellipsis> decorators </span> </a> </li> <li class=md-nav__item> <a href=../../../records/mapped_array/index.html class=md-nav__link> <span class=md-ellipsis> mapped_array </span> </a> </li> <li class=md-nav__item> <a href=../../../records/nb/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m6 20 4.16-12.09L9.34 6H8V4h2c.42 0 .78.26.93.63L16.66 18H18v2h-2c-.43 0-.79-.27-.93-.64l-3.74-8.71L8.12 20H6Z"/></svg> <span class=md-ellipsis> nb </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_15> <label class=md-nav__link for=__nav_5_15 id=__nav_5_15_label tabindex> <span class=md-ellipsis> registries </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_15_label aria-expanded=false> <label class=md-nav__title for=__nav_5_15> <span class="md-nav__icon md-icon"></span> registries </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../registries/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m17 21-2.75-3 1.16-1.16L17 18.43l3.59-3.59 1.16 1.41M12.8 21H5a2 2 0 0 1-2-2V5c0-1.11.89-2 2-2h14a2 2 0 0 1 2 2v7.8c-.88-.51-1.91-.8-3-.8l-1 .08V11H7v2h7.69A5.983 5.983 0 0 0 12 18c0 1.09.29 2.12.8 3m-.8-6H7v2h5m5-10H7v2h10"/></svg> <span class=md-ellipsis> registries </span> </a> </li> <li class=md-nav__item> <a href=../../../registries/ca_registry/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m19 8-4 4h3a6 6 0 0 1-6 6c-1 0-1.97-.25-2.8-.7l-1.46 1.46A7.93 7.93 0 0 0 12 20a8 8 0 0 0 8-8h3M6 12a6 6 0 0 1 6-6c1 0 1.97.25 2.8.7l1.46-1.46A7.93 7.93 0 0 0 12 4a8 8 0 0 0-8 8H1l4 4 4-4"/></svg> <span class=md-ellipsis> ca_registry </span> </a> </li> <li class=md-nav__item> <a href=../../../registries/ch_registry/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16v-3h-3v9h-2V2h2v9h3V8l4 4-4 4M2 12l4 4v-3h3v9h2V2H9v9H6V8l-4 4Z"/></svg> <span class=md-ellipsis> ch_registry </span> </a> </li> <li class=md-nav__item> <a href=../../../registries/jit_registry/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 16a3 3 0 0 1-3-3c0-1.12.61-2.1 1.5-2.61l9.71-5.62-5.53 9.58c-.5.98-1.51 1.65-2.68 1.65m0-13c1.81 0 3.5.5 4.97 1.32l-2.1 1.21C14 5.19 13 5 12 5a8 8 0 0 0-8 8c0 2.21.89 4.21 2.34 5.65h.01c.39.39.39 1.02 0 1.41-.39.39-1.03.39-1.42.01A9.969 9.969 0 0 1 2 13 10 10 0 0 1 12 3m10 10c0 2.76-1.12 5.26-2.93 7.07-.39.38-1.02.38-1.41-.01a.996.996 0 0 1 0-1.41A7.95 7.95 0 0 0 20 13c0-1-.19-2-.54-2.9L20.67 8C21.5 9.5 22 11.18 22 13Z"/></svg> <span class=md-ellipsis> jit_registry </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_16> <label class=md-nav__link for=__nav_5_16 id=__nav_5_16_label tabindex> <span class=md-ellipsis> returns </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_16_label aria-expanded=false> <label class=md-nav__title for=__nav_5_16> <span class="md-nav__icon md-icon"></span> returns </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../returns/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m16 11.78 4.24-7.33 1.73 1-5.23 9.05-6.51-3.75L5.46 19H22v2H2V3h2v14.54L9.5 8l6.5 3.78Z"/></svg> <span class=md-ellipsis> returns </span> </a> </li> <li class=md-nav__item> <a href=../../../returns/accessors/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 5H8l4-4 4 4h-3v4.43c-.75.46-1.42 1.03-2 1.69V5m11 6-4-4v3a6.747 6.747 0 0 0-7 6.17A3.006 3.006 0 0 0 9.17 20 3.006 3.006 0 0 0 13 21.83 3.01 3.01 0 0 0 14.83 18c-.3-.86-.98-1.53-1.83-1.83.47-4 4.47-4.2 4.95-4.2v3L22 11m-11.37.59A7.632 7.632 0 0 0 6 10V7l-4 4 4 4v-3c1.34.03 2.63.5 3.64 1.4.25-.64.58-1.25.99-1.81Z"/></svg> <span class=md-ellipsis> accessors </span> </a> </li> <li class=md-nav__item> <a href=../../../returns/enums/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M5 3h2v2H5v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5h2v2H5c-1.07-.27-2-.9-2-2v-4a2 2 0 0 0-2-2H0v-2h1a2 2 0 0 0 2-2V5a2 2 0 0 1 2-2m14 0a2 2 0 0 1 2 2v4a2 2 0 0 0 2 2h1v2h-1a2 2 0 0 0-2 2v4a2 2 0 0 1-2 2h-2v-2h2v-5a2 2 0 0 1 2-2 2 2 0 0 1-2-2V5h-2V3h2m-7 12a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m-4 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m8 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1Z"/></svg> <span class=md-ellipsis> enums </span> </a> </li> <li class=md-nav__item> <a href=../../../returns/nb/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m6 20 4.16-12.09L9.34 6H8V4h2c.42 0 .78.26.93.63L16.66 18H18v2h-2c-.43 0-.79-.27-.93-.64l-3.74-8.71L8.12 20H6Z"/></svg> <span class=md-ellipsis> nb </span> </a> </li> <li class=md-nav__item> <a href=../../../returns/qs_adapter/index.html class=md-nav__link> <span class=md-ellipsis> qs_adapter </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_17> <label class=md-nav__link for=__nav_5_17 id=__nav_5_17_label tabindex> <span class=md-ellipsis> signals </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_17_label aria-expanded=false> <label class=md-nav__title for=__nav_5_17> <span class="md-nav__icon md-icon"></span> signals </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../signals/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 10c-1.1 0-2 .9-2 2s.9 2 2 2 2-.9 2-2-.9-2-2-2m6 2c0-3.3-2.7-6-6-6s-6 2.7-6 6c0 2.2 1.2 4.1 3 5.2l1-1.7c-1.2-.7-2-2-2-3.4 0-2.2 1.8-4 4-4s4 1.8 4 4c0 1.5-.8 2.8-2 3.4l1 1.7c1.8-1 3-3 3-5.2M12 2C6.5 2 2 6.5 2 12c0 3.7 2 6.9 5 8.6l1-1.7c-2.4-1.4-4-4-4-6.9 0-4.4 3.6-8 8-8s8 3.6 8 8c0 3-1.6 5.5-4 6.9l1 1.7c3-1.7 5-4.9 5-8.6 0-5.5-4.5-10-10-10Z"/></svg> <span class=md-ellipsis> signals </span> </a> </li> <li class=md-nav__item> <a href=../../../signals/accessors/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 5H8l4-4 4 4h-3v4.43c-.75.46-1.42 1.03-2 1.69V5m11 6-4-4v3a6.747 6.747 0 0 0-7 6.17A3.006 3.006 0 0 0 9.17 20 3.006 3.006 0 0 0 13 21.83 3.01 3.01 0 0 0 14.83 18c-.3-.86-.98-1.53-1.83-1.83.47-4 4.47-4.2 4.95-4.2v3L22 11m-11.37.59A7.632 7.632 0 0 0 6 10V7l-4 4 4 4v-3c1.34.03 2.63.5 3.64 1.4.25-.64.58-1.25.99-1.81Z"/></svg> <span class=md-ellipsis> accessors </span> </a> </li> <li class=md-nav__item> <a href=../../../signals/enums/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M5 3h2v2H5v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5h2v2H5c-1.07-.27-2-.9-2-2v-4a2 2 0 0 0-2-2H0v-2h1a2 2 0 0 0 2-2V5a2 2 0 0 1 2-2m14 0a2 2 0 0 1 2 2v4a2 2 0 0 0 2 2h1v2h-1a2 2 0 0 0-2 2v4a2 2 0 0 1-2 2h-2v-2h2v-5a2 2 0 0 1 2-2 2 2 0 0 1-2-2V5h-2V3h2m-7 12a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m-4 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m8 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1Z"/></svg> <span class=md-ellipsis> enums </span> </a> </li> <li class=md-nav__item> <a href=../../../signals/factory/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 18v2h4v-2H4m0-4v2h10v-2H4m6 4v2h4v-2h-4m6-4v2h4v-2h-4m0 4v2h4v-2h-4M2 22V8l5 4V8l5 4V8l5 4 1-10h3l1 10v10H2Z"/></svg> <span class=md-ellipsis> factory </span> </a> </li> <li class=md-nav__item> <a href=../../../signals/nb/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m6 20 4.16-12.09L9.34 6H8V4h2c.42 0 .78.26.93.63L16.66 18H18v2h-2c-.43 0-.79-.27-.93-.64l-3.74-8.71L8.12 20H6Z"/></svg> <span class=md-ellipsis> nb </span> </a> </li> <li class="md-nav__item md-nav__item--pruned md-nav__item--nested"> <a href=../../../signals/generators/index.html class=md-nav__link> <span class=md-ellipsis> generators </span> <span class="md-nav__icon md-icon"></span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_18> <label class=md-nav__link for=__nav_5_18 id=__nav_5_18_label tabindex> <span class=md-ellipsis> utils </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_18_label aria-expanded=false> <label class=md-nav__title for=__nav_5_18> <span class="md-nav__icon md-icon"></span> utils </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../utils/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m21.71 20.29-1.42 1.42a1 1 0 0 1-1.41 0L7 9.85A3.81 3.81 0 0 1 6 10a4 4 0 0 1-3.78-5.3l2.54 2.54.53-.53 1.42-1.42.53-.53L4.7 2.22A4 4 0 0 1 10 6a3.81 3.81 0 0 1-.15 1l11.86 11.88a1 1 0 0 1 0 1.41M2.29 18.88a1 1 0 0 0 0 1.41l1.42 1.42a1 1 0 0 0 1.41 0l5.47-5.46-2.83-2.83M20 2l-4 2v2l-2.17 2.17 2 2L18 8h2l2-4Z"/></svg> <span class=md-ellipsis> utils </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/annotations/index.html class=md-nav__link> <span class=md-ellipsis> annotations </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/array_/index.html class=md-nav__link> <span class=md-ellipsis> array_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/attr_/index.html class=md-nav__link> <span class=md-ellipsis> attr_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/caching/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m19 8-4 4h3a6 6 0 0 1-6 6c-1 0-1.97-.25-2.8-.7l-1.46 1.46A7.93 7.93 0 0 0 12 20a8 8 0 0 0 8-8h3M6 12a6 6 0 0 1 6-6c1 0 1.97.25 2.8.7l1.46-1.46A7.93 7.93 0 0 0 12 4a8 8 0 0 0-8 8H1l4 4 4-4"/></svg> <span class=md-ellipsis> caching </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/chaining/index.html class=md-nav__link> <span class=md-ellipsis> chaining </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/checks/index.html class=md-nav__link> <span class=md-ellipsis> checks </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/chunking/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16v-3h-3v9h-2V2h2v9h3V8l4 4-4 4M2 12l4 4v-3h3v9h2V2H9v9H6V8l-4 4Z"/></svg> <span class=md-ellipsis> chunking </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/colors/index.html class=md-nav__link> <span class=md-ellipsis> colors </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/config/index.html class=md-nav__link> <span class=md-ellipsis> config </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/cutting/index.html class=md-nav__link> <span class=md-ellipsis> cutting </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/datetime_/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 19H5V8h14m-3-7v2H8V1H6v2H5c-1.11 0-2 .89-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2h-1V1m-1 11h-5v5h5v-5Z"/></svg> <span class=md-ellipsis> datetime_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/datetime_nb/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 19H5V8h14m-3-7v2H8V1H6v2H5c-1.11 0-2 .89-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2h-1V1m-1 11h-5v5h5v-5Z"/></svg> <span class=md-ellipsis> datetime_nb </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/decorators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3H2m2 2h2v2H4V5m14 2h2v2h-2V7m0 8v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2M8 17h2v2H8v-2Z"/></svg> <span class=md-ellipsis> decorators </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/enum_/index.html class=md-nav__link> <span class=md-ellipsis> enum_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/eval_/index.html class=md-nav__link> <span class=md-ellipsis> eval_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/execution/index.html class=md-nav__link> <span class=md-ellipsis> execution </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/figure/index.html class=md-nav__link> <span class=md-ellipsis> figure </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/formatting/index.html class=md-nav__link> <span class=md-ellipsis> formatting </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/hashing/index.html class=md-nav__link> <span class=md-ellipsis> hashing </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/image_/index.html class=md-nav__link> <span class=md-ellipsis> image_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/jitting/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 16a3 3 0 0 1-3-3c0-1.12.61-2.1 1.5-2.61l9.71-5.62-5.53 9.58c-.5.98-1.51 1.65-2.68 1.65m0-13c1.81 0 3.5.5 4.97 1.32l-2.1 1.21C14 5.19 13 5 12 5a8 8 0 0 0-8 8c0 2.21.89 4.21 2.34 5.65h.01c.39.39.39 1.02 0 1.41-.39.39-1.03.39-1.42.01A9.969 9.969 0 0 1 2 13 10 10 0 0 1 12 3m10 10c0 2.76-1.12 5.26-2.93 7.07-.39.38-1.02.38-1.41-.01a.996.996 0 0 1 0-1.41A7.95 7.95 0 0 0 20 13c0-1-.19-2-.54-2.9L20.67 8C21.5 9.5 22 11.18 22 13Z"/></svg> <span class=md-ellipsis> jitting </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/magic_decorators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3H2m2 2h2v2H4V5m14 2h2v2h-2V7m0 8v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2M8 17h2v2H8v-2Z"/></svg> <span class=md-ellipsis> magic_decorators </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/mapping/index.html class=md-nav__link> <span class=md-ellipsis> mapping </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/math_/index.html class=md-nav__link> <span class=md-ellipsis> math_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/merging/index.html class=md-nav__link> <span class=md-ellipsis> merging </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/module_/index.html class=md-nav__link> <span class=md-ellipsis> module_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/path_/index.html class=md-nav__link> <span class=md-ellipsis> path_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/params/index.html class=md-nav__link> <span class=md-ellipsis> params </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/parsing/index.html class=md-nav__link> <span class=md-ellipsis> parsing </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/pbar/index.html class=md-nav__link> <span class=md-ellipsis> pbar </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/pickling/index.html class=md-nav__link> <span class=md-ellipsis> pickling </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/profiling/index.html class=md-nav__link> <span class=md-ellipsis> profiling </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/random_/index.html class=md-nav__link> <span class=md-ellipsis> random_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/requests_/index.html class=md-nav__link> <span class=md-ellipsis> requests_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/schedule_/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 20a7 7 0 0 1-7-7 7 7 0 0 1 7-7 7 7 0 0 1 7 7 7 7 0 0 1-7 7m7.03-12.61 1.42-1.42c-.45-.51-.9-.97-1.41-1.41L17.62 6c-1.55-1.26-3.5-2-5.62-2a9 9 0 0 0-9 9 9 9 0 0 0 9 9c5 0 9-4.03 9-9 0-2.12-.74-4.07-1.97-5.61M11 14h2V8h-2m4-7H9v2h6V1Z"/></svg> <span class=md-ellipsis> schedule_ </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/search/index.html class=md-nav__link> <span class=md-ellipsis> search </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/selection/index.html class=md-nav__link> <span class=md-ellipsis> selection </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/tagging/index.html class=md-nav__link> <span class=md-ellipsis> tagging </span> </a> </li> <li class=md-nav__item> <a href=../../../utils/template/index.html class=md-nav__link> <span class=md-ellipsis> template </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_6> <label class=md-nav__link for=__nav_6 id=__nav_6_label tabindex> <span class=md-ellipsis> Cookbook </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_6_label aria-expanded=false> <label class=md-nav__title for=__nav_6> <span class="md-nav__icon md-icon"></span> Cookbook </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../cookbook/overview/index.html class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/discovery/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 3h6v4H3V3m12 7h6v4h-6v-4m0 7h6v4h-6v-4m-2-4H7v5h6v2H5V9h2v2h6v2Z"/></svg> <span class=md-ellipsis> Discovery </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/configuration/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 15.5A3.5 3.5 0 0 1 8.5 12 3.5 3.5 0 0 1 12 8.5a3.5 3.5 0 0 1 3.5 3.5 3.5 3.5 0 0 1-3.5 3.5m7.43-2.53c.04-.32.07-.64.07-.97 0-.33-.03-.66-.07-1l2.11-1.63c.19-.15.24-.42.12-.64l-2-3.46c-.12-.22-.39-.31-.61-.22l-2.49 1c-.52-.39-1.06-.73-1.69-.98l-.37-2.65A.506.506 0 0 0 14 2h-4c-.25 0-.46.18-.5.42l-.37 2.65c-.63.25-1.17.59-1.69.98l-2.49-1c-.22-.09-.49 0-.61.22l-2 3.46c-.13.22-.07.49.12.64L4.57 11c-.04.34-.07.67-.07 1 0 .33.03.65.07.97l-2.11 1.66c-.19.15-.25.42-.12.64l2 3.46c.12.22.39.3.61.22l2.49-1.01c.52.4 1.06.74 1.69.99l.37 2.65c.04.24.25.42.5.42h4c.25 0 .46-.18.5-.42l.37-2.65c.63-.26 1.17-.59 1.69-.99l2.49 1.01c.22.08.49 0 .61-.22l2-3.46c.12-.22.07-.49-.12-.64l-2.11-1.66Z"/></svg> <span class=md-ellipsis> Configuration </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/persistence/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 12h2v5h16v-5h2v5c0 1.11-.89 2-2 2H4a2 2 0 0 1-2-2v-5m10 3 5.55-5.46-1.42-1.41L13 11.25V2h-2v9.25L7.88 8.13 6.46 9.55 12 15Z"/></svg> <span class=md-ellipsis> Persistence </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/caching/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m19 8-4 4h3a6 6 0 0 1-6 6c-1 0-1.97-.25-2.8-.7l-1.46 1.46A7.93 7.93 0 0 0 12 20a8 8 0 0 0 8-8h3M6 12a6 6 0 0 1 6-6c1 0 1.97.25 2.8.7l1.46-1.46A7.93 7.93 0 0 0 12 4a8 8 0 0 0-8 8H1l4 4 4-4"/></svg> <span class=md-ellipsis> Caching </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/plotting/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M7.2 11.2c1.77 0 3.2 1.43 3.2 3.2 0 1.77-1.43 3.2-3.2 3.2-1.77 0-3.2-1.43-3.2-3.2 0-1.77 1.43-3.2 3.2-3.2m7.6 4.8a2 2 0 0 1 2 2 2 2 0 0 1-2 2 2 2 0 0 1-2-2 2 2 0 0 1 2-2m.4-12A4.8 4.8 0 0 1 20 8.8c0 2.65-2.15 4.8-4.8 4.8a4.8 4.8 0 0 1-4.8-4.8c0-2.65 2.15-4.8 4.8-4.8Z"/></svg> <span class=md-ellipsis> Plotting </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/compilation/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 16a3 3 0 0 1-3-3c0-1.12.61-2.1 1.5-2.61l9.71-5.62-5.53 9.58c-.5.98-1.51 1.65-2.68 1.65m0-13c1.81 0 3.5.5 4.97 1.32l-2.1 1.21C14 5.19 13 5 12 5a8 8 0 0 0-8 8c0 2.21.89 4.21 2.34 5.65h.01c.39.39.39 1.02 0 1.41-.39.39-1.03.39-1.42.01A9.969 9.969 0 0 1 2 13 10 10 0 0 1 12 3m10 10c0 2.76-1.12 5.26-2.93 7.07-.39.38-1.02.38-1.41-.01a.996.996 0 0 1 0-1.41A7.95 7.95 0 0 0 20 13c0-1-.19-2-.54-2.9L20.67 8C21.5 9.5 22 11.18 22 13Z"/></svg> <span class=md-ellipsis> Compilation </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/data/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 3C7.58 3 4 4.79 4 7s3.58 4 8 4 8-1.79 8-4-3.58-4-8-4M4 9v3c0 2.21 3.58 4 8 4s8-1.79 8-4V9c0 2.21-3.58 4-8 4s-8-1.79-8-4m0 5v3c0 2.21 3.58 4 8 4s8-1.79 8-4v-3c0 2.21-3.58 4-8 4s-8-1.79-8-4Z"/></svg> <span class=md-ellipsis> Data </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/arrays/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M7 2h14a2 2 0 0 1 2 2v12c0 1.11-.89 2-2 2H7a2 2 0 0 1-2-2V4c0-1.1.9-2 2-2m0 4v4h6V6H7m8 0v4h6V6h-6m-8 6v4h6v-4H7m8 0v4h6v-4h-6M3 20V6H1v14c0 1.11.89 2 2 2h16v-2H3Z"/></svg> <span class=md-ellipsis> Arrays </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/indexing/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 20.5c0 .8-.7 1.5-1.5 1.5H13c-.4 0-.7-.1-1-.4l-4-4.2.7-.8c.2-.2.5-.3.8-.3h.2L12 18V9c0-.6.4-1 1-1s1 .4 1 1v4.5l1.2.1 3.9 2.2c.5.2.9.8.9 1.3v3.4M20 2H4c-1.1 0-2 .9-2 2v8c0 1.1.9 2 2 2h4v-2H4V4h16v8h-2v2h2c1.1 0 2-.9 2-2V4c0-1.1-.9-2-2-2Z"/></svg> <span class=md-ellipsis> Indexing </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/indicators/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m3 14 .5.07L8.07 9.5a1.95 1.95 0 0 1 .52-1.91c.78-.79 2.04-.79 2.82 0 .53.52.7 1.26.52 1.91l2.57 2.57.5-.07c.18 0 .35 0 .5.07l3.57-3.57C19 8.35 19 8.18 19 8a2 2 0 0 1 2-2 2 2 0 0 1 2 2 2 2 0 0 1-2 2c-.18 0-.35 0-.5-.07l-3.57 3.57c.07.15.07.32.07.5a2 2 0 0 1-2 2 2 2 0 0 1-2-2l.07-.5-2.57-2.57c-.32.07-.68.07-1 0L4.93 15.5 5 16a2 2 0 0 1-2 2 2 2 0 0 1-2-2 2 2 0 0 1 2-2Z"/></svg> <span class=md-ellipsis> Indicators </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/signals/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 10c-1.1 0-2 .9-2 2s.9 2 2 2 2-.9 2-2-.9-2-2-2m6 2c0-3.3-2.7-6-6-6s-6 2.7-6 6c0 2.2 1.2 4.1 3 5.2l1-1.7c-1.2-.7-2-2-2-3.4 0-2.2 1.8-4 4-4s4 1.8 4 4c0 1.5-.8 2.8-2 3.4l1 1.7c1.8-1 3-3 3-5.2M12 2C6.5 2 2 6.5 2 12c0 3.7 2 6.9 5 8.6l1-1.7c-2.4-1.4-4-4-4-6.9 0-4.4 3.6-8 8-8s8 3.6 8 8c0 3-1.6 5.5-4 6.9l1 1.7c3-1.7 5-4.9 5-8.6 0-5.5-4.5-10-10-10Z"/></svg> <span class=md-ellipsis> Signals </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/portfolio/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17.45 15.18 22 7.31V21H2V3h2v12.54L9.5 6 16 9.78l4.24-7.33 1.73 1-5.23 9.05-6.51-3.75L4.31 19h2.26l4.39-7.56 6.49 3.74Z"/></svg> <span class=md-ellipsis> Portfolio </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/optimization/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16h-.58l-.81-.81A7.07 7.07 0 0 0 18 11c0-3.87-3.13-7-7-7-1.5 0-3 .5-4.21 1.4-3.09 2.32-3.72 6.71-1.4 9.8 2.32 3.09 6.71 3.72 9.8 1.4l.81.81V18l5 5 2-2-5-5m-7 0c-2.76 0-5-2.24-5-5s2.24-5 5-5 5 2.24 5 5-2.24 5-5 5M3 6 1 8V1h7L6 3H3v3m18-5v7l-2-2V3h-3l-2-2h7M6 19l2 2H1v-7l2 2v3h3Z"/></svg> <span class=md-ellipsis> Optimization </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/cross-validation/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M.41 13.41 6 19l1.41-1.42L1.83 12m20.41-6.42L11.66 16.17 7.5 12l-1.43 1.41L11.66 19l12-12M18 7l-1.41-1.42-6.35 6.35 1.42 1.41L18 7Z"/></svg> <span class=md-ellipsis> Cross-validation </span> </a> </li> <li class=md-nav__item> <a href=../../../../cookbook/benchmarking/index.html class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9 5a7 7 0 0 1 7 7h1v3h-1v4H9a7 7 0 0 1-7-7 7 7 0 0 1 7-7m0 3a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m8 9h5v4h-2v-2h-3v-2Z"/></svg> <span class=md-ellipsis> Benchmarking </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_7> <label class=md-nav__link for=__nav_7 id=__nav_7_label tabindex> <span class=md-ellipsis> Terms </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_7_label aria-expanded=false> <label class=md-nav__title for=__nav_7> <span class="md-nav__icon md-icon"></span> Terms </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../../terms/terms-of-use/index.html class=md-nav__link> <span class=md-ellipsis> Terms of Use </span> </a> </li> <li class=md-nav__item> <a href=../../../../terms/software-license/index.html class=md-nav__link> <span class=md-ellipsis> Software License </span> </a> </li> <li class=md-nav__item> <a href=../../../../terms/remarks/index.html class=md-nav__link> <span class=md-ellipsis> Remarks </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <nav class=md-path aria-label=Navigation> <ol class=md-path__list> <li class=md-path__item> <a href=../../../index.html class=md-path__link> <span class=md-ellipsis> API </span> </a> </li> <li class=md-path__item> <a href=../../index.html class=md-path__link> <span class=md-ellipsis> generic </span> </a> </li> <li class=md-path__item> <a href=../index.html class=md-path__link> <span class=md-ellipsis> splitting </span> </a> </li> </ol> </nav> <article class="md-content__inner md-typeset"> <nav class=md-tags> <span class=md-tag>base</span> <span class=md-tag>splitting</span> </nav> <h1 id=vectorbtpro.generic.splitting.base><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M2 3v6h2.95l2 6H6v6h6v-4.59L17.41 11H22V5h-6v4.57L10.59 15H9.06l-2-6H8V3M4 5h2v2H4m14 0h2v2h-2M8 17h2v2H8Z"/></svg></span> base <span class=dobjtype>module</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base title="Permanent link">&para;</a></h1> <p>Base class for splitting.</p> <hr> <h2 id=vectorbtpro.generic.splitting.base.FixRange>FixRange <span class=dobjtype>class</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L65-L70 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.FixRange title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>FixRange</span><span class=p>(</span>
</span><span id=__span-0-2><a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>range_</span>
</span><span id=__span-0-3><a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=p>)</span>
</span></code></pre></div> <p>Class that represents a fixed range.</p> <p>Method generated by attrs for class FixRange.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.FixRange.range_>range_ <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.FixRange.range_ title="Permanent link">&para;</a></h3> <p>Range.</p> <hr> <h2 id=vectorbtpro.generic.splitting.base.RelRange>RelRange <span class=dobjtype>class</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L73-L301 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.RelRange title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-1-1><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=n>RelRange</span><span class=p>(</span>
</span><span id=__span-1-2><a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a> <span class=n>offset</span><span class=o>=</span><span class=mi>0</span><span class=p>,</span>
</span><span id=__span-1-3><a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a> <span class=n>offset_anchor</span><span class=o>=</span><span class=s1>&#39;prev_end&#39;</span><span class=p>,</span>
</span><span id=__span-1-4><a id=__codelineno-1-4 name=__codelineno-1-4 href=#__codelineno-1-4></a> <span class=n>offset_space</span><span class=o>=</span><span class=s1>&#39;free&#39;</span><span class=p>,</span>
</span><span id=__span-1-5><a id=__codelineno-1-5 name=__codelineno-1-5 href=#__codelineno-1-5></a> <span class=n>length</span><span class=o>=</span><span class=mf>1.0</span><span class=p>,</span>
</span><span id=__span-1-6><a id=__codelineno-1-6 name=__codelineno-1-6 href=#__codelineno-1-6></a> <span class=n>length_space</span><span class=o>=</span><span class=s1>&#39;free&#39;</span><span class=p>,</span>
</span><span id=__span-1-7><a id=__codelineno-1-7 name=__codelineno-1-7 href=#__codelineno-1-7></a> <span class=n>out_of_bounds</span><span class=o>=</span><span class=s1>&#39;warn&#39;</span><span class=p>,</span>
</span><span id=__span-1-8><a id=__codelineno-1-8 name=__codelineno-1-8 href=#__codelineno-1-8></a> <span class=n>is_gap</span><span class=o>=</span><span class=kc>False</span>
</span><span id=__span-1-9><a id=__codelineno-1-9 name=__codelineno-1-9 href=#__codelineno-1-9></a><span class=p>)</span>
</span></code></pre></div> <p>Class that represents a relative range.</p> <p>Method generated by attrs for class RelRange.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.RelRange.is_gap>is_gap <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.RelRange.is_gap title="Permanent link">&para;</a></h3> <p>Whether the range acts as a gap.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.RelRange.length>length <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.RelRange.length title="Permanent link">&para;</a></h3> <p>Length.</p> <p>Floating values between 0 and 1 are considered relative.</p> <p>Can be negative.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.RelRange.length_space>length_space <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.RelRange.length_space title="Permanent link">&para;</a></h3> <p>Length space.</p> <p>Supported are</p> <ul> <li>'all': All space</li> <li>'free': Remaining space after the offset</li> <li>'free_or_prev': Remaining space after the offset or the start/end of the previous range, depending what comes first in the direction of <a href=index.html#vectorbtpro.generic.splitting.base.RelRange.length title=vectorbtpro.generic.splitting.base.RelRange.length>RelRange.length</a></li> </ul> <p>Applied only when <a href=index.html#vectorbtpro.generic.splitting.base.RelRange.length title=vectorbtpro.generic.splitting.base.RelRange.length>RelRange.length</a> is a relative number.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.RelRange.offset>offset <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.RelRange.offset title="Permanent link">&para;</a></h3> <p>Offset.</p> <p>Floating values between 0 and 1 are considered relative.</p> <p>Can be negative.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.RelRange.offset_anchor>offset_anchor <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.RelRange.offset_anchor title="Permanent link">&para;</a></h3> <p>Offset anchor.</p> <p>Supported are</p> <ul> <li>'start': Start of the range</li> <li>'end': End of the range</li> <li>'prev_start': Start of the previous range</li> <li>'prev_end': End of the previous range</li> </ul> <hr> <h3 id=vectorbtpro.generic.splitting.base.RelRange.offset_space>offset_space <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.RelRange.offset_space title="Permanent link">&para;</a></h3> <p>Offset space.</p> <p>Supported are</p> <ul> <li>'all': All space</li> <li>'free': Remaining space after the offset anchor</li> <li>'prev': Length of the previous range</li> </ul> <p>Applied only when <a href=index.html#vectorbtpro.generic.splitting.base.RelRange.offset title=vectorbtpro.generic.splitting.base.RelRange.offset>RelRange.offset</a> is a relative number.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.RelRange.out_of_bounds>out_of_bounds <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.RelRange.out_of_bounds title="Permanent link">&para;</a></h3> <p>Check if start and stop are within bounds.</p> <p>Supported are</p> <ul> <li>'keep': Keep out-of-bounds values</li> <li>'ignore': Ignore if out-of-bounds</li> <li>'warn': Emit a warning if out-of-bounds</li> <li>'raise": Raise an error if out-of-bounds</li> </ul> <hr> <h3 id=vectorbtpro.generic.splitting.base.RelRange.to_slice>to_slice <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L153-L301 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.RelRange.to_slice title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-2-1><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a><span class=n>RelRange</span><span class=o>.</span><span class=n>to_slice</span><span class=p>(</span>
</span><span id=__span-2-2><a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a> <span class=n>total_len</span><span class=p>,</span>
</span><span id=__span-2-3><a id=__codelineno-2-3 name=__codelineno-2-3 href=#__codelineno-2-3></a> <span class=n>prev_start</span><span class=o>=</span><span class=mi>0</span><span class=p>,</span>
</span><span id=__span-2-4><a id=__codelineno-2-4 name=__codelineno-2-4 href=#__codelineno-2-4></a> <span class=n>prev_end</span><span class=o>=</span><span class=mi>0</span><span class=p>,</span>
</span><span id=__span-2-5><a id=__codelineno-2-5 name=__codelineno-2-5 href=#__codelineno-2-5></a> <span class=n>index</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-2-6><a id=__codelineno-2-6 name=__codelineno-2-6 href=#__codelineno-2-6></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-2-7><a id=__codelineno-2-7 name=__codelineno-2-7 href=#__codelineno-2-7></a><span class=p>)</span>
</span></code></pre></div> <p>Convert the relative range into a slice.</p> <hr> <h2 id=vectorbtpro.generic.splitting.base.SKLSplitter>SKLSplitter <span class=dobjtype>class</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L5068-L5245 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.SKLSplitter title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-3-1><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a><span class=n>SKLSplitter</span><span class=p>(</span>
</span><span id=__span-3-2><a id=__codelineno-3-2 name=__codelineno-3-2 href=#__codelineno-3-2></a> <span class=n>method</span><span class=p>,</span>
</span><span id=__span-3-3><a id=__codelineno-3-3 name=__codelineno-3-3 href=#__codelineno-3-3></a> <span class=o>*</span><span class=n>method_args</span><span class=p>,</span>
</span><span id=__span-3-4><a id=__codelineno-3-4 name=__codelineno-3-4 href=#__codelineno-3-4></a> <span class=n>splitter_cls</span><span class=o>=</span><span class=n>vectorbtpro</span><span class=o>.</span><span class=n>generic</span><span class=o>.</span><span class=n>splitting</span><span class=o>.</span><span class=n>base</span><span class=o>.</span><span class=n>Splitter</span><span class=p>,</span>
</span><span id=__span-3-5><a id=__codelineno-3-5 name=__codelineno-3-5 href=#__codelineno-3-5></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-3-6><a id=__codelineno-3-6 name=__codelineno-3-6 href=#__codelineno-3-6></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-3-7><a id=__codelineno-3-7 name=__codelineno-3-7 href=#__codelineno-3-7></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-3-8><a id=__codelineno-3-8 name=__codelineno-3-8 href=#__codelineno-3-8></a> <span class=o>**</span><span class=n>method_kwargs</span>
</span><span id=__span-3-9><a id=__codelineno-3-9 name=__codelineno-3-9 href=#__codelineno-3-9></a><span class=p>)</span>
</span></code></pre></div> <p>Split iterator based on <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a>.</p> <p><strong>Args</strong></p> <dl> <dt><strong><code>method</code></strong> :&ensp;<code>str</code> or <code>callable</code></dt> <dd>Method that returns an instance of <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a>.</dd> <dt><strong><code>*method_args</code></strong></dt> <dd>Positional arguments passed to <code>method</code>.</dd> <dt><strong><code>splitter_cls</code></strong> :&ensp;<code>type</code></dt> <dd>Splitter class.</dd> <dt><strong><code>split_group_by</code></strong> :&ensp;<code>any</code></dt> <dd> <p>Split groups. See <a href=../../../base/accessors/index.html#vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper title=vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper>BaseIDXAccessor.get_grouper()</a>.</p> <p>Not passed to <code>method</code>.</p> </dd> <dt><strong><code>set_group_by</code></strong> :&ensp;<code>any</code></dt> <dd> <p>Set groups. See <a href=../../../base/accessors/index.html#vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper title=vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper>BaseIDXAccessor.get_grouper()</a>.</p> <p>Not passed to <code>method</code>.</p> </dd> <dt><strong><code>template_context</code></strong> :&ensp;<code>dict</code></dt> <dd> <p>Mapping used to substitute templates in ranges.</p> <p>Passed to <code>method</code>.</p> </dd> <dt><strong><code>**method_kwargs</code></strong></dt> <dd>Keyword arguments passed to <code>method</code>.</dd> </dl> <p><strong>Usage</strong></p> <ul> <li>Replicate <code>TimeSeriesSplit</code> from scikit-learn:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-4-1><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-4-2><a id=__codelineno-4-2 name=__codelineno-4-2 href=#__codelineno-4-2></a>
</span><span id=__span-4-3><a id=__codelineno-4-3 name=__codelineno-4-3 href=#__codelineno-4-3></a><span class=gp>&gt;&gt;&gt; </span><span class=n>X</span> <span class=o>=</span> <span class=n>np</span><span class=o>.</span><span class=n>array</span><span class=p>([[</span><span class=mi>1</span><span class=p>,</span> <span class=mi>2</span><span class=p>],</span> <span class=p>[</span><span class=mi>3</span><span class=p>,</span> <span class=mi>4</span><span class=p>],</span> <span class=p>[</span><span class=mi>5</span><span class=p>,</span> <span class=mi>6</span><span class=p>],</span> <span class=p>[</span><span class=mi>7</span><span class=p>,</span> <span class=mi>8</span><span class=p>]])</span>
</span><span id=__span-4-4><a id=__codelineno-4-4 name=__codelineno-4-4 href=#__codelineno-4-4></a><span class=gp>&gt;&gt;&gt; </span><span class=n>y</span> <span class=o>=</span> <span class=n>np</span><span class=o>.</span><span class=n>array</span><span class=p>([</span><span class=mi>1</span><span class=p>,</span> <span class=mi>2</span><span class=p>,</span> <span class=mi>3</span><span class=p>,</span> <span class=mi>4</span><span class=p>])</span>
</span><span id=__span-4-5><a id=__codelineno-4-5 name=__codelineno-4-5 href=#__codelineno-4-5></a>
</span><span id=__span-4-6><a id=__codelineno-4-6 name=__codelineno-4-6 href=#__codelineno-4-6></a><span class=gp>&gt;&gt;&gt; </span><span class=n>tscv</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>SKLSplitter</span><span class=p>(</span>
</span><span id=__span-4-7><a id=__codelineno-4-7 name=__codelineno-4-7 href=#__codelineno-4-7></a><span class=gp>... </span> <span class=s2>&quot;from_expanding&quot;</span><span class=p>,</span>
</span><span id=__span-4-8><a id=__codelineno-4-8 name=__codelineno-4-8 href=#__codelineno-4-8></a><span class=gp>... </span> <span class=n>min_length</span><span class=o>=</span><span class=mi>2</span><span class=p>,</span>
</span><span id=__span-4-9><a id=__codelineno-4-9 name=__codelineno-4-9 href=#__codelineno-4-9></a><span class=gp>... </span> <span class=n>offset</span><span class=o>=</span><span class=mi>1</span><span class=p>,</span>
</span><span id=__span-4-10><a id=__codelineno-4-10 name=__codelineno-4-10 href=#__codelineno-4-10></a><span class=gp>... </span> <span class=n>split</span><span class=o>=-</span><span class=mi>1</span>
</span><span id=__span-4-11><a id=__codelineno-4-11 name=__codelineno-4-11 href=#__codelineno-4-11></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-4-12><a id=__codelineno-4-12 name=__codelineno-4-12 href=#__codelineno-4-12></a><span class=gp>&gt;&gt;&gt; </span><span class=k>for</span> <span class=n>i</span><span class=p>,</span> <span class=p>(</span><span class=n>train_indices</span><span class=p>,</span> <span class=n>test_indices</span><span class=p>)</span> <span class=ow>in</span> <span class=nb>enumerate</span><span class=p>(</span><span class=n>tscv</span><span class=o>.</span><span class=n>split</span><span class=p>(</span><span class=n>X</span><span class=p>)):</span>
</span><span id=__span-4-13><a id=__codelineno-4-13 name=__codelineno-4-13 href=#__codelineno-4-13></a><span class=gp>... </span> <span class=nb>print</span><span class=p>(</span><span class=s2>&quot;Split </span><span class=si>%d</span><span class=s2>:&quot;</span> <span class=o>%</span> <span class=n>i</span><span class=p>)</span>
</span><span id=__span-4-14><a id=__codelineno-4-14 name=__codelineno-4-14 href=#__codelineno-4-14></a><span class=gp>... </span> <span class=n>X_train</span><span class=p>,</span> <span class=n>X_test</span> <span class=o>=</span> <span class=n>X</span><span class=p>[</span><span class=n>train_indices</span><span class=p>],</span> <span class=n>X</span><span class=p>[</span><span class=n>test_indices</span><span class=p>]</span>
</span><span id=__span-4-15><a id=__codelineno-4-15 name=__codelineno-4-15 href=#__codelineno-4-15></a><span class=gp>... </span> <span class=nb>print</span><span class=p>(</span><span class=s2>&quot; X:&quot;</span><span class=p>,</span> <span class=n>X_train</span><span class=o>.</span><span class=n>tolist</span><span class=p>(),</span> <span class=n>X_test</span><span class=o>.</span><span class=n>tolist</span><span class=p>())</span>
</span><span id=__span-4-16><a id=__codelineno-4-16 name=__codelineno-4-16 href=#__codelineno-4-16></a><span class=gp>... </span> <span class=n>y_train</span><span class=p>,</span> <span class=n>y_test</span> <span class=o>=</span> <span class=n>y</span><span class=p>[</span><span class=n>train_indices</span><span class=p>],</span> <span class=n>y</span><span class=p>[</span><span class=n>test_indices</span><span class=p>]</span>
</span><span id=__span-4-17><a id=__codelineno-4-17 name=__codelineno-4-17 href=#__codelineno-4-17></a><span class=gp>... </span> <span class=nb>print</span><span class=p>(</span><span class=s2>&quot; y:&quot;</span><span class=p>,</span> <span class=n>y_train</span><span class=o>.</span><span class=n>tolist</span><span class=p>(),</span> <span class=n>y_test</span><span class=o>.</span><span class=n>tolist</span><span class=p>())</span>
</span><span id=__span-4-18><a id=__codelineno-4-18 name=__codelineno-4-18 href=#__codelineno-4-18></a><span class=go>Split 0:</span>
</span><span id=__span-4-19><a id=__codelineno-4-19 name=__codelineno-4-19 href=#__codelineno-4-19></a><span class=go> X: [[1, 2]] [[3, 4]]</span>
</span><span id=__span-4-20><a id=__codelineno-4-20 name=__codelineno-4-20 href=#__codelineno-4-20></a><span class=go> y: [1] [2]</span>
</span><span id=__span-4-21><a id=__codelineno-4-21 name=__codelineno-4-21 href=#__codelineno-4-21></a><span class=go>Split 1:</span>
</span><span id=__span-4-22><a id=__codelineno-4-22 name=__codelineno-4-22 href=#__codelineno-4-22></a><span class=go> X: [[1, 2], [3, 4]] [[5, 6]]</span>
</span><span id=__span-4-23><a id=__codelineno-4-23 name=__codelineno-4-23 href=#__codelineno-4-23></a><span class=go> y: [1, 2] [3]</span>
</span><span id=__span-4-24><a id=__codelineno-4-24 name=__codelineno-4-24 href=#__codelineno-4-24></a><span class=go>Split 2:</span>
</span><span id=__span-4-25><a id=__codelineno-4-25 name=__codelineno-4-25 href=#__codelineno-4-25></a><span class=go> X: [[1, 2], [3, 4], [5, 6]] [[7, 8]]</span>
</span><span id=__span-4-26><a id=__codelineno-4-26 name=__codelineno-4-26 href=#__codelineno-4-26></a><span class=go> y: [1, 2, 3] [4]</span>
</span></code></pre></div> <p><strong>Superclasses</strong></p> <ul> <li><code>sklearn.model_selection._split.BaseCrossValidator</code></li> </ul> <hr> <h3 id=vectorbtpro.generic.splitting.base.SKLSplitter.get_n_splits>get_n_splits <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L5228-L5236 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.SKLSplitter.get_n_splits title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-5-1><a id=__codelineno-5-1 name=__codelineno-5-1 href=#__codelineno-5-1></a><span class=n>SKLSplitter</span><span class=o>.</span><span class=n>get_n_splits</span><span class=p>(</span>
</span><span id=__span-5-2><a id=__codelineno-5-2 name=__codelineno-5-2 href=#__codelineno-5-2></a> <span class=n>X</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-5-3><a id=__codelineno-5-3 name=__codelineno-5-3 href=#__codelineno-5-3></a> <span class=n>y</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-5-4><a id=__codelineno-5-4 name=__codelineno-5-4 href=#__codelineno-5-4></a> <span class=n>groups</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-5-5><a id=__codelineno-5-5 name=__codelineno-5-5 href=#__codelineno-5-5></a><span class=p>)</span>
</span></code></pre></div> <p>Returns the number of splitting iterations in the cross-validator.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.SKLSplitter.get_splitter>get_splitter <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L5137-L5161 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.SKLSplitter.get_splitter title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-6-1><a id=__codelineno-6-1 name=__codelineno-6-1 href=#__codelineno-6-1></a><span class=n>SKLSplitter</span><span class=o>.</span><span class=n>get_splitter</span><span class=p>(</span>
</span><span id=__span-6-2><a id=__codelineno-6-2 name=__codelineno-6-2 href=#__codelineno-6-2></a> <span class=n>X</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-6-3><a id=__codelineno-6-3 name=__codelineno-6-3 href=#__codelineno-6-3></a> <span class=n>y</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-6-4><a id=__codelineno-6-4 name=__codelineno-6-4 href=#__codelineno-6-4></a> <span class=n>groups</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-6-5><a id=__codelineno-6-5 name=__codelineno-6-5 href=#__codelineno-6-5></a><span class=p>)</span>
</span></code></pre></div> <p>Get splitter of type <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.SKLSplitter.split>split <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L5238-L5245 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.SKLSplitter.split title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-7-1><a id=__codelineno-7-1 name=__codelineno-7-1 href=#__codelineno-7-1></a><span class=n>SKLSplitter</span><span class=o>.</span><span class=n>split</span><span class=p>(</span>
</span><span id=__span-7-2><a id=__codelineno-7-2 name=__codelineno-7-2 href=#__codelineno-7-2></a> <span class=n>X</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-7-3><a id=__codelineno-7-3 name=__codelineno-7-3 href=#__codelineno-7-3></a> <span class=n>y</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-7-4><a id=__codelineno-7-4 name=__codelineno-7-4 href=#__codelineno-7-4></a> <span class=n>groups</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-7-5><a id=__codelineno-7-5 name=__codelineno-7-5 href=#__codelineno-7-5></a><span class=p>)</span>
</span></code></pre></div> <p>Generate indices to split data into training and test set.</p> <hr> <h2 id=vectorbtpro.generic.splitting.base.Splitter>Splitter <span class=dobjtype>class</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L333-L5058 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-8-1><a id=__codelineno-8-1 name=__codelineno-8-1 href=#__codelineno-8-1></a><span class=n>Splitter</span><span class=p>(</span>
</span><span id=__span-8-2><a id=__codelineno-8-2 name=__codelineno-8-2 href=#__codelineno-8-2></a> <span class=n>wrapper</span><span class=p>,</span>
</span><span id=__span-8-3><a id=__codelineno-8-3 name=__codelineno-8-3 href=#__codelineno-8-3></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-8-4><a id=__codelineno-8-4 name=__codelineno-8-4 href=#__codelineno-8-4></a> <span class=n>splits_arr</span><span class=p>,</span>
</span><span id=__span-8-5><a id=__codelineno-8-5 name=__codelineno-8-5 href=#__codelineno-8-5></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-8-6><a id=__codelineno-8-6 name=__codelineno-8-6 href=#__codelineno-8-6></a><span class=p>)</span>
</span></code></pre></div> <p>Base class for splitting.</p> <p><strong>Superclasses</strong></p> <ul> <li><a href=../../analyzable/index.html#vectorbtpro.generic.analyzable.Analyzable title=vectorbtpro.generic.analyzable.Analyzable>Analyzable</a></li> <li><a href=../../../utils/attr_/index.html#vectorbtpro.utils.attr_.AttrResolverMixin title=vectorbtpro.utils.attr_.AttrResolverMixin>AttrResolverMixin</a></li> <li><a href=../../../utils/caching/index.html#vectorbtpro.utils.caching.Cacheable title=vectorbtpro.utils.caching.Cacheable>Cacheable</a></li> <li><a href=../../../utils/chaining/index.html#vectorbtpro.utils.chaining.Chainable title=vectorbtpro.utils.chaining.Chainable>Chainable</a></li> <li><a href=../../../utils/checks/index.html#vectorbtpro.utils.checks.Comparable title=vectorbtpro.utils.checks.Comparable>Comparable</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.Configured title=vectorbtpro.utils.config.Configured>Configured</a></li> <li><a href=../../../base/indexing/index.html#vectorbtpro.base.indexing.ExtPandasIndexer title=vectorbtpro.base.indexing.ExtPandasIndexer>ExtPandasIndexer</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings title=vectorbtpro.utils.config.HasSettings>HasSettings</a></li> <li><a href=../../../base/indexing/index.html#vectorbtpro.base.indexing.IndexingBase title=vectorbtpro.base.indexing.IndexingBase>IndexingBase</a></li> <li><a href=../../../base/indexing/index.html#vectorbtpro.base.indexing.PandasIndexer title=vectorbtpro.base.indexing.PandasIndexer>PandasIndexer</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable title=vectorbtpro.utils.pickling.Pickleable>Pickleable</a></li> <li><a href=../../plots_builder/index.html#vectorbtpro.generic.plots_builder.PlotsBuilderMixin title=vectorbtpro.generic.plots_builder.PlotsBuilderMixin>PlotsBuilderMixin</a></li> <li><a href=../../../utils/formatting/index.html#vectorbtpro.utils.formatting.Prettified title=vectorbtpro.utils.formatting.Prettified>Prettified</a></li> <li><a href=../../stats_builder/index.html#vectorbtpro.generic.stats_builder.StatsBuilderMixin title=vectorbtpro.generic.stats_builder.StatsBuilderMixin>StatsBuilderMixin</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping title=vectorbtpro.base.wrapping.Wrapping>Wrapping</a></li> </ul> <p><strong>Inherited members</strong></p> <ul> <li><a href=../../../utils/attr_/index.html#vectorbtpro.utils.attr_.AttrResolverMixin.cls_dir title=vectorbtpro.generic.analyzable.Analyzable.cls_dir>Analyzable.cls_dir</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping.column_only_select title=vectorbtpro.generic.analyzable.Analyzable.column_only_select>Analyzable.column_only_select</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.Configured.config title=vectorbtpro.generic.analyzable.Analyzable.config>Analyzable.config</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping.group_select title=vectorbtpro.generic.analyzable.Analyzable.group_select>Analyzable.group_select</a></li> <li><a href=../../../base/indexing/index.html#vectorbtpro.base.indexing.PandasIndexer.iloc title=vectorbtpro.generic.analyzable.Analyzable.iloc>Analyzable.iloc</a></li> <li><a href=../../../base/indexing/index.html#vectorbtpro.base.indexing.PandasIndexer.indexing_kwargs title=vectorbtpro.generic.analyzable.Analyzable.indexing_kwargs>Analyzable.indexing_kwargs</a></li> <li><a href=../../../base/indexing/index.html#vectorbtpro.base.indexing.PandasIndexer.loc title=vectorbtpro.generic.analyzable.Analyzable.loc>Analyzable.loc</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping.range_only_select title=vectorbtpro.generic.analyzable.Analyzable.range_only_select>Analyzable.range_only_select</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.rec_state title=vectorbtpro.generic.analyzable.Analyzable.rec_state>Analyzable.rec_state</a></li> <li><a href=../../../utils/attr_/index.html#vectorbtpro.utils.attr_.AttrResolverMixin.self_aliases title=vectorbtpro.generic.analyzable.Analyzable.self_aliases>Analyzable.self_aliases</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping.wrapper title=vectorbtpro.generic.analyzable.Analyzable.wrapper>Analyzable.wrapper</a></li> <li><a href=../../../base/indexing/index.html#vectorbtpro.base.indexing.ExtPandasIndexer.xloc title=vectorbtpro.generic.analyzable.Analyzable.xloc>Analyzable.xloc</a></li> <li><a href=../../../utils/attr_/index.html#vectorbtpro.utils.attr_.AttrResolverMixin.deep_getattr title=vectorbtpro.generic.analyzable.Analyzable.deep_getattr>AttrResolverMixin.deep_getattr()</a></li> <li><a href=../../../utils/attr_/index.html#vectorbtpro.utils.attr_.AttrResolverMixin.post_resolve_attr title=vectorbtpro.generic.analyzable.Analyzable.post_resolve_attr>AttrResolverMixin.post_resolve_attr()</a></li> <li><a href=../../../utils/attr_/index.html#vectorbtpro.utils.attr_.AttrResolverMixin.pre_resolve_attr title=vectorbtpro.generic.analyzable.Analyzable.pre_resolve_attr>AttrResolverMixin.pre_resolve_attr()</a></li> <li><a href=../../../utils/attr_/index.html#vectorbtpro.utils.attr_.AttrResolverMixin.resolve_attr title=vectorbtpro.generic.analyzable.Analyzable.resolve_attr>AttrResolverMixin.resolve_attr()</a></li> <li><a href=../../../utils/attr_/index.html#vectorbtpro.utils.attr_.AttrResolverMixin.resolve_shortcut_attr title=vectorbtpro.generic.analyzable.Analyzable.resolve_shortcut_attr>AttrResolverMixin.resolve_shortcut_attr()</a></li> <li><a href=../../../utils/caching/index.html#vectorbtpro.utils.caching.Cacheable.get_ca_setup title=vectorbtpro.generic.analyzable.Analyzable.get_ca_setup>Cacheable.get_ca_setup()</a></li> <li><a href=../../../utils/chaining/index.html#vectorbtpro.utils.chaining.Chainable.pipe title=vectorbtpro.generic.analyzable.Analyzable.pipe>Chainable.pipe()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.Configured.copy title=vectorbtpro.generic.analyzable.Analyzable.copy>Configured.copy()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.Configured.equals title=vectorbtpro.generic.analyzable.Analyzable.equals>Configured.equals()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.Configured.get_writeable_attrs title=vectorbtpro.generic.analyzable.Analyzable.get_writeable_attrs>Configured.get_writeable_attrs()</a></li> <li><a href=../../../utils/formatting/index.html#vectorbtpro.utils.formatting.Prettified.prettify title=vectorbtpro.generic.analyzable.Analyzable.prettify>Configured.prettify()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.Configured.replace title=vectorbtpro.generic.analyzable.Analyzable.replace>Configured.replace()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.Configured.resolve_merge_kwargs title=vectorbtpro.generic.analyzable.Analyzable.resolve_merge_kwargs>Configured.resolve_merge_kwargs()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.Configured.update_config title=vectorbtpro.generic.analyzable.Analyzable.update_config>Configured.update_config()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.get_path_setting title=vectorbtpro.generic.analyzable.Analyzable.get_path_setting>HasSettings.get_path_setting()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.get_path_settings title=vectorbtpro.generic.analyzable.Analyzable.get_path_settings>HasSettings.get_path_settings()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.get_setting title=vectorbtpro.generic.analyzable.Analyzable.get_setting>HasSettings.get_setting()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.get_settings title=vectorbtpro.generic.analyzable.Analyzable.get_settings>HasSettings.get_settings()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.has_path_setting title=vectorbtpro.generic.analyzable.Analyzable.has_path_setting>HasSettings.has_path_setting()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.has_path_settings title=vectorbtpro.generic.analyzable.Analyzable.has_path_settings>HasSettings.has_path_settings()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.has_setting title=vectorbtpro.generic.analyzable.Analyzable.has_setting>HasSettings.has_setting()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.has_settings title=vectorbtpro.generic.analyzable.Analyzable.has_settings>HasSettings.has_settings()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.reset_settings title=vectorbtpro.generic.analyzable.Analyzable.reset_settings>HasSettings.reset_settings()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.resolve_setting title=vectorbtpro.generic.analyzable.Analyzable.resolve_setting>HasSettings.resolve_setting()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.resolve_settings_paths title=vectorbtpro.generic.analyzable.Analyzable.resolve_settings_paths>HasSettings.resolve_settings_paths()</a></li> <li><a href=../../../utils/config/index.html#vectorbtpro.utils.config.HasSettings.set_settings title=vectorbtpro.generic.analyzable.Analyzable.set_settings>HasSettings.set_settings()</a></li> <li><a href=../../../base/indexing/index.html#vectorbtpro.base.indexing.IndexingBase.indexing_setter_func title=vectorbtpro.generic.analyzable.Analyzable.indexing_setter_func>IndexingBase.indexing_setter_func()</a></li> <li><a href=../../../base/indexing/index.html#vectorbtpro.base.indexing.PandasIndexer.xs title=vectorbtpro.generic.analyzable.Analyzable.xs>PandasIndexer.xs()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.decode_config title=vectorbtpro.generic.analyzable.Analyzable.decode_config>Pickleable.decode_config()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.decode_config_node title=vectorbtpro.generic.analyzable.Analyzable.decode_config_node>Pickleable.decode_config_node()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.dumps title=vectorbtpro.generic.analyzable.Analyzable.dumps>Pickleable.dumps()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.encode_config title=vectorbtpro.generic.analyzable.Analyzable.encode_config>Pickleable.encode_config()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.encode_config_node title=vectorbtpro.generic.analyzable.Analyzable.encode_config_node>Pickleable.encode_config_node()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.file_exists title=vectorbtpro.generic.analyzable.Analyzable.file_exists>Pickleable.file_exists()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.getsize title=vectorbtpro.generic.analyzable.Analyzable.getsize>Pickleable.getsize()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.load title=vectorbtpro.generic.analyzable.Analyzable.load>Pickleable.load()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.loads title=vectorbtpro.generic.analyzable.Analyzable.loads>Pickleable.loads()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.modify_state title=vectorbtpro.generic.analyzable.Analyzable.modify_state>Pickleable.modify_state()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.resolve_file_path title=vectorbtpro.generic.analyzable.Analyzable.resolve_file_path>Pickleable.resolve_file_path()</a></li> <li><a href=../../../utils/pickling/index.html#vectorbtpro.utils.pickling.Pickleable.save title=vectorbtpro.generic.analyzable.Analyzable.save>Pickleable.save()</a></li> <li><a href=../../plots_builder/index.html#vectorbtpro.generic.plots_builder.PlotsBuilderMixin.build_subplots_doc title=vectorbtpro.generic.analyzable.Analyzable.build_subplots_doc>PlotsBuilderMixin.build_subplots_doc()</a></li> <li><a href=../../plots_builder/index.html#vectorbtpro.generic.plots_builder.PlotsBuilderMixin.override_subplots_doc title=vectorbtpro.generic.analyzable.Analyzable.override_subplots_doc>PlotsBuilderMixin.override_subplots_doc()</a></li> <li><a href=../../plots_builder/index.html#vectorbtpro.generic.plots_builder.PlotsBuilderMixin.plots title=vectorbtpro.generic.analyzable.Analyzable.plots>PlotsBuilderMixin.plots()</a></li> <li><a href=../../stats_builder/index.html#vectorbtpro.generic.stats_builder.StatsBuilderMixin.build_metrics_doc title=vectorbtpro.generic.analyzable.Analyzable.build_metrics_doc>StatsBuilderMixin.build_metrics_doc()</a></li> <li><a href=../../stats_builder/index.html#vectorbtpro.generic.stats_builder.StatsBuilderMixin.override_metrics_doc title=vectorbtpro.generic.analyzable.Analyzable.override_metrics_doc>StatsBuilderMixin.override_metrics_doc()</a></li> <li><a href=../../stats_builder/index.html#vectorbtpro.generic.stats_builder.StatsBuilderMixin.stats title=vectorbtpro.generic.analyzable.Analyzable.stats>StatsBuilderMixin.stats()</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping.regroup title=vectorbtpro.generic.analyzable.Analyzable.regroup>Wrapping.regroup()</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping.resample title=vectorbtpro.generic.analyzable.Analyzable.resample>Wrapping.resample()</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping.resolve_self title=vectorbtpro.generic.analyzable.Analyzable.resolve_self>Wrapping.resolve_self()</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping.resolve_stack_kwargs title=vectorbtpro.generic.analyzable.Analyzable.resolve_stack_kwargs>Wrapping.resolve_stack_kwargs()</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping.select_col title=vectorbtpro.generic.analyzable.Analyzable.select_col>Wrapping.select_col()</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping.select_col_from_obj title=vectorbtpro.generic.analyzable.Analyzable.select_col_from_obj>Wrapping.select_col_from_obj()</a></li> <li><a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.Wrapping.split title=vectorbtpro.generic.analyzable.Analyzable.split>Wrapping.split()</a></li> </ul> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.apply>apply <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L3087-L3836 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.apply title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-9-1><a id=__codelineno-9-1 name=__codelineno-9-1 href=#__codelineno-9-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>apply</span><span class=p>(</span>
</span><span id=__span-9-2><a id=__codelineno-9-2 name=__codelineno-9-2 href=#__codelineno-9-2></a> <span class=n>apply_func</span><span class=p>,</span>
</span><span id=__span-9-3><a id=__codelineno-9-3 name=__codelineno-9-3 href=#__codelineno-9-3></a> <span class=o>*</span><span class=n>apply_args</span><span class=p>,</span>
</span><span id=__span-9-4><a id=__codelineno-9-4 name=__codelineno-9-4 href=#__codelineno-9-4></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-5><a id=__codelineno-9-5 name=__codelineno-9-5 href=#__codelineno-9-5></a> <span class=n>set_</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-6><a id=__codelineno-9-6 name=__codelineno-9-6 href=#__codelineno-9-6></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-7><a id=__codelineno-9-7 name=__codelineno-9-7 href=#__codelineno-9-7></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-8><a id=__codelineno-9-8 name=__codelineno-9-8 href=#__codelineno-9-8></a> <span class=n>squeeze_one_split</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-9-9><a id=__codelineno-9-9 name=__codelineno-9-9 href=#__codelineno-9-9></a> <span class=n>squeeze_one_set</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-9-10><a id=__codelineno-9-10 name=__codelineno-9-10 href=#__codelineno-9-10></a> <span class=n>remap_to_obj</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-9-11><a id=__codelineno-9-11 name=__codelineno-9-11 href=#__codelineno-9-11></a> <span class=n>obj_index</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-12><a id=__codelineno-9-12 name=__codelineno-9-12 href=#__codelineno-9-12></a> <span class=n>obj_freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-13><a id=__codelineno-9-13 name=__codelineno-9-13 href=#__codelineno-9-13></a> <span class=n>range_format</span><span class=o>=</span><span class=s1>&#39;slice_or_any&#39;</span><span class=p>,</span>
</span><span id=__span-9-14><a id=__codelineno-9-14 name=__codelineno-9-14 href=#__codelineno-9-14></a> <span class=n>point_wise</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-9-15><a id=__codelineno-9-15 name=__codelineno-9-15 href=#__codelineno-9-15></a> <span class=n>attach_bounds</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-9-16><a id=__codelineno-9-16 name=__codelineno-9-16 href=#__codelineno-9-16></a> <span class=n>right_inclusive</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-9-17><a id=__codelineno-9-17 name=__codelineno-9-17 href=#__codelineno-9-17></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-18><a id=__codelineno-9-18 name=__codelineno-9-18 href=#__codelineno-9-18></a> <span class=n>silence_warnings</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-9-19><a id=__codelineno-9-19 name=__codelineno-9-19 href=#__codelineno-9-19></a> <span class=n>index_combine_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-20><a id=__codelineno-9-20 name=__codelineno-9-20 href=#__codelineno-9-20></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-21><a id=__codelineno-9-21 name=__codelineno-9-21 href=#__codelineno-9-21></a> <span class=n>iteration</span><span class=o>=</span><span class=s1>&#39;split_wise&#39;</span><span class=p>,</span>
</span><span id=__span-9-22><a id=__codelineno-9-22 name=__codelineno-9-22 href=#__codelineno-9-22></a> <span class=n>execute_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-23><a id=__codelineno-9-23 name=__codelineno-9-23 href=#__codelineno-9-23></a> <span class=n>merge_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-24><a id=__codelineno-9-24 name=__codelineno-9-24 href=#__codelineno-9-24></a> <span class=n>merge_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-9-25><a id=__codelineno-9-25 name=__codelineno-9-25 href=#__codelineno-9-25></a> <span class=n>merge_all</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-9-26><a id=__codelineno-9-26 name=__codelineno-9-26 href=#__codelineno-9-26></a> <span class=n>wrap_results</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-9-27><a id=__codelineno-9-27 name=__codelineno-9-27 href=#__codelineno-9-27></a> <span class=o>**</span><span class=n>apply_kwargs</span>
</span><span id=__span-9-28><a id=__codelineno-9-28 name=__codelineno-9-28 href=#__codelineno-9-28></a><span class=p>)</span>
</span></code></pre></div> <p>Apply a function on each range.</p> <p>Uses <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.select_indices title=vectorbtpro.generic.splitting.base.Splitter.select_indices>Splitter.select_indices()</a> to get the indices for selected splits and sets. Arguments <code>split_group_by</code> and <code>set_group_by</code> can be used to group splits and sets respectively. Ranges belonging to the same split and set group will be merged.</p> <p>For each index pair, in a lazily manner, resolves the source range using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.select_range title=vectorbtpro.generic.splitting.base.Splitter.select_range>Splitter.select_range()</a> and <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_ready_range title=vectorbtpro.generic.splitting.base.Splitter.get_ready_range>Splitter.get_ready_range()</a>. Then, takes each argument from <code>args</code> and <code>kwargs</code> wrapped with <a href=index.html#vectorbtpro.generic.splitting.base.Takeable title=vectorbtpro.generic.splitting.base.Takeable>Takeable</a>, remaps the range into each object's index using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_ready_obj_range title=vectorbtpro.generic.splitting.base.Splitter.get_ready_obj_range>Splitter.get_ready_obj_range()</a>, and takes the slice from that object using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.take_range title=vectorbtpro.generic.splitting.base.Splitter.take_range>Splitter.take_range()</a>. The original object will be substituted by this slice. At the end, substitutes any templates in the prepared <code>args</code> and <code>kwargs</code> and saves the function and arguments for execution.</p> <p>For substitution, the following information is available:</p> <ul> <li><code>split/set_group_indices</code>: Indices corresponding to the selected row/column groups</li> <li><code>split/set_indices</code>: Indices corresponding to the selected rows/columns</li> <li><code>n_splits/sets</code>: Number of the selected rows/columns</li> <li><code>split/set_labels</code>: Labels corresponding to the selected row/column groups</li> <li><code>split/set_idx</code>: Index of the selected row/column</li> <li><code>split/set_label</code>: Label of the selected row/column</li> <li><code>range_</code>: Selected range ready for indexing (see <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_ready_range title=vectorbtpro.generic.splitting.base.Splitter.get_ready_range>Splitter.get_ready_range()</a>)</li> <li><code>range_meta</code>: Various information on the selected range</li> <li><code>obj_range_meta</code>: Various information on the range taken from each takeable argument. Positional arguments are denoted by position, keyword arguments are denoted by keys.</li> <li><code>args</code>: Positional arguments with ranges already selected</li> <li><code>kwargs</code>: Keyword arguments with ranges already selected</li> <li><code>bounds</code>: A tuple of either integer or index bounds. Can be source or target depending on <code>attach_bounds</code>.</li> <li><code>template_context</code>: Passed template context</li> </ul> <p>Since each range is processed lazily (that is, upon request), there are multiple iteration modes controlled by the argument <code>iteration</code>:</p> <ul> <li>'split_major': Flatten all ranges in split-major order and iterate over them</li> <li>'set_major': Flatten all ranges in set-major order and iterate over them</li> <li>'split_wise': Iterate over splits, while ranges in each split are processed sequentially</li> <li>'set_wise': Iterate over sets, while ranges in each set are processed sequentially</li> </ul> <p>The execution is done using <a href=../../../utils/execution/index.html#vectorbtpro.utils.execution.execute title=vectorbtpro.utils.execution.execute>execute()</a> with <code>execute_kwargs</code>. Once all results have been obtained, attempts to merge them using <code>merge_func</code> with <code>merge_kwargs</code> (all templates in it will be substituted as well), which can also be a string or a tuple of strings resolved using <a href=../../../base/merging/index.html#vectorbtpro.base.merging.resolve_merge_func title=vectorbtpro.base.merging.resolve_merge_func>resolve_merge_func()</a>. If <code>wrap_results</code> is enabled, packs the results into a Pandas object. If <code>apply_func</code> returns something complex, the resulting Pandas object will be of object data type. If <code>apply_func</code> returns a tuple (detected by the first returned result), a Pandas object is built for each element of that tuple.</p> <p>If <code>merge_all</code> is True, will merge all results in a flattened manner irrespective of the iteration mode. Otherwise, will merge by split/set.</p> <p>If <a href=../../../utils/selection/index.html#vectorbtpro.utils.selection.NoResult title=vectorbtpro.utils.selection.NoResult>NoResult</a> is returned, will skip the current iteration and remove it from the final index.</p> <p><strong>Usage</strong></p> <ul> <li>Get the return of each data range:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-10-1><a id=__codelineno-10-1 name=__codelineno-10-1 href=#__codelineno-10-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-10-2><a id=__codelineno-10-2 name=__codelineno-10-2 href=#__codelineno-10-2></a>
</span><span id=__span-10-3><a id=__codelineno-10-3 name=__codelineno-10-3 href=#__codelineno-10-3></a><span class=gp>&gt;&gt;&gt; </span><span class=n>data</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>YFData</span><span class=o>.</span><span class=n>pull</span><span class=p>(</span>
</span><span id=__span-10-4><a id=__codelineno-10-4 name=__codelineno-10-4 href=#__codelineno-10-4></a><span class=gp>... </span> <span class=s2>&quot;BTC-USD&quot;</span><span class=p>,</span>
</span><span id=__span-10-5><a id=__codelineno-10-5 name=__codelineno-10-5 href=#__codelineno-10-5></a><span class=gp>... </span> <span class=n>start</span><span class=o>=</span><span class=s2>&quot;2020-01-01 UTC&quot;</span><span class=p>,</span>
</span><span id=__span-10-6><a id=__codelineno-10-6 name=__codelineno-10-6 href=#__codelineno-10-6></a><span class=gp>... </span> <span class=n>end</span><span class=o>=</span><span class=s2>&quot;2021-01-01 UTC&quot;</span>
</span><span id=__span-10-7><a id=__codelineno-10-7 name=__codelineno-10-7 href=#__codelineno-10-7></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-10-8><a id=__codelineno-10-8 name=__codelineno-10-8 href=#__codelineno-10-8></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_n_rolling</span><span class=p>(</span><span class=n>data</span><span class=o>.</span><span class=n>wrapper</span><span class=o>.</span><span class=n>index</span><span class=p>,</span> <span class=mi>5</span><span class=p>)</span>
</span><span id=__span-10-9><a id=__codelineno-10-9 name=__codelineno-10-9 href=#__codelineno-10-9></a>
</span><span id=__span-10-10><a id=__codelineno-10-10 name=__codelineno-10-10 href=#__codelineno-10-10></a><span class=gp>&gt;&gt;&gt; </span><span class=k>def</span> <span class=nf>apply_func</span><span class=p>(</span><span class=n>data</span><span class=p>):</span>
</span><span id=__span-10-11><a id=__codelineno-10-11 name=__codelineno-10-11 href=#__codelineno-10-11></a><span class=gp>... </span> <span class=k>return</span> <span class=n>data</span><span class=o>.</span><span class=n>close</span><span class=o>.</span><span class=n>iloc</span><span class=p>[</span><span class=o>-</span><span class=mi>1</span><span class=p>]</span> <span class=o>-</span> <span class=n>data</span><span class=o>.</span><span class=n>close</span><span class=o>.</span><span class=n>iloc</span><span class=p>[</span><span class=mi>0</span><span class=p>]</span>
</span><span id=__span-10-12><a id=__codelineno-10-12 name=__codelineno-10-12 href=#__codelineno-10-12></a>
</span><span id=__span-10-13><a id=__codelineno-10-13 name=__codelineno-10-13 href=#__codelineno-10-13></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>apply</span><span class=p>(</span><span class=n>apply_func</span><span class=p>,</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Takeable</span><span class=p>(</span><span class=n>data</span><span class=p>))</span>
</span><span id=__span-10-14><a id=__codelineno-10-14 name=__codelineno-10-14 href=#__codelineno-10-14></a><span class=go>split</span>
</span><span id=__span-10-15><a id=__codelineno-10-15 name=__codelineno-10-15 href=#__codelineno-10-15></a><span class=go>0 -1636.467285</span>
</span><span id=__span-10-16><a id=__codelineno-10-16 name=__codelineno-10-16 href=#__codelineno-10-16></a><span class=go>1 3706.568359</span>
</span><span id=__span-10-17><a id=__codelineno-10-17 name=__codelineno-10-17 href=#__codelineno-10-17></a><span class=go>2 2944.720703</span>
</span><span id=__span-10-18><a id=__codelineno-10-18 name=__codelineno-10-18 href=#__codelineno-10-18></a><span class=go>3 -118.113281</span>
</span><span id=__span-10-19><a id=__codelineno-10-19 name=__codelineno-10-19 href=#__codelineno-10-19></a><span class=go>4 17098.916016</span>
</span><span id=__span-10-20><a id=__codelineno-10-20 name=__codelineno-10-20 href=#__codelineno-10-20></a><span class=go>dtype: float64</span>
</span></code></pre></div> <ul> <li>The same but by indexing manually:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-11-1><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a><span class=gp>&gt;&gt;&gt; </span><span class=k>def</span> <span class=nf>apply_func</span><span class=p>(</span><span class=n>range_</span><span class=p>,</span> <span class=n>data</span><span class=p>):</span>
</span><span id=__span-11-2><a id=__codelineno-11-2 name=__codelineno-11-2 href=#__codelineno-11-2></a><span class=gp>... </span> <span class=n>data</span> <span class=o>=</span> <span class=n>data</span><span class=o>.</span><span class=n>iloc</span><span class=p>[</span><span class=n>range_</span><span class=p>]</span>
</span><span id=__span-11-3><a id=__codelineno-11-3 name=__codelineno-11-3 href=#__codelineno-11-3></a><span class=gp>... </span> <span class=k>return</span> <span class=n>data</span><span class=o>.</span><span class=n>close</span><span class=o>.</span><span class=n>iloc</span><span class=p>[</span><span class=o>-</span><span class=mi>1</span><span class=p>]</span> <span class=o>-</span> <span class=n>data</span><span class=o>.</span><span class=n>close</span><span class=o>.</span><span class=n>iloc</span><span class=p>[</span><span class=mi>0</span><span class=p>]</span>
</span><span id=__span-11-4><a id=__codelineno-11-4 name=__codelineno-11-4 href=#__codelineno-11-4></a>
</span><span id=__span-11-5><a id=__codelineno-11-5 name=__codelineno-11-5 href=#__codelineno-11-5></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>apply</span><span class=p>(</span><span class=n>apply_func</span><span class=p>,</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Rep</span><span class=p>(</span><span class=s2>&quot;range_&quot;</span><span class=p>),</span> <span class=n>data</span><span class=p>)</span>
</span><span id=__span-11-6><a id=__codelineno-11-6 name=__codelineno-11-6 href=#__codelineno-11-6></a><span class=go>split</span>
</span><span id=__span-11-7><a id=__codelineno-11-7 name=__codelineno-11-7 href=#__codelineno-11-7></a><span class=go>0 -1636.467285</span>
</span><span id=__span-11-8><a id=__codelineno-11-8 name=__codelineno-11-8 href=#__codelineno-11-8></a><span class=go>1 3706.568359</span>
</span><span id=__span-11-9><a id=__codelineno-11-9 name=__codelineno-11-9 href=#__codelineno-11-9></a><span class=go>2 2944.720703</span>
</span><span id=__span-11-10><a id=__codelineno-11-10 name=__codelineno-11-10 href=#__codelineno-11-10></a><span class=go>3 -118.113281</span>
</span><span id=__span-11-11><a id=__codelineno-11-11 name=__codelineno-11-11 href=#__codelineno-11-11></a><span class=go>4 17098.916016</span>
</span><span id=__span-11-12><a id=__codelineno-11-12 name=__codelineno-11-12 href=#__codelineno-11-12></a><span class=go>dtype: float64</span>
</span></code></pre></div> <ul> <li>Divide into two windows, each consisting of 50% train and 50% test, compute SMA for each range, and row-stack the outputs of each set upon merging:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-12-1><a id=__codelineno-12-1 name=__codelineno-12-1 href=#__codelineno-12-1></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_n_rolling</span><span class=p>(</span><span class=n>data</span><span class=o>.</span><span class=n>wrapper</span><span class=o>.</span><span class=n>index</span><span class=p>,</span> <span class=mi>2</span><span class=p>,</span> <span class=n>split</span><span class=o>=</span><span class=mf>0.5</span><span class=p>)</span>
</span><span id=__span-12-2><a id=__codelineno-12-2 name=__codelineno-12-2 href=#__codelineno-12-2></a>
</span><span id=__span-12-3><a id=__codelineno-12-3 name=__codelineno-12-3 href=#__codelineno-12-3></a><span class=gp>&gt;&gt;&gt; </span><span class=k>def</span> <span class=nf>apply_func</span><span class=p>(</span><span class=n>data</span><span class=p>):</span>
</span><span id=__span-12-4><a id=__codelineno-12-4 name=__codelineno-12-4 href=#__codelineno-12-4></a><span class=gp>... </span> <span class=k>return</span> <span class=n>data</span><span class=o>.</span><span class=n>run</span><span class=p>(</span><span class=s2>&quot;SMA&quot;</span><span class=p>,</span> <span class=mi>10</span><span class=p>)</span><span class=o>.</span><span class=n>real</span>
</span><span id=__span-12-5><a id=__codelineno-12-5 name=__codelineno-12-5 href=#__codelineno-12-5></a>
</span><span id=__span-12-6><a id=__codelineno-12-6 name=__codelineno-12-6 href=#__codelineno-12-6></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>apply</span><span class=p>(</span>
</span><span id=__span-12-7><a id=__codelineno-12-7 name=__codelineno-12-7 href=#__codelineno-12-7></a><span class=gp>... </span> <span class=n>apply_func</span><span class=p>,</span>
</span><span id=__span-12-8><a id=__codelineno-12-8 name=__codelineno-12-8 href=#__codelineno-12-8></a><span class=gp>... </span> <span class=n>vbt</span><span class=o>.</span><span class=n>Takeable</span><span class=p>(</span><span class=n>data</span><span class=p>),</span>
</span><span id=__span-12-9><a id=__codelineno-12-9 name=__codelineno-12-9 href=#__codelineno-12-9></a><span class=gp>... </span> <span class=n>merge_func</span><span class=o>=</span><span class=s2>&quot;row_stack&quot;</span>
</span><span id=__span-12-10><a id=__codelineno-12-10 name=__codelineno-12-10 href=#__codelineno-12-10></a><span class=gp>... </span><span class=p>)</span><span class=o>.</span><span class=n>unstack</span><span class=p>(</span><span class=s2>&quot;set&quot;</span><span class=p>)</span><span class=o>.</span><span class=n>vbt</span><span class=o>.</span><span class=n>drop_levels</span><span class=p>(</span><span class=s2>&quot;split&quot;</span><span class=p>,</span> <span class=n>axis</span><span class=o>=</span><span class=mi>0</span><span class=p>)</span><span class=o>.</span><span class=n>vbt</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/Splitter_apply.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/Splitter_apply.dark.svg#only-dark></p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.bounds>bounds <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4245-L4248 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.bounds title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_bounds title=vectorbtpro.generic.splitting.base.Splitter.get_bounds>Splitter.get_bounds()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.bounds_arr>bounds_arr <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4200-L4203 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.bounds_arr title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_bounds_arr title=vectorbtpro.generic.splitting.base.Splitter.get_bounds_arr>Splitter.get_bounds_arr()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.break_up_splits>break_up_splits <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L3863-L3912 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.break_up_splits title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-13-1><a id=__codelineno-13-1 name=__codelineno-13-1 href=#__codelineno-13-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>break_up_splits</span><span class=p>(</span>
</span><span id=__span-13-2><a id=__codelineno-13-2 name=__codelineno-13-2 href=#__codelineno-13-2></a> <span class=n>new_split</span><span class=p>,</span>
</span><span id=__span-13-3><a id=__codelineno-13-3 name=__codelineno-13-3 href=#__codelineno-13-3></a> <span class=n>sort</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-13-4><a id=__codelineno-13-4 name=__codelineno-13-4 href=#__codelineno-13-4></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-13-5><a id=__codelineno-13-5 name=__codelineno-13-5 href=#__codelineno-13-5></a> <span class=n>wrapper_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-13-6><a id=__codelineno-13-6 name=__codelineno-13-6 href=#__codelineno-13-6></a> <span class=n>init_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-13-7><a id=__codelineno-13-7 name=__codelineno-13-7 href=#__codelineno-13-7></a> <span class=o>**</span><span class=n>split_range_kwargs</span>
</span><span id=__span-13-8><a id=__codelineno-13-8 name=__codelineno-13-8 href=#__codelineno-13-8></a><span class=p>)</span>
</span></code></pre></div> <p>Split each split into multiple splits.</p> <p>If there are multiple sets, make sure to merge them into one beforehand.</p> <p>Arguments <code>new_split</code> and <code>**split_range_kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.split_range title=vectorbtpro.generic.splitting.base.Splitter.split_range>Splitter.split_range()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.column_stack>column_stack <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1652-L1679 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.column_stack title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-14-1><a id=__codelineno-14-1 name=__codelineno-14-1 href=#__codelineno-14-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>column_stack</span><span class=p>(</span>
</span><span id=__span-14-2><a id=__codelineno-14-2 name=__codelineno-14-2 href=#__codelineno-14-2></a> <span class=o>*</span><span class=n>objs</span><span class=p>,</span>
</span><span id=__span-14-3><a id=__codelineno-14-3 name=__codelineno-14-3 href=#__codelineno-14-3></a> <span class=n>wrapper_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-14-4><a id=__codelineno-14-4 name=__codelineno-14-4 href=#__codelineno-14-4></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-14-5><a id=__codelineno-14-5 name=__codelineno-14-5 href=#__codelineno-14-5></a><span class=p>)</span>
</span></code></pre></div> <p>Stack multiple <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instances along columns.</p> <p>Uses <a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.ArrayWrapper.column_stack title=vectorbtpro.base.wrapping.ArrayWrapper.column_stack>ArrayWrapper.column_stack()</a> to stack the wrappers.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.coverage>coverage <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4644-L4647 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.coverage title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_coverage title=vectorbtpro.generic.splitting.base.Splitter.get_coverage>Splitter.get_coverage()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.duration>duration <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4260-L4263 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.duration title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_duration title=vectorbtpro.generic.splitting.base.Splitter.get_duration>Splitter.get_duration()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.from_expanding>from_expanding <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L823-L928 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.from_expanding title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-15-1><a id=__codelineno-15-1 name=__codelineno-15-1 href=#__codelineno-15-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>from_expanding</span><span class=p>(</span>
</span><span id=__span-15-2><a id=__codelineno-15-2 name=__codelineno-15-2 href=#__codelineno-15-2></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-15-3><a id=__codelineno-15-3 name=__codelineno-15-3 href=#__codelineno-15-3></a> <span class=n>min_length</span><span class=p>,</span>
</span><span id=__span-15-4><a id=__codelineno-15-4 name=__codelineno-15-4 href=#__codelineno-15-4></a> <span class=n>offset</span><span class=p>,</span>
</span><span id=__span-15-5><a id=__codelineno-15-5 name=__codelineno-15-5 href=#__codelineno-15-5></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-15-6><a id=__codelineno-15-6 name=__codelineno-15-6 href=#__codelineno-15-6></a> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-15-7><a id=__codelineno-15-7 name=__codelineno-15-7 href=#__codelineno-15-7></a> <span class=n>range_bounds_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-15-8><a id=__codelineno-15-8 name=__codelineno-15-8 href=#__codelineno-15-8></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-15-9><a id=__codelineno-15-9 name=__codelineno-15-9 href=#__codelineno-15-9></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-15-10><a id=__codelineno-15-10 name=__codelineno-15-10 href=#__codelineno-15-10></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-15-11><a id=__codelineno-15-11 name=__codelineno-15-11 href=#__codelineno-15-11></a><span class=p>)</span>
</span></code></pre></div> <p>Create a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance from an expanding range.</p> <p>Argument <code>min_length</code> is the minimum length of the expanding range. Provide it as a float between 0 and 1 to make it relative to the length of the index. Argument <code>offset</code> is an offset after the right bound of the previous range from which the next range should start. It can also be a float relative to the index length. For other arguments, see <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.from_rolling title=vectorbtpro.generic.splitting.base.Splitter.from_rolling>Splitter.from_rolling()</a>.</p> <p><strong>Usage</strong></p> <ul> <li>Roll an expanding range with a length of 10 and an offset of 10, and split it into 3/4:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-16-1><a id=__codelineno-16-1 name=__codelineno-16-1 href=#__codelineno-16-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-16-2><a id=__codelineno-16-2 name=__codelineno-16-2 href=#__codelineno-16-2></a>
</span><span id=__span-16-3><a id=__codelineno-16-3 name=__codelineno-16-3 href=#__codelineno-16-3></a><span class=gp>&gt;&gt;&gt; </span><span class=n>index</span> <span class=o>=</span> <span class=n>pd</span><span class=o>.</span><span class=n>date_range</span><span class=p>(</span><span class=s2>&quot;2020&quot;</span><span class=p>,</span> <span class=s2>&quot;2021&quot;</span><span class=p>,</span> <span class=n>freq</span><span class=o>=</span><span class=s2>&quot;D&quot;</span><span class=p>)</span>
</span><span id=__span-16-4><a id=__codelineno-16-4 name=__codelineno-16-4 href=#__codelineno-16-4></a>
</span><span id=__span-16-5><a id=__codelineno-16-5 name=__codelineno-16-5 href=#__codelineno-16-5></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_expanding</span><span class=p>(</span>
</span><span id=__span-16-6><a id=__codelineno-16-6 name=__codelineno-16-6 href=#__codelineno-16-6></a><span class=gp>... </span> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-16-7><a id=__codelineno-16-7 name=__codelineno-16-7 href=#__codelineno-16-7></a><span class=gp>... </span> <span class=mi>10</span><span class=p>,</span>
</span><span id=__span-16-8><a id=__codelineno-16-8 name=__codelineno-16-8 href=#__codelineno-16-8></a><span class=gp>... </span> <span class=mi>10</span><span class=p>,</span>
</span><span id=__span-16-9><a id=__codelineno-16-9 name=__codelineno-16-9 href=#__codelineno-16-9></a><span class=gp>... </span> <span class=n>split</span><span class=o>=</span><span class=mi>3</span><span class=o>/</span><span class=mi>4</span><span class=p>,</span>
</span><span id=__span-16-10><a id=__codelineno-16-10 name=__codelineno-16-10 href=#__codelineno-16-10></a><span class=gp>... </span> <span class=n>set_labels</span><span class=o>=</span><span class=p>[</span><span class=s2>&quot;train&quot;</span><span class=p>,</span> <span class=s2>&quot;test&quot;</span><span class=p>]</span>
</span><span id=__span-16-11><a id=__codelineno-16-11 name=__codelineno-16-11 href=#__codelineno-16-11></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-16-12><a id=__codelineno-16-12 name=__codelineno-16-12 href=#__codelineno-16-12></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/from_expanding.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/from_expanding.dark.svg#only-dark></p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.from_grouper>from_grouper <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1099-L1181 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.from_grouper title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-17-1><a id=__codelineno-17-1 name=__codelineno-17-1 href=#__codelineno-17-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>from_grouper</span><span class=p>(</span>
</span><span id=__span-17-2><a id=__codelineno-17-2 name=__codelineno-17-2 href=#__codelineno-17-2></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-17-3><a id=__codelineno-17-3 name=__codelineno-17-3 href=#__codelineno-17-3></a> <span class=n>by</span><span class=p>,</span>
</span><span id=__span-17-4><a id=__codelineno-17-4 name=__codelineno-17-4 href=#__codelineno-17-4></a> <span class=n>groupby_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-17-5><a id=__codelineno-17-5 name=__codelineno-17-5 href=#__codelineno-17-5></a> <span class=n>grouper_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-17-6><a id=__codelineno-17-6 name=__codelineno-17-6 href=#__codelineno-17-6></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-17-7><a id=__codelineno-17-7 name=__codelineno-17-7 href=#__codelineno-17-7></a> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-17-8><a id=__codelineno-17-8 name=__codelineno-17-8 href=#__codelineno-17-8></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-17-9><a id=__codelineno-17-9 name=__codelineno-17-9 href=#__codelineno-17-9></a> <span class=n>split_labels</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-17-10><a id=__codelineno-17-10 name=__codelineno-17-10 href=#__codelineno-17-10></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-17-11><a id=__codelineno-17-11 name=__codelineno-17-11 href=#__codelineno-17-11></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-17-12><a id=__codelineno-17-12 name=__codelineno-17-12 href=#__codelineno-17-12></a><span class=p>)</span>
</span></code></pre></div> <p>Create a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance from a grouper.</p> <p>See <a href=../../../base/accessors/index.html#vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper title=vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper>BaseIDXAccessor.get_grouper()</a>.</p> <p>Uses <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.from_splits title=vectorbtpro.generic.splitting.base.Splitter.from_splits>Splitter.from_splits()</a> to prepare the splits array and labels, and to build the instance.</p> <p><strong>Usage</strong></p> <ul> <li>Map each month into a range:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-18-1><a id=__codelineno-18-1 name=__codelineno-18-1 href=#__codelineno-18-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-18-2><a id=__codelineno-18-2 name=__codelineno-18-2 href=#__codelineno-18-2></a>
</span><span id=__span-18-3><a id=__codelineno-18-3 name=__codelineno-18-3 href=#__codelineno-18-3></a><span class=gp>&gt;&gt;&gt; </span><span class=n>index</span> <span class=o>=</span> <span class=n>pd</span><span class=o>.</span><span class=n>date_range</span><span class=p>(</span><span class=s2>&quot;2020&quot;</span><span class=p>,</span> <span class=s2>&quot;2021&quot;</span><span class=p>,</span> <span class=n>freq</span><span class=o>=</span><span class=s2>&quot;D&quot;</span><span class=p>)</span>
</span><span id=__span-18-4><a id=__codelineno-18-4 name=__codelineno-18-4 href=#__codelineno-18-4></a>
</span><span id=__span-18-5><a id=__codelineno-18-5 name=__codelineno-18-5 href=#__codelineno-18-5></a><span class=gp>&gt;&gt;&gt; </span><span class=k>def</span> <span class=nf>is_month_end</span><span class=p>(</span><span class=n>index</span><span class=p>,</span> <span class=n>split</span><span class=p>):</span>
</span><span id=__span-18-6><a id=__codelineno-18-6 name=__codelineno-18-6 href=#__codelineno-18-6></a><span class=gp>... </span> <span class=n>last_range</span> <span class=o>=</span> <span class=n>split</span><span class=p>[</span><span class=o>-</span><span class=mi>1</span><span class=p>]</span>
</span><span id=__span-18-7><a id=__codelineno-18-7 name=__codelineno-18-7 href=#__codelineno-18-7></a><span class=gp>... </span> <span class=k>return</span> <span class=n>index</span><span class=p>[</span><span class=n>last_range</span><span class=p>][</span><span class=o>-</span><span class=mi>1</span><span class=p>]</span><span class=o>.</span><span class=n>is_month_end</span>
</span><span id=__span-18-8><a id=__codelineno-18-8 name=__codelineno-18-8 href=#__codelineno-18-8></a>
</span><span id=__span-18-9><a id=__codelineno-18-9 name=__codelineno-18-9 href=#__codelineno-18-9></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_grouper</span><span class=p>(</span>
</span><span id=__span-18-10><a id=__codelineno-18-10 name=__codelineno-18-10 href=#__codelineno-18-10></a><span class=gp>... </span> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-18-11><a id=__codelineno-18-11 name=__codelineno-18-11 href=#__codelineno-18-11></a><span class=gp>... </span> <span class=s2>&quot;M&quot;</span><span class=p>,</span>
</span><span id=__span-18-12><a id=__codelineno-18-12 name=__codelineno-18-12 href=#__codelineno-18-12></a><span class=gp>... </span> <span class=n>split_check_template</span><span class=o>=</span><span class=n>vbt</span><span class=o>.</span><span class=n>RepFunc</span><span class=p>(</span><span class=n>is_month_end</span><span class=p>)</span>
</span><span id=__span-18-13><a id=__codelineno-18-13 name=__codelineno-18-13 href=#__codelineno-18-13></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-18-14><a id=__codelineno-18-14 name=__codelineno-18-14 href=#__codelineno-18-14></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/from_grouper.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/from_grouper.dark.svg#only-dark></p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.from_n_expanding>from_n_expanding <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L930-L1020 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.from_n_expanding title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-19-1><a id=__codelineno-19-1 name=__codelineno-19-1 href=#__codelineno-19-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>from_n_expanding</span><span class=p>(</span>
</span><span id=__span-19-2><a id=__codelineno-19-2 name=__codelineno-19-2 href=#__codelineno-19-2></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-19-3><a id=__codelineno-19-3 name=__codelineno-19-3 href=#__codelineno-19-3></a> <span class=n>n</span><span class=p>,</span>
</span><span id=__span-19-4><a id=__codelineno-19-4 name=__codelineno-19-4 href=#__codelineno-19-4></a> <span class=n>min_length</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-19-5><a id=__codelineno-19-5 name=__codelineno-19-5 href=#__codelineno-19-5></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-19-6><a id=__codelineno-19-6 name=__codelineno-19-6 href=#__codelineno-19-6></a> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-19-7><a id=__codelineno-19-7 name=__codelineno-19-7 href=#__codelineno-19-7></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-19-8><a id=__codelineno-19-8 name=__codelineno-19-8 href=#__codelineno-19-8></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-19-9><a id=__codelineno-19-9 name=__codelineno-19-9 href=#__codelineno-19-9></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-19-10><a id=__codelineno-19-10 name=__codelineno-19-10 href=#__codelineno-19-10></a><span class=p>)</span>
</span></code></pre></div> <p>Create a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance from a number of expanding ranges.</p> <p>Picks <code>n</code> evenly-spaced, expanding ranges. Argument <code>min_length</code> defines the minimum length for each range. For other arguments, see <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.from_rolling title=vectorbtpro.generic.splitting.base.Splitter.from_rolling>Splitter.from_rolling()</a>.</p> <p><strong>Usage</strong></p> <ul> <li>Roll 10 expanding ranges with a minimum length of 100, while reserving 50 elements for test:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-20-1><a id=__codelineno-20-1 name=__codelineno-20-1 href=#__codelineno-20-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-20-2><a id=__codelineno-20-2 name=__codelineno-20-2 href=#__codelineno-20-2></a>
</span><span id=__span-20-3><a id=__codelineno-20-3 name=__codelineno-20-3 href=#__codelineno-20-3></a><span class=gp>&gt;&gt;&gt; </span><span class=n>index</span> <span class=o>=</span> <span class=n>pd</span><span class=o>.</span><span class=n>date_range</span><span class=p>(</span><span class=s2>&quot;2020&quot;</span><span class=p>,</span> <span class=s2>&quot;2021&quot;</span><span class=p>,</span> <span class=n>freq</span><span class=o>=</span><span class=s2>&quot;D&quot;</span><span class=p>)</span>
</span><span id=__span-20-4><a id=__codelineno-20-4 name=__codelineno-20-4 href=#__codelineno-20-4></a>
</span><span id=__span-20-5><a id=__codelineno-20-5 name=__codelineno-20-5 href=#__codelineno-20-5></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_n_expanding</span><span class=p>(</span>
</span><span id=__span-20-6><a id=__codelineno-20-6 name=__codelineno-20-6 href=#__codelineno-20-6></a><span class=gp>... </span> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-20-7><a id=__codelineno-20-7 name=__codelineno-20-7 href=#__codelineno-20-7></a><span class=gp>... </span> <span class=mi>10</span><span class=p>,</span>
</span><span id=__span-20-8><a id=__codelineno-20-8 name=__codelineno-20-8 href=#__codelineno-20-8></a><span class=gp>... </span> <span class=n>min_length</span><span class=o>=</span><span class=mi>100</span><span class=p>,</span>
</span><span id=__span-20-9><a id=__codelineno-20-9 name=__codelineno-20-9 href=#__codelineno-20-9></a><span class=gp>... </span> <span class=n>split</span><span class=o>=-</span><span class=mi>50</span><span class=p>,</span>
</span><span id=__span-20-10><a id=__codelineno-20-10 name=__codelineno-20-10 href=#__codelineno-20-10></a><span class=gp>... </span> <span class=n>set_labels</span><span class=o>=</span><span class=p>[</span><span class=s2>&quot;train&quot;</span><span class=p>,</span> <span class=s2>&quot;test&quot;</span><span class=p>]</span>
</span><span id=__span-20-11><a id=__codelineno-20-11 name=__codelineno-20-11 href=#__codelineno-20-11></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-20-12><a id=__codelineno-20-12 name=__codelineno-20-12 href=#__codelineno-20-12></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/from_n_expanding.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/from_n_expanding.dark.svg#only-dark></p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.from_n_random>from_n_random <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1183-L1396 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.from_n_random title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-21-1><a id=__codelineno-21-1 name=__codelineno-21-1 href=#__codelineno-21-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>from_n_random</span><span class=p>(</span>
</span><span id=__span-21-2><a id=__codelineno-21-2 name=__codelineno-21-2 href=#__codelineno-21-2></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-21-3><a id=__codelineno-21-3 name=__codelineno-21-3 href=#__codelineno-21-3></a> <span class=n>n</span><span class=p>,</span>
</span><span id=__span-21-4><a id=__codelineno-21-4 name=__codelineno-21-4 href=#__codelineno-21-4></a> <span class=n>min_length</span><span class=p>,</span>
</span><span id=__span-21-5><a id=__codelineno-21-5 name=__codelineno-21-5 href=#__codelineno-21-5></a> <span class=n>max_length</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-6><a id=__codelineno-21-6 name=__codelineno-21-6 href=#__codelineno-21-6></a> <span class=n>min_start</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-7><a id=__codelineno-21-7 name=__codelineno-21-7 href=#__codelineno-21-7></a> <span class=n>max_end</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-8><a id=__codelineno-21-8 name=__codelineno-21-8 href=#__codelineno-21-8></a> <span class=n>length_choice_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-9><a id=__codelineno-21-9 name=__codelineno-21-9 href=#__codelineno-21-9></a> <span class=n>start_choice_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-10><a id=__codelineno-21-10 name=__codelineno-21-10 href=#__codelineno-21-10></a> <span class=n>length_p_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-11><a id=__codelineno-21-11 name=__codelineno-21-11 href=#__codelineno-21-11></a> <span class=n>start_p_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-12><a id=__codelineno-21-12 name=__codelineno-21-12 href=#__codelineno-21-12></a> <span class=n>seed</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-13><a id=__codelineno-21-13 name=__codelineno-21-13 href=#__codelineno-21-13></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-14><a id=__codelineno-21-14 name=__codelineno-21-14 href=#__codelineno-21-14></a> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-15><a id=__codelineno-21-15 name=__codelineno-21-15 href=#__codelineno-21-15></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-16><a id=__codelineno-21-16 name=__codelineno-21-16 href=#__codelineno-21-16></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-21-17><a id=__codelineno-21-17 name=__codelineno-21-17 href=#__codelineno-21-17></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-21-18><a id=__codelineno-21-18 name=__codelineno-21-18 href=#__codelineno-21-18></a><span class=p>)</span>
</span></code></pre></div> <p>Create a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance from a number of random ranges.</p> <p>Randomly picks the length of a range between <code>min_length</code> and <code>max_length</code> (including) using <code>length_choice_func</code>, which receives an array of possible values and selects one. It defaults to <code>numpy.random.Generator.choice</code>. Optional function <code>length_p_func</code> takes the same as <code>length_choice_func</code> and must return either None or probabilities.</p> <p>Randomly picks the start position of a range starting at <code>min_start</code> and ending at <code>max_end</code> (excluding) minus the chosen length using <code>start_choice_func</code>, which receives an array of possible values and selects one. It defaults to <code>numpy.random.Generator.choice</code>. Optional function <code>start_p_func</code> takes the same as <code>start_choice_func</code> and must return either None or probabilities.</p> <div class="admonition note"> <p class=admonition-title>Note</p> <p>Each function must take two arguments: the iteration index and the array with possible values.</p> </div> <p>For other arguments, see <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.from_rolling title=vectorbtpro.generic.splitting.base.Splitter.from_rolling>Splitter.from_rolling()</a>.</p> <p><strong>Usage</strong></p> <ul> <li>Generate 20 random ranges with a length from [40, 100], and split each into 3/4:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-22-1><a id=__codelineno-22-1 name=__codelineno-22-1 href=#__codelineno-22-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-22-2><a id=__codelineno-22-2 name=__codelineno-22-2 href=#__codelineno-22-2></a>
</span><span id=__span-22-3><a id=__codelineno-22-3 name=__codelineno-22-3 href=#__codelineno-22-3></a><span class=gp>&gt;&gt;&gt; </span><span class=n>index</span> <span class=o>=</span> <span class=n>pd</span><span class=o>.</span><span class=n>date_range</span><span class=p>(</span><span class=s2>&quot;2020&quot;</span><span class=p>,</span> <span class=s2>&quot;2021&quot;</span><span class=p>,</span> <span class=n>freq</span><span class=o>=</span><span class=s2>&quot;D&quot;</span><span class=p>)</span>
</span><span id=__span-22-4><a id=__codelineno-22-4 name=__codelineno-22-4 href=#__codelineno-22-4></a>
</span><span id=__span-22-5><a id=__codelineno-22-5 name=__codelineno-22-5 href=#__codelineno-22-5></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_n_random</span><span class=p>(</span>
</span><span id=__span-22-6><a id=__codelineno-22-6 name=__codelineno-22-6 href=#__codelineno-22-6></a><span class=gp>... </span> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-22-7><a id=__codelineno-22-7 name=__codelineno-22-7 href=#__codelineno-22-7></a><span class=gp>... </span> <span class=mi>20</span><span class=p>,</span>
</span><span id=__span-22-8><a id=__codelineno-22-8 name=__codelineno-22-8 href=#__codelineno-22-8></a><span class=gp>... </span> <span class=n>min_length</span><span class=o>=</span><span class=mi>40</span><span class=p>,</span>
</span><span id=__span-22-9><a id=__codelineno-22-9 name=__codelineno-22-9 href=#__codelineno-22-9></a><span class=gp>... </span> <span class=n>max_length</span><span class=o>=</span><span class=mi>100</span><span class=p>,</span>
</span><span id=__span-22-10><a id=__codelineno-22-10 name=__codelineno-22-10 href=#__codelineno-22-10></a><span class=gp>... </span> <span class=n>split</span><span class=o>=</span><span class=mi>3</span><span class=o>/</span><span class=mi>4</span><span class=p>,</span>
</span><span id=__span-22-11><a id=__codelineno-22-11 name=__codelineno-22-11 href=#__codelineno-22-11></a><span class=gp>... </span> <span class=n>set_labels</span><span class=o>=</span><span class=p>[</span><span class=s2>&quot;train&quot;</span><span class=p>,</span> <span class=s2>&quot;test&quot;</span><span class=p>]</span>
</span><span id=__span-22-12><a id=__codelineno-22-12 name=__codelineno-22-12 href=#__codelineno-22-12></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-22-13><a id=__codelineno-22-13 name=__codelineno-22-13 href=#__codelineno-22-13></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/from_n_random.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/from_n_random.dark.svg#only-dark></p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.from_n_rolling>from_n_rolling <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L669-L821 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.from_n_rolling title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-23-1><a id=__codelineno-23-1 name=__codelineno-23-1 href=#__codelineno-23-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>from_n_rolling</span><span class=p>(</span>
</span><span id=__span-23-2><a id=__codelineno-23-2 name=__codelineno-23-2 href=#__codelineno-23-2></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-23-3><a id=__codelineno-23-3 name=__codelineno-23-3 href=#__codelineno-23-3></a> <span class=n>n</span><span class=p>,</span>
</span><span id=__span-23-4><a id=__codelineno-23-4 name=__codelineno-23-4 href=#__codelineno-23-4></a> <span class=n>length</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-23-5><a id=__codelineno-23-5 name=__codelineno-23-5 href=#__codelineno-23-5></a> <span class=n>optimize_anchor_set</span><span class=o>=</span><span class=mi>1</span><span class=p>,</span>
</span><span id=__span-23-6><a id=__codelineno-23-6 name=__codelineno-23-6 href=#__codelineno-23-6></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-23-7><a id=__codelineno-23-7 name=__codelineno-23-7 href=#__codelineno-23-7></a> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-23-8><a id=__codelineno-23-8 name=__codelineno-23-8 href=#__codelineno-23-8></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-23-9><a id=__codelineno-23-9 name=__codelineno-23-9 href=#__codelineno-23-9></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-23-10><a id=__codelineno-23-10 name=__codelineno-23-10 href=#__codelineno-23-10></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-23-11><a id=__codelineno-23-11 name=__codelineno-23-11 href=#__codelineno-23-11></a><span class=p>)</span>
</span></code></pre></div> <p>Create a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance from a number of rolling ranges of the same length.</p> <p>If <code>length</code> is None, splits the index evenly into <code>n</code> non-overlapping ranges using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.from_rolling title=vectorbtpro.generic.splitting.base.Splitter.from_rolling>Splitter.from_rolling()</a>. Otherwise, picks <code>n</code> evenly-spaced, potentially overlapping ranges of a fixed length. For other arguments, see <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.from_rolling title=vectorbtpro.generic.splitting.base.Splitter.from_rolling>Splitter.from_rolling()</a>.</p> <p>If <code>length</code> is "optimize", searches for a length to cover the most of the index. Use <code>optimize_anchor_set</code> to provide the index of a set that should become non-overlapping.</p> <p><strong>Usage</strong></p> <ul> <li>Roll 10 ranges with 100 elements, and split it into 3/4:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-24-1><a id=__codelineno-24-1 name=__codelineno-24-1 href=#__codelineno-24-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-24-2><a id=__codelineno-24-2 name=__codelineno-24-2 href=#__codelineno-24-2></a>
</span><span id=__span-24-3><a id=__codelineno-24-3 name=__codelineno-24-3 href=#__codelineno-24-3></a><span class=gp>&gt;&gt;&gt; </span><span class=n>index</span> <span class=o>=</span> <span class=n>pd</span><span class=o>.</span><span class=n>date_range</span><span class=p>(</span><span class=s2>&quot;2020&quot;</span><span class=p>,</span> <span class=s2>&quot;2021&quot;</span><span class=p>,</span> <span class=n>freq</span><span class=o>=</span><span class=s2>&quot;D&quot;</span><span class=p>)</span>
</span><span id=__span-24-4><a id=__codelineno-24-4 name=__codelineno-24-4 href=#__codelineno-24-4></a>
</span><span id=__span-24-5><a id=__codelineno-24-5 name=__codelineno-24-5 href=#__codelineno-24-5></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_n_rolling</span><span class=p>(</span>
</span><span id=__span-24-6><a id=__codelineno-24-6 name=__codelineno-24-6 href=#__codelineno-24-6></a><span class=gp>... </span> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-24-7><a id=__codelineno-24-7 name=__codelineno-24-7 href=#__codelineno-24-7></a><span class=gp>... </span> <span class=mi>10</span><span class=p>,</span>
</span><span id=__span-24-8><a id=__codelineno-24-8 name=__codelineno-24-8 href=#__codelineno-24-8></a><span class=gp>... </span> <span class=n>length</span><span class=o>=</span><span class=mi>100</span><span class=p>,</span>
</span><span id=__span-24-9><a id=__codelineno-24-9 name=__codelineno-24-9 href=#__codelineno-24-9></a><span class=gp>... </span> <span class=n>split</span><span class=o>=</span><span class=mi>3</span><span class=o>/</span><span class=mi>4</span><span class=p>,</span>
</span><span id=__span-24-10><a id=__codelineno-24-10 name=__codelineno-24-10 href=#__codelineno-24-10></a><span class=gp>... </span> <span class=n>set_labels</span><span class=o>=</span><span class=p>[</span><span class=s2>&quot;train&quot;</span><span class=p>,</span> <span class=s2>&quot;test&quot;</span><span class=p>]</span>
</span><span id=__span-24-11><a id=__codelineno-24-11 name=__codelineno-24-11 href=#__codelineno-24-11></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-24-12><a id=__codelineno-24-12 name=__codelineno-24-12 href=#__codelineno-24-12></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/from_n_rolling.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/from_n_rolling.dark.svg#only-dark></p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.from_ranges>from_ranges <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1022-L1097 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.from_ranges title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-25-1><a id=__codelineno-25-1 name=__codelineno-25-1 href=#__codelineno-25-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>from_ranges</span><span class=p>(</span>
</span><span id=__span-25-2><a id=__codelineno-25-2 name=__codelineno-25-2 href=#__codelineno-25-2></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-25-3><a id=__codelineno-25-3 name=__codelineno-25-3 href=#__codelineno-25-3></a> <span class=o>*</span><span class=n>args</span><span class=p>,</span>
</span><span id=__span-25-4><a id=__codelineno-25-4 name=__codelineno-25-4 href=#__codelineno-25-4></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-25-5><a id=__codelineno-25-5 name=__codelineno-25-5 href=#__codelineno-25-5></a> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-25-6><a id=__codelineno-25-6 name=__codelineno-25-6 href=#__codelineno-25-6></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-25-7><a id=__codelineno-25-7 name=__codelineno-25-7 href=#__codelineno-25-7></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-25-8><a id=__codelineno-25-8 name=__codelineno-25-8 href=#__codelineno-25-8></a><span class=p>)</span>
</span></code></pre></div> <p>Create a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance from ranges.</p> <p>Uses <a href=../../../base/indexing/index.html#vectorbtpro.base.indexing.get_index_ranges title=vectorbtpro.base.indexing.get_index_ranges>get_index_ranges()</a> to generate start and end indices. Other keyword arguments will be passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.from_splits title=vectorbtpro.generic.splitting.base.Splitter.from_splits>Splitter.from_splits()</a>. For details on <code>split</code> and <code>split_range_kwargs</code>, see <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.from_rolling title=vectorbtpro.generic.splitting.base.Splitter.from_rolling>Splitter.from_rolling()</a>.</p> <p><strong>Usage</strong></p> <ul> <li>Translate each quarter into a range:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-26-1><a id=__codelineno-26-1 name=__codelineno-26-1 href=#__codelineno-26-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-26-2><a id=__codelineno-26-2 name=__codelineno-26-2 href=#__codelineno-26-2></a>
</span><span id=__span-26-3><a id=__codelineno-26-3 name=__codelineno-26-3 href=#__codelineno-26-3></a><span class=gp>&gt;&gt;&gt; </span><span class=n>index</span> <span class=o>=</span> <span class=n>pd</span><span class=o>.</span><span class=n>date_range</span><span class=p>(</span><span class=s2>&quot;2020&quot;</span><span class=p>,</span> <span class=s2>&quot;2021&quot;</span><span class=p>,</span> <span class=n>freq</span><span class=o>=</span><span class=s2>&quot;D&quot;</span><span class=p>)</span>
</span><span id=__span-26-4><a id=__codelineno-26-4 name=__codelineno-26-4 href=#__codelineno-26-4></a>
</span><span id=__span-26-5><a id=__codelineno-26-5 name=__codelineno-26-5 href=#__codelineno-26-5></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_ranges</span><span class=p>(</span><span class=n>index</span><span class=p>,</span> <span class=n>every</span><span class=o>=</span><span class=s2>&quot;QS&quot;</span><span class=p>)</span>
</span><span id=__span-26-6><a id=__codelineno-26-6 name=__codelineno-26-6 href=#__codelineno-26-6></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/from_ranges_1.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/from_ranges_1.dark.svg#only-dark></p> <ul> <li>In addition to the above, reserve the last month for testing purposes:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-27-1><a id=__codelineno-27-1 name=__codelineno-27-1 href=#__codelineno-27-1></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_ranges</span><span class=p>(</span>
</span><span id=__span-27-2><a id=__codelineno-27-2 name=__codelineno-27-2 href=#__codelineno-27-2></a><span class=gp>... </span> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-27-3><a id=__codelineno-27-3 name=__codelineno-27-3 href=#__codelineno-27-3></a><span class=gp>... </span> <span class=n>every</span><span class=o>=</span><span class=s2>&quot;QS&quot;</span><span class=p>,</span>
</span><span id=__span-27-4><a id=__codelineno-27-4 name=__codelineno-27-4 href=#__codelineno-27-4></a><span class=gp>... </span> <span class=n>split</span><span class=o>=</span><span class=p>(</span><span class=mf>1.0</span><span class=p>,</span> <span class=k>lambda</span> <span class=n>index</span><span class=p>:</span> <span class=n>index</span><span class=o>.</span><span class=n>month</span> <span class=o>==</span> <span class=n>index</span><span class=o>.</span><span class=n>month</span><span class=p>[</span><span class=o>-</span><span class=mi>1</span><span class=p>]),</span>
</span><span id=__span-27-5><a id=__codelineno-27-5 name=__codelineno-27-5 href=#__codelineno-27-5></a><span class=gp>... </span> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span><span class=n>backwards</span><span class=o>=</span><span class=kc>True</span><span class=p>)</span>
</span><span id=__span-27-6><a id=__codelineno-27-6 name=__codelineno-27-6 href=#__codelineno-27-6></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-27-7><a id=__codelineno-27-7 name=__codelineno-27-7 href=#__codelineno-27-7></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/from_ranges_2.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/from_ranges_2.dark.svg#only-dark></p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.from_rolling>from_rolling <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L486-L667 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.from_rolling title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-28-1><a id=__codelineno-28-1 name=__codelineno-28-1 href=#__codelineno-28-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>from_rolling</span><span class=p>(</span>
</span><span id=__span-28-2><a id=__codelineno-28-2 name=__codelineno-28-2 href=#__codelineno-28-2></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-28-3><a id=__codelineno-28-3 name=__codelineno-28-3 href=#__codelineno-28-3></a> <span class=n>length</span><span class=p>,</span>
</span><span id=__span-28-4><a id=__codelineno-28-4 name=__codelineno-28-4 href=#__codelineno-28-4></a> <span class=n>offset</span><span class=o>=</span><span class=mi>0</span><span class=p>,</span>
</span><span id=__span-28-5><a id=__codelineno-28-5 name=__codelineno-28-5 href=#__codelineno-28-5></a> <span class=n>offset_anchor</span><span class=o>=</span><span class=s1>&#39;prev_end&#39;</span><span class=p>,</span>
</span><span id=__span-28-6><a id=__codelineno-28-6 name=__codelineno-28-6 href=#__codelineno-28-6></a> <span class=n>offset_anchor_set</span><span class=o>=</span><span class=mi>0</span><span class=p>,</span>
</span><span id=__span-28-7><a id=__codelineno-28-7 name=__codelineno-28-7 href=#__codelineno-28-7></a> <span class=n>offset_space</span><span class=o>=</span><span class=s1>&#39;prev&#39;</span><span class=p>,</span>
</span><span id=__span-28-8><a id=__codelineno-28-8 name=__codelineno-28-8 href=#__codelineno-28-8></a> <span class=n>backwards</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-28-9><a id=__codelineno-28-9 name=__codelineno-28-9 href=#__codelineno-28-9></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-28-10><a id=__codelineno-28-10 name=__codelineno-28-10 href=#__codelineno-28-10></a> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-28-11><a id=__codelineno-28-11 name=__codelineno-28-11 href=#__codelineno-28-11></a> <span class=n>range_bounds_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-28-12><a id=__codelineno-28-12 name=__codelineno-28-12 href=#__codelineno-28-12></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-28-13><a id=__codelineno-28-13 name=__codelineno-28-13 href=#__codelineno-28-13></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-28-14><a id=__codelineno-28-14 name=__codelineno-28-14 href=#__codelineno-28-14></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-28-15><a id=__codelineno-28-15 name=__codelineno-28-15 href=#__codelineno-28-15></a><span class=p>)</span>
</span></code></pre></div> <p>Create a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance from a rolling range of a fixed length.</p> <p>Uses <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.from_splits title=vectorbtpro.generic.splitting.base.Splitter.from_splits>Splitter.from_splits()</a> to prepare the splits array and labels, and to build the instance.</p> <p><strong>Args</strong></p> <dl> <dt><strong><code>index</code></strong> :&ensp;<code>index_like</code></dt> <dd>Index.</dd> <dt><strong><code>length</code></strong> :&ensp;<code>int</code>, <code>float</code>, <code>or timedelta_like</code></dt> <dd>See <a href=index.html#vectorbtpro.generic.splitting.base.RelRange.length title=vectorbtpro.generic.splitting.base.RelRange.length>RelRange.length</a>.</dd> <dt><strong><code>offset</code></strong> :&ensp;<code>int</code>, <code>float</code>, <code>or timedelta_like</code></dt> <dd>See <a href=index.html#vectorbtpro.generic.splitting.base.RelRange.offset title=vectorbtpro.generic.splitting.base.RelRange.offset>RelRange.offset</a>.</dd> <dt><strong><code>offset_anchor</code></strong> :&ensp;<code>str</code></dt> <dd>See <a href=index.html#vectorbtpro.generic.splitting.base.RelRange.offset_anchor title=vectorbtpro.generic.splitting.base.RelRange.offset_anchor>RelRange.offset_anchor</a>.</dd> <dt><strong><code>offset_anchor_set</code></strong> :&ensp;<code>int</code></dt> <dd> <p>Offset anchor set.</p> <p>Selects the set from the previous range to be used as an offset anchor. If None, the whole previous split is considered as a single range. By default, it's the first set.</p> </dd> <dt><strong><code>offset_space</code></strong> :&ensp;<code>str</code></dt> <dd>See <a href=index.html#vectorbtpro.generic.splitting.base.RelRange.offset_space title=vectorbtpro.generic.splitting.base.RelRange.offset_space>RelRange.offset_space</a>.</dd> <dt><strong><code>backwards</code></strong> :&ensp;<code>bool</code> or <code>str</code></dt> <dd> <p>Whether to roll backwards.</p> <p>If 'sorted', will roll backwards and sort the resulting splits by the start index.</p> </dd> <dt><strong><code>split</code></strong> :&ensp;<code>any</code></dt> <dd> <p>Ranges to split the range into.</p> <p>If None, will produce the entire range as a single range. Otherwise, will use <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.split_range title=vectorbtpro.generic.splitting.base.Splitter.split_range>Splitter.split_range()</a> to split the range into multiple ranges.</p> </dd> <dt><strong><code>split_range_kwargs</code></strong> :&ensp;<code>dict</code></dt> <dd>Keyword arguments passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.split_range title=vectorbtpro.generic.splitting.base.Splitter.split_range>Splitter.split_range()</a>.</dd> <dt><strong><code>range_bounds_kwargs</code></strong> :&ensp;<code>dict</code></dt> <dd>Keyword arguments passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_range_bounds title=vectorbtpro.generic.splitting.base.Splitter.get_range_bounds>Splitter.get_range_bounds()</a>.</dd> <dt><strong><code>template_context</code></strong> :&ensp;<code>dict</code></dt> <dd>Mapping used to substitute templates in ranges.</dd> <dt><strong><code>freq</code></strong> :&ensp;<code>any</code></dt> <dd> <p>Index frequency in case it cannot be parsed from <code>index</code>.</p> <p>If None, will be parsed using <a href=../../../base/accessors/index.html#vectorbtpro.base.accessors.BaseIDXAccessor.get_freq title=vectorbtpro.base.accessors.BaseIDXAccessor.get_freq>BaseIDXAccessor.get_freq()</a>.</p> </dd> <dt><strong><code>**kwargs</code></strong></dt> <dd>Keyword arguments passed to the constructor of <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a>.</dd> </dl> <p><strong>Usage</strong></p> <ul> <li>Divide a range into a set of non-overlapping ranges:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-29-1><a id=__codelineno-29-1 name=__codelineno-29-1 href=#__codelineno-29-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-29-2><a id=__codelineno-29-2 name=__codelineno-29-2 href=#__codelineno-29-2></a>
</span><span id=__span-29-3><a id=__codelineno-29-3 name=__codelineno-29-3 href=#__codelineno-29-3></a><span class=gp>&gt;&gt;&gt; </span><span class=n>index</span> <span class=o>=</span> <span class=n>pd</span><span class=o>.</span><span class=n>date_range</span><span class=p>(</span><span class=s2>&quot;2020&quot;</span><span class=p>,</span> <span class=s2>&quot;2021&quot;</span><span class=p>,</span> <span class=n>freq</span><span class=o>=</span><span class=s2>&quot;D&quot;</span><span class=p>)</span>
</span><span id=__span-29-4><a id=__codelineno-29-4 name=__codelineno-29-4 href=#__codelineno-29-4></a>
</span><span id=__span-29-5><a id=__codelineno-29-5 name=__codelineno-29-5 href=#__codelineno-29-5></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_rolling</span><span class=p>(</span><span class=n>index</span><span class=p>,</span> <span class=mi>30</span><span class=p>)</span>
</span><span id=__span-29-6><a id=__codelineno-29-6 name=__codelineno-29-6 href=#__codelineno-29-6></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/from_rolling_1.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/from_rolling_1.dark.svg#only-dark></p> <ul> <li>Divide a range into ranges, each split into 1/2:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-30-1><a id=__codelineno-30-1 name=__codelineno-30-1 href=#__codelineno-30-1></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_rolling</span><span class=p>(</span>
</span><span id=__span-30-2><a id=__codelineno-30-2 name=__codelineno-30-2 href=#__codelineno-30-2></a><span class=gp>... </span> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-30-3><a id=__codelineno-30-3 name=__codelineno-30-3 href=#__codelineno-30-3></a><span class=gp>... </span> <span class=mi>60</span><span class=p>,</span>
</span><span id=__span-30-4><a id=__codelineno-30-4 name=__codelineno-30-4 href=#__codelineno-30-4></a><span class=gp>... </span> <span class=n>split</span><span class=o>=</span><span class=mi>1</span><span class=o>/</span><span class=mi>2</span><span class=p>,</span>
</span><span id=__span-30-5><a id=__codelineno-30-5 name=__codelineno-30-5 href=#__codelineno-30-5></a><span class=gp>... </span> <span class=n>set_labels</span><span class=o>=</span><span class=p>[</span><span class=s2>&quot;train&quot;</span><span class=p>,</span> <span class=s2>&quot;test&quot;</span><span class=p>]</span>
</span><span id=__span-30-6><a id=__codelineno-30-6 name=__codelineno-30-6 href=#__codelineno-30-6></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-30-7><a id=__codelineno-30-7 name=__codelineno-30-7 href=#__codelineno-30-7></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/from_rolling_2.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/from_rolling_2.dark.svg#only-dark></p> <ul> <li>Make the ranges above non-overlapping by using the right bound of the last set as an offset anchor:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-31-1><a id=__codelineno-31-1 name=__codelineno-31-1 href=#__codelineno-31-1></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_rolling</span><span class=p>(</span>
</span><span id=__span-31-2><a id=__codelineno-31-2 name=__codelineno-31-2 href=#__codelineno-31-2></a><span class=gp>... </span> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-31-3><a id=__codelineno-31-3 name=__codelineno-31-3 href=#__codelineno-31-3></a><span class=gp>... </span> <span class=mi>60</span><span class=p>,</span>
</span><span id=__span-31-4><a id=__codelineno-31-4 name=__codelineno-31-4 href=#__codelineno-31-4></a><span class=gp>... </span> <span class=n>offset_anchor_set</span><span class=o>=-</span><span class=mi>1</span><span class=p>,</span>
</span><span id=__span-31-5><a id=__codelineno-31-5 name=__codelineno-31-5 href=#__codelineno-31-5></a><span class=gp>... </span> <span class=n>split</span><span class=o>=</span><span class=mi>1</span><span class=o>/</span><span class=mi>2</span><span class=p>,</span>
</span><span id=__span-31-6><a id=__codelineno-31-6 name=__codelineno-31-6 href=#__codelineno-31-6></a><span class=gp>... </span> <span class=n>set_labels</span><span class=o>=</span><span class=p>[</span><span class=s2>&quot;train&quot;</span><span class=p>,</span> <span class=s2>&quot;test&quot;</span><span class=p>]</span>
</span><span id=__span-31-7><a id=__codelineno-31-7 name=__codelineno-31-7 href=#__codelineno-31-7></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-31-8><a id=__codelineno-31-8 name=__codelineno-31-8 href=#__codelineno-31-8></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/from_rolling_3.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/from_rolling_3.dark.svg#only-dark></p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.from_single>from_single <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L457-L484 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.from_single title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-32-1><a id=__codelineno-32-1 name=__codelineno-32-1 href=#__codelineno-32-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>from_single</span><span class=p>(</span>
</span><span id=__span-32-2><a id=__codelineno-32-2 name=__codelineno-32-2 href=#__codelineno-32-2></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-32-3><a id=__codelineno-32-3 name=__codelineno-32-3 href=#__codelineno-32-3></a> <span class=n>split</span><span class=p>,</span>
</span><span id=__span-32-4><a id=__codelineno-32-4 name=__codelineno-32-4 href=#__codelineno-32-4></a> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-32-5><a id=__codelineno-32-5 name=__codelineno-32-5 href=#__codelineno-32-5></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-32-6><a id=__codelineno-32-6 name=__codelineno-32-6 href=#__codelineno-32-6></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-32-7><a id=__codelineno-32-7 name=__codelineno-32-7 href=#__codelineno-32-7></a><span class=p>)</span>
</span></code></pre></div> <p>Create a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance from a single split.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.from_sklearn>from_sklearn <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1398-L1427 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.from_sklearn title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-33-1><a id=__codelineno-33-1 name=__codelineno-33-1 href=#__codelineno-33-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>from_sklearn</span><span class=p>(</span>
</span><span id=__span-33-2><a id=__codelineno-33-2 name=__codelineno-33-2 href=#__codelineno-33-2></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-33-3><a id=__codelineno-33-3 name=__codelineno-33-3 href=#__codelineno-33-3></a> <span class=n>splitter</span><span class=p>,</span>
</span><span id=__span-33-4><a id=__codelineno-33-4 name=__codelineno-33-4 href=#__codelineno-33-4></a> <span class=n>groups</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-33-5><a id=__codelineno-33-5 name=__codelineno-33-5 href=#__codelineno-33-5></a> <span class=n>split_labels</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-33-6><a id=__codelineno-33-6 name=__codelineno-33-6 href=#__codelineno-33-6></a> <span class=n>set_labels</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-33-7><a id=__codelineno-33-7 name=__codelineno-33-7 href=#__codelineno-33-7></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-33-8><a id=__codelineno-33-8 name=__codelineno-33-8 href=#__codelineno-33-8></a><span class=p>)</span>
</span></code></pre></div> <p>Create a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance from a scikit-learn's splitter.</p> <p>The splitter must be an instance of <code>sklearn.model_selection.BaseCrossValidator</code>.</p> <p>Uses <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.from_splits title=vectorbtpro.generic.splitting.base.Splitter.from_splits>Splitter.from_splits()</a> to prepare the splits array and labels, and to build the instance.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.from_split_func>from_split_func <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1429-L1589 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.from_split_func title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-34-1><a id=__codelineno-34-1 name=__codelineno-34-1 href=#__codelineno-34-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>from_split_func</span><span class=p>(</span>
</span><span id=__span-34-2><a id=__codelineno-34-2 name=__codelineno-34-2 href=#__codelineno-34-2></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-34-3><a id=__codelineno-34-3 name=__codelineno-34-3 href=#__codelineno-34-3></a> <span class=n>split_func</span><span class=p>,</span>
</span><span id=__span-34-4><a id=__codelineno-34-4 name=__codelineno-34-4 href=#__codelineno-34-4></a> <span class=n>split_args</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-34-5><a id=__codelineno-34-5 name=__codelineno-34-5 href=#__codelineno-34-5></a> <span class=n>split_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-34-6><a id=__codelineno-34-6 name=__codelineno-34-6 href=#__codelineno-34-6></a> <span class=n>fix_ranges</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-34-7><a id=__codelineno-34-7 name=__codelineno-34-7 href=#__codelineno-34-7></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-34-8><a id=__codelineno-34-8 name=__codelineno-34-8 href=#__codelineno-34-8></a> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-34-9><a id=__codelineno-34-9 name=__codelineno-34-9 href=#__codelineno-34-9></a> <span class=n>range_bounds_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-34-10><a id=__codelineno-34-10 name=__codelineno-34-10 href=#__codelineno-34-10></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-34-11><a id=__codelineno-34-11 name=__codelineno-34-11 href=#__codelineno-34-11></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-34-12><a id=__codelineno-34-12 name=__codelineno-34-12 href=#__codelineno-34-12></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-34-13><a id=__codelineno-34-13 name=__codelineno-34-13 href=#__codelineno-34-13></a><span class=p>)</span>
</span></code></pre></div> <p>Create a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance from a custom split function.</p> <p>In a while-loop, substitutes templates in <code>split_args</code> and <code>split_kwargs</code> and passes them to <code>split_func</code>, which should return either a split (see <code>new_split</code> in <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.split_range title=vectorbtpro.generic.splitting.base.Splitter.split_range>Splitter.split_range()</a>, also supports a single range if it's not an iterable) or None to abrupt the while-loop. If <code>fix_ranges</code> is True, the returned split is then converted into a fixed split using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.split_range title=vectorbtpro.generic.splitting.base.Splitter.split_range>Splitter.split_range()</a> and the bounds of its sets are measured using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_range_bounds title=vectorbtpro.generic.splitting.base.Splitter.get_range_bounds>Splitter.get_range_bounds()</a>.</p> <p>Each template substitution has the following information:</p> <ul> <li><code>split_idx</code>: Current split index, starting at 0</li> <li><code>splits</code>: Nested list of splits appended up to this point</li> <li><code>bounds</code>: Nested list of bounds appended up to this point</li> <li><code>prev_start</code>: Left bound of the previous split</li> <li><code>prev_end</code>: Right bound of the previous split</li> <li>Arguments and keyword arguments passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.from_split_func title=vectorbtpro.generic.splitting.base.Splitter.from_split_func>Splitter.from_split_func()</a></li> </ul> <p><strong>Usage</strong></p> <ul> <li>Rolling window of 30 elements, 20 for train and 10 for test:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-35-1><a id=__codelineno-35-1 name=__codelineno-35-1 href=#__codelineno-35-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-35-2><a id=__codelineno-35-2 name=__codelineno-35-2 href=#__codelineno-35-2></a>
</span><span id=__span-35-3><a id=__codelineno-35-3 name=__codelineno-35-3 href=#__codelineno-35-3></a><span class=gp>&gt;&gt;&gt; </span><span class=n>index</span> <span class=o>=</span> <span class=n>pd</span><span class=o>.</span><span class=n>date_range</span><span class=p>(</span><span class=s2>&quot;2020&quot;</span><span class=p>,</span> <span class=s2>&quot;2021&quot;</span><span class=p>,</span> <span class=n>freq</span><span class=o>=</span><span class=s2>&quot;D&quot;</span><span class=p>)</span>
</span><span id=__span-35-4><a id=__codelineno-35-4 name=__codelineno-35-4 href=#__codelineno-35-4></a>
</span><span id=__span-35-5><a id=__codelineno-35-5 name=__codelineno-35-5 href=#__codelineno-35-5></a><span class=gp>&gt;&gt;&gt; </span><span class=k>def</span> <span class=nf>split_func</span><span class=p>(</span><span class=n>splits</span><span class=p>,</span> <span class=n>bounds</span><span class=p>,</span> <span class=n>index</span><span class=p>):</span>
</span><span id=__span-35-6><a id=__codelineno-35-6 name=__codelineno-35-6 href=#__codelineno-35-6></a><span class=gp>... </span> <span class=k>if</span> <span class=nb>len</span><span class=p>(</span><span class=n>splits</span><span class=p>)</span> <span class=o>==</span> <span class=mi>0</span><span class=p>:</span>
</span><span id=__span-35-7><a id=__codelineno-35-7 name=__codelineno-35-7 href=#__codelineno-35-7></a><span class=gp>... </span> <span class=n>new_split</span> <span class=o>=</span> <span class=p>(</span><span class=nb>slice</span><span class=p>(</span><span class=mi>0</span><span class=p>,</span> <span class=mi>20</span><span class=p>),</span> <span class=nb>slice</span><span class=p>(</span><span class=mi>20</span><span class=p>,</span> <span class=mi>30</span><span class=p>))</span>
</span><span id=__span-35-8><a id=__codelineno-35-8 name=__codelineno-35-8 href=#__codelineno-35-8></a><span class=gp>... </span> <span class=k>else</span><span class=p>:</span>
</span><span id=__span-35-9><a id=__codelineno-35-9 name=__codelineno-35-9 href=#__codelineno-35-9></a><span class=gp>... </span> <span class=c1># Previous split, first set, right bound</span>
</span><span id=__span-35-10><a id=__codelineno-35-10 name=__codelineno-35-10 href=#__codelineno-35-10></a><span class=gp>... </span> <span class=n>prev_end</span> <span class=o>=</span> <span class=n>bounds</span><span class=p>[</span><span class=o>-</span><span class=mi>1</span><span class=p>][</span><span class=mi>0</span><span class=p>][</span><span class=mi>1</span><span class=p>]</span>
</span><span id=__span-35-11><a id=__codelineno-35-11 name=__codelineno-35-11 href=#__codelineno-35-11></a><span class=gp>... </span> <span class=n>new_split</span> <span class=o>=</span> <span class=p>(</span>
</span><span id=__span-35-12><a id=__codelineno-35-12 name=__codelineno-35-12 href=#__codelineno-35-12></a><span class=gp>... </span> <span class=nb>slice</span><span class=p>(</span><span class=n>prev_end</span><span class=p>,</span> <span class=n>prev_end</span> <span class=o>+</span> <span class=mi>20</span><span class=p>),</span>
</span><span id=__span-35-13><a id=__codelineno-35-13 name=__codelineno-35-13 href=#__codelineno-35-13></a><span class=gp>... </span> <span class=nb>slice</span><span class=p>(</span><span class=n>prev_end</span> <span class=o>+</span> <span class=mi>20</span><span class=p>,</span> <span class=n>prev_end</span> <span class=o>+</span> <span class=mi>30</span><span class=p>)</span>
</span><span id=__span-35-14><a id=__codelineno-35-14 name=__codelineno-35-14 href=#__codelineno-35-14></a><span class=gp>... </span> <span class=p>)</span>
</span><span id=__span-35-15><a id=__codelineno-35-15 name=__codelineno-35-15 href=#__codelineno-35-15></a><span class=gp>... </span> <span class=k>if</span> <span class=n>new_split</span><span class=p>[</span><span class=o>-</span><span class=mi>1</span><span class=p>]</span><span class=o>.</span><span class=n>stop</span> <span class=o>&gt;</span> <span class=nb>len</span><span class=p>(</span><span class=n>index</span><span class=p>):</span>
</span><span id=__span-35-16><a id=__codelineno-35-16 name=__codelineno-35-16 href=#__codelineno-35-16></a><span class=gp>... </span> <span class=k>return</span> <span class=kc>None</span>
</span><span id=__span-35-17><a id=__codelineno-35-17 name=__codelineno-35-17 href=#__codelineno-35-17></a><span class=gp>... </span> <span class=k>return</span> <span class=n>new_split</span>
</span><span id=__span-35-18><a id=__codelineno-35-18 name=__codelineno-35-18 href=#__codelineno-35-18></a>
</span><span id=__span-35-19><a id=__codelineno-35-19 name=__codelineno-35-19 href=#__codelineno-35-19></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_split_func</span><span class=p>(</span>
</span><span id=__span-35-20><a id=__codelineno-35-20 name=__codelineno-35-20 href=#__codelineno-35-20></a><span class=gp>... </span> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-35-21><a id=__codelineno-35-21 name=__codelineno-35-21 href=#__codelineno-35-21></a><span class=gp>... </span> <span class=n>split_func</span><span class=p>,</span>
</span><span id=__span-35-22><a id=__codelineno-35-22 name=__codelineno-35-22 href=#__codelineno-35-22></a><span class=gp>... </span> <span class=n>split_args</span><span class=o>=</span><span class=p>(</span>
</span><span id=__span-35-23><a id=__codelineno-35-23 name=__codelineno-35-23 href=#__codelineno-35-23></a><span class=gp>... </span> <span class=n>vbt</span><span class=o>.</span><span class=n>Rep</span><span class=p>(</span><span class=s2>&quot;splits&quot;</span><span class=p>),</span>
</span><span id=__span-35-24><a id=__codelineno-35-24 name=__codelineno-35-24 href=#__codelineno-35-24></a><span class=gp>... </span> <span class=n>vbt</span><span class=o>.</span><span class=n>Rep</span><span class=p>(</span><span class=s2>&quot;bounds&quot;</span><span class=p>),</span>
</span><span id=__span-35-25><a id=__codelineno-35-25 name=__codelineno-35-25 href=#__codelineno-35-25></a><span class=gp>... </span> <span class=n>vbt</span><span class=o>.</span><span class=n>Rep</span><span class=p>(</span><span class=s2>&quot;index&quot;</span><span class=p>),</span>
</span><span id=__span-35-26><a id=__codelineno-35-26 name=__codelineno-35-26 href=#__codelineno-35-26></a><span class=gp>... </span> <span class=p>),</span>
</span><span id=__span-35-27><a id=__codelineno-35-27 name=__codelineno-35-27 href=#__codelineno-35-27></a><span class=gp>... </span> <span class=n>set_labels</span><span class=o>=</span><span class=p>[</span><span class=s2>&quot;train&quot;</span><span class=p>,</span> <span class=s2>&quot;test&quot;</span><span class=p>]</span>
</span><span id=__span-35-28><a id=__codelineno-35-28 name=__codelineno-35-28 href=#__codelineno-35-28></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-35-29><a id=__codelineno-35-29 name=__codelineno-35-29 href=#__codelineno-35-29></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/from_split_func.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/from_split_func.dark.svg#only-dark></p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.from_splits>from_splits <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L336-L455 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.from_splits title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-36-1><a id=__codelineno-36-1 name=__codelineno-36-1 href=#__codelineno-36-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>from_splits</span><span class=p>(</span>
</span><span id=__span-36-2><a id=__codelineno-36-2 name=__codelineno-36-2 href=#__codelineno-36-2></a> <span class=n>index</span><span class=p>,</span>
</span><span id=__span-36-3><a id=__codelineno-36-3 name=__codelineno-36-3 href=#__codelineno-36-3></a> <span class=n>splits</span><span class=p>,</span>
</span><span id=__span-36-4><a id=__codelineno-36-4 name=__codelineno-36-4 href=#__codelineno-36-4></a> <span class=n>squeeze</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-36-5><a id=__codelineno-36-5 name=__codelineno-36-5 href=#__codelineno-36-5></a> <span class=n>fix_ranges</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-36-6><a id=__codelineno-36-6 name=__codelineno-36-6 href=#__codelineno-36-6></a> <span class=n>wrap_with_fixrange</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-36-7><a id=__codelineno-36-7 name=__codelineno-36-7 href=#__codelineno-36-7></a> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-36-8><a id=__codelineno-36-8 name=__codelineno-36-8 href=#__codelineno-36-8></a> <span class=n>split_check_template</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-36-9><a id=__codelineno-36-9 name=__codelineno-36-9 href=#__codelineno-36-9></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-36-10><a id=__codelineno-36-10 name=__codelineno-36-10 href=#__codelineno-36-10></a> <span class=n>split_labels</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-36-11><a id=__codelineno-36-11 name=__codelineno-36-11 href=#__codelineno-36-11></a> <span class=n>set_labels</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-36-12><a id=__codelineno-36-12 name=__codelineno-36-12 href=#__codelineno-36-12></a> <span class=n>wrapper_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-36-13><a id=__codelineno-36-13 name=__codelineno-36-13 href=#__codelineno-36-13></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-36-14><a id=__codelineno-36-14 name=__codelineno-36-14 href=#__codelineno-36-14></a><span class=p>)</span>
</span></code></pre></div> <p>Create a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance from an iterable of splits.</p> <p>Argument <code>splits</code> supports both absolute and relative ranges. To transform relative ranges into the absolute format, enable <code>fix_ranges</code>. Arguments <code>split_range_kwargs</code> are then passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.split_range title=vectorbtpro.generic.splitting.base.Splitter.split_range>Splitter.split_range()</a>.</p> <p>Enable <code>wrap_with_fixrange</code> to wrap any fixed range with <a href=index.html#vectorbtpro.generic.splitting.base.FixRange title=vectorbtpro.generic.splitting.base.FixRange>FixRange</a>. If the range is an array, it will be wrapped regardless of this argument to avoid building a 3d array.</p> <p>Pass a template via <code>split_check_template</code> to discard splits that do not fulfill certain criteria. The current split will be available as <code>split</code>. Should return a boolean (<code>False</code> to discard).</p> <p>Labels for splits and sets can be provided via <code>split_labels</code> and <code>set_labels</code> respectively. Both arguments can be provided as templates. The split array will be available as <code>splits</code>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_bounds>get_bounds <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4205-L4243 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_bounds title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-37-1><a id=__codelineno-37-1 name=__codelineno-37-1 href=#__codelineno-37-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_bounds</span><span class=p>(</span>
</span><span id=__span-37-2><a id=__codelineno-37-2 name=__codelineno-37-2 href=#__codelineno-37-2></a> <span class=n>index_bounds</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-37-3><a id=__codelineno-37-3 name=__codelineno-37-3 href=#__codelineno-37-3></a> <span class=n>right_inclusive</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-37-4><a id=__codelineno-37-4 name=__codelineno-37-4 href=#__codelineno-37-4></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-37-5><a id=__codelineno-37-5 name=__codelineno-37-5 href=#__codelineno-37-5></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-37-6><a id=__codelineno-37-6 name=__codelineno-37-6 href=#__codelineno-37-6></a> <span class=n>squeeze_one_split</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-37-7><a id=__codelineno-37-7 name=__codelineno-37-7 href=#__codelineno-37-7></a> <span class=n>squeeze_one_set</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-37-8><a id=__codelineno-37-8 name=__codelineno-37-8 href=#__codelineno-37-8></a> <span class=n>index_combine_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-37-9><a id=__codelineno-37-9 name=__codelineno-37-9 href=#__codelineno-37-9></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-37-10><a id=__codelineno-37-10 name=__codelineno-37-10 href=#__codelineno-37-10></a><span class=p>)</span>
</span></code></pre></div> <p>Boolean Series/DataFrame where index are bounds and columns are splits stacked together.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_bounds_arr title=vectorbtpro.generic.splitting.base.Splitter.get_bounds_arr>Splitter.get_bounds_arr()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_bounds_arr>get_bounds_arr <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4153-L4198 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_bounds_arr title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-38-1><a id=__codelineno-38-1 name=__codelineno-38-1 href=#__codelineno-38-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_bounds_arr</span><span class=p>(</span>
</span><span id=__span-38-2><a id=__codelineno-38-2 name=__codelineno-38-2 href=#__codelineno-38-2></a> <span class=n>index_bounds</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-38-3><a id=__codelineno-38-3 name=__codelineno-38-3 href=#__codelineno-38-3></a> <span class=n>right_inclusive</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-38-4><a id=__codelineno-38-4 name=__codelineno-38-4 href=#__codelineno-38-4></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-38-5><a id=__codelineno-38-5 name=__codelineno-38-5 href=#__codelineno-38-5></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-38-6><a id=__codelineno-38-6 name=__codelineno-38-6 href=#__codelineno-38-6></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-38-7><a id=__codelineno-38-7 name=__codelineno-38-7 href=#__codelineno-38-7></a> <span class=o>**</span><span class=n>range_bounds_kwargs</span>
</span><span id=__span-38-8><a id=__codelineno-38-8 name=__codelineno-38-8 href=#__codelineno-38-8></a><span class=p>)</span>
</span></code></pre></div> <p>Three-dimensional integer array with bounds.</p> <p>First axis represents splits. Second axis represents sets. Third axis represents bounds.</p> <p>Each range is getting selected using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.select_range title=vectorbtpro.generic.splitting.base.Splitter.select_range>Splitter.select_range()</a> and then measured using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_range_bounds title=vectorbtpro.generic.splitting.base.Splitter.get_range_bounds>Splitter.get_range_bounds()</a>. Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_range_bounds title=vectorbtpro.generic.splitting.base.Splitter.get_range_bounds>Splitter.get_range_bounds()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_coverage>get_coverage <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4619-L4642 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_coverage title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-39-1><a id=__codelineno-39-1 name=__codelineno-39-1 href=#__codelineno-39-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_coverage</span><span class=p>(</span>
</span><span id=__span-39-2><a id=__codelineno-39-2 name=__codelineno-39-2 href=#__codelineno-39-2></a> <span class=n>overlapping</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-39-3><a id=__codelineno-39-3 name=__codelineno-39-3 href=#__codelineno-39-3></a> <span class=n>normalize</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-39-4><a id=__codelineno-39-4 name=__codelineno-39-4 href=#__codelineno-39-4></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-39-5><a id=__codelineno-39-5 name=__codelineno-39-5 href=#__codelineno-39-5></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-39-6><a id=__codelineno-39-6 name=__codelineno-39-6 href=#__codelineno-39-6></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-39-7><a id=__codelineno-39-7 name=__codelineno-39-7 href=#__codelineno-39-7></a><span class=p>)</span>
</span></code></pre></div> <p>Get the coverage of the entire mask.</p> <p>If <code>overlapping</code> is True, returns the number of overlapping True values. If <code>normalize</code> is True, returns the number of True values relative to the length of the index. If <code>overlapping</code> and <code>normalize</code> are True, returns the number of overlapping True values relative to the total number of True values.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_mask_arr title=vectorbtpro.generic.splitting.base.Splitter.get_mask_arr>Splitter.get_mask_arr()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_duration>get_duration <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4255-L4258 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_duration title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-40-1><a id=__codelineno-40-1 name=__codelineno-40-1 href=#__codelineno-40-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_duration</span><span class=p>(</span>
</span><span id=__span-40-2><a id=__codelineno-40-2 name=__codelineno-40-2 href=#__codelineno-40-2></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-40-3><a id=__codelineno-40-3 name=__codelineno-40-3 href=#__codelineno-40-3></a><span class=p>)</span>
</span></code></pre></div> <p>Get duration.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_iter_set_mask_arrs>get_iter_set_mask_arrs <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4332-L4359 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_iter_set_mask_arrs title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-41-1><a id=__codelineno-41-1 name=__codelineno-41-1 href=#__codelineno-41-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_iter_set_mask_arrs</span><span class=p>(</span>
</span><span id=__span-41-2><a id=__codelineno-41-2 name=__codelineno-41-2 href=#__codelineno-41-2></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-41-3><a id=__codelineno-41-3 name=__codelineno-41-3 href=#__codelineno-41-3></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-41-4><a id=__codelineno-41-4 name=__codelineno-41-4 href=#__codelineno-41-4></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-41-5><a id=__codelineno-41-5 name=__codelineno-41-5 href=#__codelineno-41-5></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-41-6><a id=__codelineno-41-6 name=__codelineno-41-6 href=#__codelineno-41-6></a><span class=p>)</span>
</span></code></pre></div> <p>Generator of two-dimensional boolean arrays, one per set.</p> <p>First axis represents splits. Second axis represents index.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_range_mask title=vectorbtpro.generic.splitting.base.Splitter.get_range_mask>Splitter.get_range_mask()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_iter_set_masks>get_iter_set_masks <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4390-L4407 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_iter_set_masks title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-42-1><a id=__codelineno-42-1 name=__codelineno-42-1 href=#__codelineno-42-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_iter_set_masks</span><span class=p>(</span>
</span><span id=__span-42-2><a id=__codelineno-42-2 name=__codelineno-42-2 href=#__codelineno-42-2></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-42-3><a id=__codelineno-42-3 name=__codelineno-42-3 href=#__codelineno-42-3></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-42-4><a id=__codelineno-42-4 name=__codelineno-42-4 href=#__codelineno-42-4></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-42-5><a id=__codelineno-42-5 name=__codelineno-42-5 href=#__codelineno-42-5></a><span class=p>)</span>
</span></code></pre></div> <p>Generator of boolean DataFrames, one per set.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_iter_set_mask_arrs title=vectorbtpro.generic.splitting.base.Splitter.get_iter_set_mask_arrs>Splitter.get_iter_set_mask_arrs()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_iter_split_mask_arrs>get_iter_split_mask_arrs <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4298-L4325 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_iter_split_mask_arrs title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-43-1><a id=__codelineno-43-1 name=__codelineno-43-1 href=#__codelineno-43-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_iter_split_mask_arrs</span><span class=p>(</span>
</span><span id=__span-43-2><a id=__codelineno-43-2 name=__codelineno-43-2 href=#__codelineno-43-2></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-43-3><a id=__codelineno-43-3 name=__codelineno-43-3 href=#__codelineno-43-3></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-43-4><a id=__codelineno-43-4 name=__codelineno-43-4 href=#__codelineno-43-4></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-43-5><a id=__codelineno-43-5 name=__codelineno-43-5 href=#__codelineno-43-5></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-43-6><a id=__codelineno-43-6 name=__codelineno-43-6 href=#__codelineno-43-6></a><span class=p>)</span>
</span></code></pre></div> <p>Generator of two-dimensional boolean arrays, one per split.</p> <p>First axis represents sets. Second axis represents index.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_range_mask title=vectorbtpro.generic.splitting.base.Splitter.get_range_mask>Splitter.get_range_mask()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_iter_split_masks>get_iter_split_masks <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4366-L4383 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_iter_split_masks title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-44-1><a id=__codelineno-44-1 name=__codelineno-44-1 href=#__codelineno-44-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_iter_split_masks</span><span class=p>(</span>
</span><span id=__span-44-2><a id=__codelineno-44-2 name=__codelineno-44-2 href=#__codelineno-44-2></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-44-3><a id=__codelineno-44-3 name=__codelineno-44-3 href=#__codelineno-44-3></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-44-4><a id=__codelineno-44-4 name=__codelineno-44-4 href=#__codelineno-44-4></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-44-5><a id=__codelineno-44-5 name=__codelineno-44-5 href=#__codelineno-44-5></a><span class=p>)</span>
</span></code></pre></div> <p>Generator of boolean DataFrames, one per split.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_iter_split_mask_arrs title=vectorbtpro.generic.splitting.base.Splitter.get_iter_split_mask_arrs>Splitter.get_iter_split_mask_arrs()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_mask>get_mask <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4442-L4474 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_mask title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-45-1><a id=__codelineno-45-1 name=__codelineno-45-1 href=#__codelineno-45-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_mask</span><span class=p>(</span>
</span><span id=__span-45-2><a id=__codelineno-45-2 name=__codelineno-45-2 href=#__codelineno-45-2></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-45-3><a id=__codelineno-45-3 name=__codelineno-45-3 href=#__codelineno-45-3></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-45-4><a id=__codelineno-45-4 name=__codelineno-45-4 href=#__codelineno-45-4></a> <span class=n>squeeze_one_split</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-45-5><a id=__codelineno-45-5 name=__codelineno-45-5 href=#__codelineno-45-5></a> <span class=n>squeeze_one_set</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-45-6><a id=__codelineno-45-6 name=__codelineno-45-6 href=#__codelineno-45-6></a> <span class=n>index_combine_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-45-7><a id=__codelineno-45-7 name=__codelineno-45-7 href=#__codelineno-45-7></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-45-8><a id=__codelineno-45-8 name=__codelineno-45-8 href=#__codelineno-45-8></a><span class=p>)</span>
</span></code></pre></div> <p>Boolean Series/DataFrame where index is <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.index title=vectorbtpro.generic.splitting.base.Splitter.index>Splitter.index</a> and columns are splits stacked together.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_mask_arr title=vectorbtpro.generic.splitting.base.Splitter.get_mask_arr>Splitter.get_mask_arr()</a>.</p> <div class="admonition warning"> <p class=admonition-title>Warning</p> <p>Boolean arrays for a big number of splits may take a considerable amount of memory.</p> </div> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_mask_arr>get_mask_arr <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4414-L4435 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_mask_arr title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-46-1><a id=__codelineno-46-1 name=__codelineno-46-1 href=#__codelineno-46-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_mask_arr</span><span class=p>(</span>
</span><span id=__span-46-2><a id=__codelineno-46-2 name=__codelineno-46-2 href=#__codelineno-46-2></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-46-3><a id=__codelineno-46-3 name=__codelineno-46-3 href=#__codelineno-46-3></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-46-4><a id=__codelineno-46-4 name=__codelineno-46-4 href=#__codelineno-46-4></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-46-5><a id=__codelineno-46-5 name=__codelineno-46-5 href=#__codelineno-46-5></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-46-6><a id=__codelineno-46-6 name=__codelineno-46-6 href=#__codelineno-46-6></a><span class=p>)</span>
</span></code></pre></div> <p>Three-dimensional boolean array with splits.</p> <p>First axis represents splits. Second axis represents sets. Third axis represents index.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_iter_split_mask_arrs title=vectorbtpro.generic.splitting.base.Splitter.get_iter_split_mask_arrs>Splitter.get_iter_split_mask_arrs()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_n_sets>get_n_sets <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1801-L1806 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_n_sets title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-47-1><a id=__codelineno-47-1 name=__codelineno-47-1 href=#__codelineno-47-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_n_sets</span><span class=p>(</span>
</span><span id=__span-47-2><a id=__codelineno-47-2 name=__codelineno-47-2 href=#__codelineno-47-2></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-47-3><a id=__codelineno-47-3 name=__codelineno-47-3 href=#__codelineno-47-3></a><span class=p>)</span>
</span></code></pre></div> <p>Get number of sets while considering the grouper.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_n_splits>get_n_splits <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1794-L1799 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_n_splits title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-48-1><a id=__codelineno-48-1 name=__codelineno-48-1 href=#__codelineno-48-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_n_splits</span><span class=p>(</span>
</span><span id=__span-48-2><a id=__codelineno-48-2 name=__codelineno-48-2 href=#__codelineno-48-2></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-48-3><a id=__codelineno-48-3 name=__codelineno-48-3 href=#__codelineno-48-3></a><span class=p>)</span>
</span></code></pre></div> <p>Get number of splits while considering the grouper.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_obj_index>get_obj_index <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L2582-L2591 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_obj_index title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-49-1><a id=__codelineno-49-1 name=__codelineno-49-1 href=#__codelineno-49-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_obj_index</span><span class=p>(</span>
</span><span id=__span-49-2><a id=__codelineno-49-2 name=__codelineno-49-2 href=#__codelineno-49-2></a> <span class=n>obj</span>
</span><span id=__span-49-3><a id=__codelineno-49-3 name=__codelineno-49-3 href=#__codelineno-49-3></a><span class=p>)</span>
</span></code></pre></div> <p>Get index from an object.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_overlap_matrix>get_overlap_matrix <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4649-L4712 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_overlap_matrix title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-50-1><a id=__codelineno-50-1 name=__codelineno-50-1 href=#__codelineno-50-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_overlap_matrix</span><span class=p>(</span>
</span><span id=__span-50-2><a id=__codelineno-50-2 name=__codelineno-50-2 href=#__codelineno-50-2></a> <span class=n>by</span><span class=o>=</span><span class=s1>&#39;split&#39;</span><span class=p>,</span>
</span><span id=__span-50-3><a id=__codelineno-50-3 name=__codelineno-50-3 href=#__codelineno-50-3></a> <span class=n>normalize</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-50-4><a id=__codelineno-50-4 name=__codelineno-50-4 href=#__codelineno-50-4></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-50-5><a id=__codelineno-50-5 name=__codelineno-50-5 href=#__codelineno-50-5></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-50-6><a id=__codelineno-50-6 name=__codelineno-50-6 href=#__codelineno-50-6></a> <span class=n>jitted</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-50-7><a id=__codelineno-50-7 name=__codelineno-50-7 href=#__codelineno-50-7></a> <span class=n>squeeze_one_split</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-50-8><a id=__codelineno-50-8 name=__codelineno-50-8 href=#__codelineno-50-8></a> <span class=n>squeeze_one_set</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-50-9><a id=__codelineno-50-9 name=__codelineno-50-9 href=#__codelineno-50-9></a> <span class=n>index_combine_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-50-10><a id=__codelineno-50-10 name=__codelineno-50-10 href=#__codelineno-50-10></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-50-11><a id=__codelineno-50-11 name=__codelineno-50-11 href=#__codelineno-50-11></a><span class=p>)</span>
</span></code></pre></div> <p>Get the overlap between each pair of ranges.</p> <p>The argument <code>by</code> can be one of 'split', 'set', and 'range'.</p> <p>If <code>normalize</code> is True, returns the number of True values in each overlap relative to the total number of True values in both ranges.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_mask_arr title=vectorbtpro.generic.splitting.base.Splitter.get_mask_arr>Splitter.get_mask_arr()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_range_bounds>get_range_bounds <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4111-L4151 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_range_bounds title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-51-1><a id=__codelineno-51-1 name=__codelineno-51-1 href=#__codelineno-51-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_range_bounds</span><span class=p>(</span>
</span><span id=__span-51-2><a id=__codelineno-51-2 name=__codelineno-51-2 href=#__codelineno-51-2></a> <span class=n>range_</span><span class=p>,</span>
</span><span id=__span-51-3><a id=__codelineno-51-3 name=__codelineno-51-3 href=#__codelineno-51-3></a> <span class=n>index_bounds</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-51-4><a id=__codelineno-51-4 name=__codelineno-51-4 href=#__codelineno-51-4></a> <span class=n>right_inclusive</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-51-5><a id=__codelineno-51-5 name=__codelineno-51-5 href=#__codelineno-51-5></a> <span class=n>check_constant</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-51-6><a id=__codelineno-51-6 name=__codelineno-51-6 href=#__codelineno-51-6></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-51-7><a id=__codelineno-51-7 name=__codelineno-51-7 href=#__codelineno-51-7></a> <span class=n>index</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-51-8><a id=__codelineno-51-8 name=__codelineno-51-8 href=#__codelineno-51-8></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-51-9><a id=__codelineno-51-9 name=__codelineno-51-9 href=#__codelineno-51-9></a><span class=p>)</span>
</span></code></pre></div> <p>Get the left (inclusive) and right (exclusive) bound of a range.</p> <div class="admonition note"> <p class=admonition-title>Note</p> <p>Even when mapped to the index, the right bound is always exclusive.</p> </div> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_range_coverage>get_range_coverage <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4571-L4612 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_range_coverage title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-52-1><a id=__codelineno-52-1 name=__codelineno-52-1 href=#__codelineno-52-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_range_coverage</span><span class=p>(</span>
</span><span id=__span-52-2><a id=__codelineno-52-2 name=__codelineno-52-2 href=#__codelineno-52-2></a> <span class=n>normalize</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-52-3><a id=__codelineno-52-3 name=__codelineno-52-3 href=#__codelineno-52-3></a> <span class=n>relative</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-52-4><a id=__codelineno-52-4 name=__codelineno-52-4 href=#__codelineno-52-4></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-52-5><a id=__codelineno-52-5 name=__codelineno-52-5 href=#__codelineno-52-5></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-52-6><a id=__codelineno-52-6 name=__codelineno-52-6 href=#__codelineno-52-6></a> <span class=n>squeeze_one_split</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-52-7><a id=__codelineno-52-7 name=__codelineno-52-7 href=#__codelineno-52-7></a> <span class=n>squeeze_one_set</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-52-8><a id=__codelineno-52-8 name=__codelineno-52-8 href=#__codelineno-52-8></a> <span class=n>index_combine_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-52-9><a id=__codelineno-52-9 name=__codelineno-52-9 href=#__codelineno-52-9></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-52-10><a id=__codelineno-52-10 name=__codelineno-52-10 href=#__codelineno-52-10></a><span class=p>)</span>
</span></code></pre></div> <p>Get the coverage of each range mask.</p> <p>If <code>normalize</code> is True, returns the number of True values in each range relative to the length of the index. If <code>normalize</code> and <code>relative</code> are True, returns the number of True values in each range relative to the total number of True values in its split.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_mask_arr title=vectorbtpro.generic.splitting.base.Splitter.get_mask_arr>Splitter.get_mask_arr()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_range_mask>get_range_mask <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4272-L4296 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_range_mask title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-53-1><a id=__codelineno-53-1 name=__codelineno-53-1 href=#__codelineno-53-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_range_mask</span><span class=p>(</span>
</span><span id=__span-53-2><a id=__codelineno-53-2 name=__codelineno-53-2 href=#__codelineno-53-2></a> <span class=n>range_</span><span class=p>,</span>
</span><span id=__span-53-3><a id=__codelineno-53-3 name=__codelineno-53-3 href=#__codelineno-53-3></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-53-4><a id=__codelineno-53-4 name=__codelineno-53-4 href=#__codelineno-53-4></a> <span class=n>index</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-53-5><a id=__codelineno-53-5 name=__codelineno-53-5 href=#__codelineno-53-5></a><span class=p>)</span>
</span></code></pre></div> <p>Get the mask of a range.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_ready_obj_range>get_ready_obj_range <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L2593-L2649 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_ready_obj_range title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-54-1><a id=__codelineno-54-1 name=__codelineno-54-1 href=#__codelineno-54-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_ready_obj_range</span><span class=p>(</span>
</span><span id=__span-54-2><a id=__codelineno-54-2 name=__codelineno-54-2 href=#__codelineno-54-2></a> <span class=n>obj</span><span class=p>,</span>
</span><span id=__span-54-3><a id=__codelineno-54-3 name=__codelineno-54-3 href=#__codelineno-54-3></a> <span class=n>range_</span><span class=p>,</span>
</span><span id=__span-54-4><a id=__codelineno-54-4 name=__codelineno-54-4 href=#__codelineno-54-4></a> <span class=n>remap_to_obj</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-54-5><a id=__codelineno-54-5 name=__codelineno-54-5 href=#__codelineno-54-5></a> <span class=n>obj_index</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-54-6><a id=__codelineno-54-6 name=__codelineno-54-6 href=#__codelineno-54-6></a> <span class=n>obj_freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-54-7><a id=__codelineno-54-7 name=__codelineno-54-7 href=#__codelineno-54-7></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-54-8><a id=__codelineno-54-8 name=__codelineno-54-8 href=#__codelineno-54-8></a> <span class=n>jitted</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-54-9><a id=__codelineno-54-9 name=__codelineno-54-9 href=#__codelineno-54-9></a> <span class=n>silence_warnings</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-54-10><a id=__codelineno-54-10 name=__codelineno-54-10 href=#__codelineno-54-10></a> <span class=n>index</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-54-11><a id=__codelineno-54-11 name=__codelineno-54-11 href=#__codelineno-54-11></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-54-12><a id=__codelineno-54-12 name=__codelineno-54-12 href=#__codelineno-54-12></a> <span class=n>return_obj_meta</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-54-13><a id=__codelineno-54-13 name=__codelineno-54-13 href=#__codelineno-54-13></a> <span class=o>**</span><span class=n>ready_range_kwargs</span>
</span><span id=__span-54-14><a id=__codelineno-54-14 name=__codelineno-54-14 href=#__codelineno-54-14></a><span class=p>)</span>
</span></code></pre></div> <p>Get a range that is ready to be mapped into an array-like object.</p> <p>If the object is Pandas-like and <code>obj_index</code> is not None, searches for an index in the object using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_obj_index title=vectorbtpro.generic.splitting.base.Splitter.get_obj_index>Splitter.get_obj_index()</a>. Once found, uses <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.remap_range title=vectorbtpro.generic.splitting.base.Splitter.remap_range>Splitter.remap_range()</a> to get the range that maps to the object index. Finally, uses <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_ready_range title=vectorbtpro.generic.splitting.base.Splitter.get_ready_range>Splitter.get_ready_range()</a> to convert the range into the one that can be used directly in indexing.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_ready_range>get_ready_range <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1902-L2130 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_ready_range title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-55-1><a id=__codelineno-55-1 name=__codelineno-55-1 href=#__codelineno-55-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_ready_range</span><span class=p>(</span>
</span><span id=__span-55-2><a id=__codelineno-55-2 name=__codelineno-55-2 href=#__codelineno-55-2></a> <span class=n>range_</span><span class=p>,</span>
</span><span id=__span-55-3><a id=__codelineno-55-3 name=__codelineno-55-3 href=#__codelineno-55-3></a> <span class=n>allow_relative</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-55-4><a id=__codelineno-55-4 name=__codelineno-55-4 href=#__codelineno-55-4></a> <span class=n>allow_zero_len</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-55-5><a id=__codelineno-55-5 name=__codelineno-55-5 href=#__codelineno-55-5></a> <span class=n>range_format</span><span class=o>=</span><span class=s1>&#39;slice_or_any&#39;</span><span class=p>,</span>
</span><span id=__span-55-6><a id=__codelineno-55-6 name=__codelineno-55-6 href=#__codelineno-55-6></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-55-7><a id=__codelineno-55-7 name=__codelineno-55-7 href=#__codelineno-55-7></a> <span class=n>index</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-55-8><a id=__codelineno-55-8 name=__codelineno-55-8 href=#__codelineno-55-8></a> <span class=n>return_meta</span><span class=o>=</span><span class=kc>False</span>
</span><span id=__span-55-9><a id=__codelineno-55-9 name=__codelineno-55-9 href=#__codelineno-55-9></a><span class=p>)</span>
</span></code></pre></div> <p>Get a range that can be directly used in array indexing.</p> <p>Such a range is either an integer or datetime-like slice (right bound is always exclusive!), a one-dimensional NumPy array with integer indices or datetime-like objects, or a one-dimensional NumPy mask of the same length as the index.</p> <p>Argument <code>range_format</code> accepts the following options:</p> <ul> <li>'any': Return any format</li> <li>'indices': Return indices</li> <li>'mask': Return mask of the same length as index</li> <li>'slice': Return slice</li> <li>'slice_or_indices': If slice fails, return indices</li> <li>'slice_or_mask': If slice fails, return mask</li> <li>'slice_or_any': If slice fails, return any format</li> </ul> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_set_coverage>get_set_coverage <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4526-L4564 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_set_coverage title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-56-1><a id=__codelineno-56-1 name=__codelineno-56-1 href=#__codelineno-56-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_set_coverage</span><span class=p>(</span>
</span><span id=__span-56-2><a id=__codelineno-56-2 name=__codelineno-56-2 href=#__codelineno-56-2></a> <span class=n>overlapping</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-56-3><a id=__codelineno-56-3 name=__codelineno-56-3 href=#__codelineno-56-3></a> <span class=n>normalize</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-56-4><a id=__codelineno-56-4 name=__codelineno-56-4 href=#__codelineno-56-4></a> <span class=n>relative</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-56-5><a id=__codelineno-56-5 name=__codelineno-56-5 href=#__codelineno-56-5></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-56-6><a id=__codelineno-56-6 name=__codelineno-56-6 href=#__codelineno-56-6></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-56-7><a id=__codelineno-56-7 name=__codelineno-56-7 href=#__codelineno-56-7></a> <span class=n>squeeze_one_set</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-56-8><a id=__codelineno-56-8 name=__codelineno-56-8 href=#__codelineno-56-8></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-56-9><a id=__codelineno-56-9 name=__codelineno-56-9 href=#__codelineno-56-9></a><span class=p>)</span>
</span></code></pre></div> <p>Get the coverage of each set mask.</p> <p>If <code>overlapping</code> is True, returns the number of overlapping True values between splits in each set. If <code>normalize</code> is True, returns the number of True values in each set relative to the length of the index. If <code>normalize</code> and <code>relative</code> are True, returns the number of True values in each set relative to the total number of True values across all sets.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_mask_arr title=vectorbtpro.generic.splitting.base.Splitter.get_mask_arr>Splitter.get_mask_arr()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_set_grouper>get_set_grouper <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1786-L1792 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_set_grouper title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-57-1><a id=__codelineno-57-1 name=__codelineno-57-1 href=#__codelineno-57-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_set_grouper</span><span class=p>(</span>
</span><span id=__span-57-2><a id=__codelineno-57-2 name=__codelineno-57-2 href=#__codelineno-57-2></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-57-3><a id=__codelineno-57-3 name=__codelineno-57-3 href=#__codelineno-57-3></a><span class=p>)</span>
</span></code></pre></div> <p>Get set grouper.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_set_labels>get_set_labels <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1815-L1820 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_set_labels title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-58-1><a id=__codelineno-58-1 name=__codelineno-58-1 href=#__codelineno-58-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_set_labels</span><span class=p>(</span>
</span><span id=__span-58-2><a id=__codelineno-58-2 name=__codelineno-58-2 href=#__codelineno-58-2></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-58-3><a id=__codelineno-58-3 name=__codelineno-58-3 href=#__codelineno-58-3></a><span class=p>)</span>
</span></code></pre></div> <p>Get set labels while considering the grouper.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_split_coverage>get_split_coverage <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4481-L4519 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_split_coverage title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-59-1><a id=__codelineno-59-1 name=__codelineno-59-1 href=#__codelineno-59-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_split_coverage</span><span class=p>(</span>
</span><span id=__span-59-2><a id=__codelineno-59-2 name=__codelineno-59-2 href=#__codelineno-59-2></a> <span class=n>overlapping</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-59-3><a id=__codelineno-59-3 name=__codelineno-59-3 href=#__codelineno-59-3></a> <span class=n>normalize</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-59-4><a id=__codelineno-59-4 name=__codelineno-59-4 href=#__codelineno-59-4></a> <span class=n>relative</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-59-5><a id=__codelineno-59-5 name=__codelineno-59-5 href=#__codelineno-59-5></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-59-6><a id=__codelineno-59-6 name=__codelineno-59-6 href=#__codelineno-59-6></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-59-7><a id=__codelineno-59-7 name=__codelineno-59-7 href=#__codelineno-59-7></a> <span class=n>squeeze_one_split</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-59-8><a id=__codelineno-59-8 name=__codelineno-59-8 href=#__codelineno-59-8></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-59-9><a id=__codelineno-59-9 name=__codelineno-59-9 href=#__codelineno-59-9></a><span class=p>)</span>
</span></code></pre></div> <p>Get the coverage of each split mask.</p> <p>If <code>overlapping</code> is True, returns the number of overlapping True values between sets in each split. If <code>normalize</code> is True, returns the number of True values in each split relative to the length of the index. If <code>normalize</code> and <code>relative</code> are True, returns the number of True values in each split relative to the total number of True values across all splits.</p> <p>Keyword arguments <code>**kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_mask_arr title=vectorbtpro.generic.splitting.base.Splitter.get_mask_arr>Splitter.get_mask_arr()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_split_grouper>get_split_grouper <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1778-L1784 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_split_grouper title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-60-1><a id=__codelineno-60-1 name=__codelineno-60-1 href=#__codelineno-60-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_split_grouper</span><span class=p>(</span>
</span><span id=__span-60-2><a id=__codelineno-60-2 name=__codelineno-60-2 href=#__codelineno-60-2></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-60-3><a id=__codelineno-60-3 name=__codelineno-60-3 href=#__codelineno-60-3></a><span class=p>)</span>
</span></code></pre></div> <p>Get split grouper.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.get_split_labels>get_split_labels <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1808-L1813 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.get_split_labels title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-61-1><a id=__codelineno-61-1 name=__codelineno-61-1 href=#__codelineno-61-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>get_split_labels</span><span class=p>(</span>
</span><span id=__span-61-2><a id=__codelineno-61-2 name=__codelineno-61-2 href=#__codelineno-61-2></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-61-3><a id=__codelineno-61-3 name=__codelineno-61-3 href=#__codelineno-61-3></a><span class=p>)</span>
</span></code></pre></div> <p>Get split labels while considering the grouper.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.index>index <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1740-L1743 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.index title="Permanent link">&para;</a></h3> <p>Index.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.index_bounds>index_bounds <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4250-L4253 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.index_bounds title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_bounds title=vectorbtpro.generic.splitting.base.Splitter.get_bounds>Splitter.get_bounds()</a> with <code>index_bounds=True</code>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.index_duration>index_duration <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4265-L4268 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.index_duration title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_duration title=vectorbtpro.generic.splitting.base.Splitter.get_duration>Splitter.get_duration()</a> with <code>index_bounds=True</code>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.indexing_func>indexing_func <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1731-L1738 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.indexing_func title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-62-1><a id=__codelineno-62-1 name=__codelineno-62-1 href=#__codelineno-62-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>indexing_func</span><span class=p>(</span>
</span><span id=__span-62-2><a id=__codelineno-62-2 name=__codelineno-62-2 href=#__codelineno-62-2></a> <span class=o>*</span><span class=n>args</span><span class=p>,</span>
</span><span id=__span-62-3><a id=__codelineno-62-3 name=__codelineno-62-3 href=#__codelineno-62-3></a> <span class=n>splitter_meta</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-62-4><a id=__codelineno-62-4 name=__codelineno-62-4 href=#__codelineno-62-4></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-62-5><a id=__codelineno-62-5 name=__codelineno-62-5 href=#__codelineno-62-5></a><span class=p>)</span>
</span></code></pre></div> <p>Perform indexing on <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.indexing_func_meta>indexing_func_meta <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1712-L1729 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.indexing_func_meta title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-63-1><a id=__codelineno-63-1 name=__codelineno-63-1 href=#__codelineno-63-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>indexing_func_meta</span><span class=p>(</span>
</span><span id=__span-63-2><a id=__codelineno-63-2 name=__codelineno-63-2 href=#__codelineno-63-2></a> <span class=o>*</span><span class=n>args</span><span class=p>,</span>
</span><span id=__span-63-3><a id=__codelineno-63-3 name=__codelineno-63-3 href=#__codelineno-63-3></a> <span class=n>wrapper_meta</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-63-4><a id=__codelineno-63-4 name=__codelineno-63-4 href=#__codelineno-63-4></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-63-5><a id=__codelineno-63-5 name=__codelineno-63-5 href=#__codelineno-63-5></a><span class=p>)</span>
</span></code></pre></div> <p>Perform indexing on <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> and return metadata.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.is_range_relative>is_range_relative <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1897-L1900 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.is_range_relative title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-64-1><a id=__codelineno-64-1 name=__codelineno-64-1 href=#__codelineno-64-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>is_range_relative</span><span class=p>(</span>
</span><span id=__span-64-2><a id=__codelineno-64-2 name=__codelineno-64-2 href=#__codelineno-64-2></a> <span class=n>range_</span>
</span><span id=__span-64-3><a id=__codelineno-64-3 name=__codelineno-64-3 href=#__codelineno-64-3></a><span class=p>)</span>
</span></code></pre></div> <p>Return whether a range is relative.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.iter_set_mask_arrs>iter_set_mask_arrs <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4361-L4364 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.iter_set_mask_arrs title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_iter_set_mask_arrs title=vectorbtpro.generic.splitting.base.Splitter.get_iter_set_mask_arrs>Splitter.get_iter_set_mask_arrs()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.iter_set_masks>iter_set_masks <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4409-L4412 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.iter_set_masks title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_iter_set_masks title=vectorbtpro.generic.splitting.base.Splitter.get_iter_set_masks>Splitter.get_iter_set_masks()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.iter_split_mask_arrs>iter_split_mask_arrs <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4327-L4330 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.iter_split_mask_arrs title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_iter_split_mask_arrs title=vectorbtpro.generic.splitting.base.Splitter.get_iter_split_mask_arrs>Splitter.get_iter_split_mask_arrs()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.iter_split_masks>iter_split_masks <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4385-L4388 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.iter_split_masks title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_iter_split_masks title=vectorbtpro.generic.splitting.base.Splitter.get_iter_split_masks>Splitter.get_iter_split_masks()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.map_bounds_to_index>map_bounds_to_index <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4086-L4109 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.map_bounds_to_index title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-65-1><a id=__codelineno-65-1 name=__codelineno-65-1 href=#__codelineno-65-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>map_bounds_to_index</span><span class=p>(</span>
</span><span id=__span-65-2><a id=__codelineno-65-2 name=__codelineno-65-2 href=#__codelineno-65-2></a> <span class=n>start</span><span class=p>,</span>
</span><span id=__span-65-3><a id=__codelineno-65-3 name=__codelineno-65-3 href=#__codelineno-65-3></a> <span class=n>stop</span><span class=p>,</span>
</span><span id=__span-65-4><a id=__codelineno-65-4 name=__codelineno-65-4 href=#__codelineno-65-4></a> <span class=n>right_inclusive</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-65-5><a id=__codelineno-65-5 name=__codelineno-65-5 href=#__codelineno-65-5></a> <span class=n>index</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-65-6><a id=__codelineno-65-6 name=__codelineno-65-6 href=#__codelineno-65-6></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-65-7><a id=__codelineno-65-7 name=__codelineno-65-7 href=#__codelineno-65-7></a><span class=p>)</span>
</span></code></pre></div> <p>Map bounds to index.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.mask>mask <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4476-L4479 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.mask title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_mask title=vectorbtpro.generic.splitting.base.Splitter.get_mask>Splitter.get_mask()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.mask_arr>mask_arr <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4437-L4440 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.mask_arr title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_mask_arr title=vectorbtpro.generic.splitting.base.Splitter.get_mask_arr>Splitter.get_mask_arr()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.merge_sets>merge_sets <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L3979-L4082 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.merge_sets title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-66-1><a id=__codelineno-66-1 name=__codelineno-66-1 href=#__codelineno-66-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>merge_sets</span><span class=p>(</span>
</span><span id=__span-66-2><a id=__codelineno-66-2 name=__codelineno-66-2 href=#__codelineno-66-2></a> <span class=n>columns</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-66-3><a id=__codelineno-66-3 name=__codelineno-66-3 href=#__codelineno-66-3></a> <span class=n>new_set_label</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-66-4><a id=__codelineno-66-4 name=__codelineno-66-4 href=#__codelineno-66-4></a> <span class=n>insert_at_last</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-66-5><a id=__codelineno-66-5 name=__codelineno-66-5 href=#__codelineno-66-5></a> <span class=n>wrapper_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-66-6><a id=__codelineno-66-6 name=__codelineno-66-6 href=#__codelineno-66-6></a> <span class=n>init_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-66-7><a id=__codelineno-66-7 name=__codelineno-66-7 href=#__codelineno-66-7></a> <span class=o>**</span><span class=n>merge_split_kwargs</span>
</span><span id=__span-66-8><a id=__codelineno-66-8 name=__codelineno-66-8 href=#__codelineno-66-8></a><span class=p>)</span>
</span></code></pre></div> <p>Merge multiple sets (columns) into a set (column).</p> <p>Arguments <code>**merge_split_kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.merge_split title=vectorbtpro.generic.splitting.base.Splitter.merge_split>Splitter.merge_split()</a>.</p> <p>If columns are not provided, merges all columns. If provided and <code>insert_at_last</code> is True, a new column is inserted at the position of the last column.</p> <p>Use <code>new_set_label</code> to specify the label of the new set. To provide final labels, define <code>columns</code> in <code>wrapper_kwargs</code>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.merge_split>merge_split <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L2308-L2380 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.merge_split title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-67-1><a id=__codelineno-67-1 name=__codelineno-67-1 href=#__codelineno-67-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>merge_split</span><span class=p>(</span>
</span><span id=__span-67-2><a id=__codelineno-67-2 name=__codelineno-67-2 href=#__codelineno-67-2></a> <span class=n>split</span><span class=p>,</span>
</span><span id=__span-67-3><a id=__codelineno-67-3 name=__codelineno-67-3 href=#__codelineno-67-3></a> <span class=n>range_format</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-67-4><a id=__codelineno-67-4 name=__codelineno-67-4 href=#__codelineno-67-4></a> <span class=n>wrap_with_template</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-67-5><a id=__codelineno-67-5 name=__codelineno-67-5 href=#__codelineno-67-5></a> <span class=n>wrap_with_fixrange</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-67-6><a id=__codelineno-67-6 name=__codelineno-67-6 href=#__codelineno-67-6></a> <span class=n>wrap_with_hslice</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-67-7><a id=__codelineno-67-7 name=__codelineno-67-7 href=#__codelineno-67-7></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-67-8><a id=__codelineno-67-8 name=__codelineno-67-8 href=#__codelineno-67-8></a> <span class=n>index</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-67-9><a id=__codelineno-67-9 name=__codelineno-67-9 href=#__codelineno-67-9></a><span class=p>)</span>
</span></code></pre></div> <p>Merge a split of multiple fixed ranges into a fixed range.</p> <p>Creates one mask and sets True for each range. If all input ranges are masks, returns that mask. If all input ranges are slices, returns a slice if possible. Otherwise, returns integer indices.</p> <p>For <code>range_format</code>, see <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_ready_range title=vectorbtpro.generic.splitting.base.Splitter.get_ready_range>Splitter.get_ready_range()</a>. Enable <code>wrap_with_template</code> to wrap the resulting range with a template of the type <a href=../../../utils/template/index.html#vectorbtpro.utils.template.Rep title=vectorbtpro.utils.template.Rep>Rep</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.metrics>metrics <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.metrics title="Permanent link">&para;</a></h3> <p>Metrics supported by <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a>.</p> <div class="language-python highlight"><pre><span></span><code><span id=__span-68-1><a id=__codelineno-68-1 name=__codelineno-68-1 href=#__codelineno-68-1></a><span class=n>HybridConfig</span><span class=p>(</span>
</span><span id=__span-68-2><a id=__codelineno-68-2 name=__codelineno-68-2 href=#__codelineno-68-2></a> <span class=n>start</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-68-3><a id=__codelineno-68-3 name=__codelineno-68-3 href=#__codelineno-68-3></a> <span class=n>title</span><span class=o>=</span><span class=s1>&#39;Index Start&#39;</span><span class=p>,</span>
</span><span id=__span-68-4><a id=__codelineno-68-4 name=__codelineno-68-4 href=#__codelineno-68-4></a> <span class=n>calc_func</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff3386a3b50</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-5><a id=__codelineno-68-5 name=__codelineno-68-5 href=#__codelineno-68-5></a> <span class=n>agg_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-6><a id=__codelineno-68-6 name=__codelineno-68-6 href=#__codelineno-68-6></a> <span class=n>tags</span><span class=o>=</span><span class=p>[</span>
</span><span id=__span-68-7><a id=__codelineno-68-7 name=__codelineno-68-7 href=#__codelineno-68-7></a> <span class=s1>&#39;splitter&#39;</span><span class=p>,</span>
</span><span id=__span-68-8><a id=__codelineno-68-8 name=__codelineno-68-8 href=#__codelineno-68-8></a> <span class=s1>&#39;index&#39;</span>
</span><span id=__span-68-9><a id=__codelineno-68-9 name=__codelineno-68-9 href=#__codelineno-68-9></a> <span class=p>]</span>
</span><span id=__span-68-10><a id=__codelineno-68-10 name=__codelineno-68-10 href=#__codelineno-68-10></a> <span class=p>),</span>
</span><span id=__span-68-11><a id=__codelineno-68-11 name=__codelineno-68-11 href=#__codelineno-68-11></a> <span class=n>end</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-68-12><a id=__codelineno-68-12 name=__codelineno-68-12 href=#__codelineno-68-12></a> <span class=n>title</span><span class=o>=</span><span class=s1>&#39;Index End&#39;</span><span class=p>,</span>
</span><span id=__span-68-13><a id=__codelineno-68-13 name=__codelineno-68-13 href=#__codelineno-68-13></a> <span class=n>calc_func</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff3386a3be0</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-14><a id=__codelineno-68-14 name=__codelineno-68-14 href=#__codelineno-68-14></a> <span class=n>agg_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-15><a id=__codelineno-68-15 name=__codelineno-68-15 href=#__codelineno-68-15></a> <span class=n>tags</span><span class=o>=</span><span class=p>[</span>
</span><span id=__span-68-16><a id=__codelineno-68-16 name=__codelineno-68-16 href=#__codelineno-68-16></a> <span class=s1>&#39;splitter&#39;</span><span class=p>,</span>
</span><span id=__span-68-17><a id=__codelineno-68-17 name=__codelineno-68-17 href=#__codelineno-68-17></a> <span class=s1>&#39;index&#39;</span>
</span><span id=__span-68-18><a id=__codelineno-68-18 name=__codelineno-68-18 href=#__codelineno-68-18></a> <span class=p>]</span>
</span><span id=__span-68-19><a id=__codelineno-68-19 name=__codelineno-68-19 href=#__codelineno-68-19></a> <span class=p>),</span>
</span><span id=__span-68-20><a id=__codelineno-68-20 name=__codelineno-68-20 href=#__codelineno-68-20></a> <span class=n>period</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-68-21><a id=__codelineno-68-21 name=__codelineno-68-21 href=#__codelineno-68-21></a> <span class=n>title</span><span class=o>=</span><span class=s1>&#39;Index Length&#39;</span><span class=p>,</span>
</span><span id=__span-68-22><a id=__codelineno-68-22 name=__codelineno-68-22 href=#__codelineno-68-22></a> <span class=n>calc_func</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff3386a3c70</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-23><a id=__codelineno-68-23 name=__codelineno-68-23 href=#__codelineno-68-23></a> <span class=n>agg_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-24><a id=__codelineno-68-24 name=__codelineno-68-24 href=#__codelineno-68-24></a> <span class=n>tags</span><span class=o>=</span><span class=p>[</span>
</span><span id=__span-68-25><a id=__codelineno-68-25 name=__codelineno-68-25 href=#__codelineno-68-25></a> <span class=s1>&#39;splitter&#39;</span><span class=p>,</span>
</span><span id=__span-68-26><a id=__codelineno-68-26 name=__codelineno-68-26 href=#__codelineno-68-26></a> <span class=s1>&#39;index&#39;</span>
</span><span id=__span-68-27><a id=__codelineno-68-27 name=__codelineno-68-27 href=#__codelineno-68-27></a> <span class=p>]</span>
</span><span id=__span-68-28><a id=__codelineno-68-28 name=__codelineno-68-28 href=#__codelineno-68-28></a> <span class=p>),</span>
</span><span id=__span-68-29><a id=__codelineno-68-29 name=__codelineno-68-29 href=#__codelineno-68-29></a> <span class=n>split_count</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-68-30><a id=__codelineno-68-30 name=__codelineno-68-30 href=#__codelineno-68-30></a> <span class=n>title</span><span class=o>=</span><span class=s1>&#39;Splits&#39;</span><span class=p>,</span>
</span><span id=__span-68-31><a id=__codelineno-68-31 name=__codelineno-68-31 href=#__codelineno-68-31></a> <span class=n>calc_func</span><span class=o>=</span><span class=s1>&#39;n_splits&#39;</span><span class=p>,</span>
</span><span id=__span-68-32><a id=__codelineno-68-32 name=__codelineno-68-32 href=#__codelineno-68-32></a> <span class=n>agg_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-33><a id=__codelineno-68-33 name=__codelineno-68-33 href=#__codelineno-68-33></a> <span class=n>tags</span><span class=o>=</span><span class=p>[</span>
</span><span id=__span-68-34><a id=__codelineno-68-34 name=__codelineno-68-34 href=#__codelineno-68-34></a> <span class=s1>&#39;splitter&#39;</span><span class=p>,</span>
</span><span id=__span-68-35><a id=__codelineno-68-35 name=__codelineno-68-35 href=#__codelineno-68-35></a> <span class=s1>&#39;splits&#39;</span>
</span><span id=__span-68-36><a id=__codelineno-68-36 name=__codelineno-68-36 href=#__codelineno-68-36></a> <span class=p>]</span>
</span><span id=__span-68-37><a id=__codelineno-68-37 name=__codelineno-68-37 href=#__codelineno-68-37></a> <span class=p>),</span>
</span><span id=__span-68-38><a id=__codelineno-68-38 name=__codelineno-68-38 href=#__codelineno-68-38></a> <span class=n>set_count</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-68-39><a id=__codelineno-68-39 name=__codelineno-68-39 href=#__codelineno-68-39></a> <span class=n>title</span><span class=o>=</span><span class=s1>&#39;Sets&#39;</span><span class=p>,</span>
</span><span id=__span-68-40><a id=__codelineno-68-40 name=__codelineno-68-40 href=#__codelineno-68-40></a> <span class=n>calc_func</span><span class=o>=</span><span class=s1>&#39;n_sets&#39;</span><span class=p>,</span>
</span><span id=__span-68-41><a id=__codelineno-68-41 name=__codelineno-68-41 href=#__codelineno-68-41></a> <span class=n>agg_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-42><a id=__codelineno-68-42 name=__codelineno-68-42 href=#__codelineno-68-42></a> <span class=n>tags</span><span class=o>=</span><span class=p>[</span>
</span><span id=__span-68-43><a id=__codelineno-68-43 name=__codelineno-68-43 href=#__codelineno-68-43></a> <span class=s1>&#39;splitter&#39;</span><span class=p>,</span>
</span><span id=__span-68-44><a id=__codelineno-68-44 name=__codelineno-68-44 href=#__codelineno-68-44></a> <span class=s1>&#39;splits&#39;</span>
</span><span id=__span-68-45><a id=__codelineno-68-45 name=__codelineno-68-45 href=#__codelineno-68-45></a> <span class=p>]</span>
</span><span id=__span-68-46><a id=__codelineno-68-46 name=__codelineno-68-46 href=#__codelineno-68-46></a> <span class=p>),</span>
</span><span id=__span-68-47><a id=__codelineno-68-47 name=__codelineno-68-47 href=#__codelineno-68-47></a> <span class=n>coverage</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-68-48><a id=__codelineno-68-48 name=__codelineno-68-48 href=#__codelineno-68-48></a> <span class=n>title</span><span class=o>=</span><span class=n>RepFunc</span><span class=p>(</span>
</span><span id=__span-68-49><a id=__codelineno-68-49 name=__codelineno-68-49 href=#__codelineno-68-49></a> <span class=n>template</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff3386a3d00</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-50><a id=__codelineno-68-50 name=__codelineno-68-50 href=#__codelineno-68-50></a> <span class=n>context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-51><a id=__codelineno-68-51 name=__codelineno-68-51 href=#__codelineno-68-51></a> <span class=n>strict</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-52><a id=__codelineno-68-52 name=__codelineno-68-52 href=#__codelineno-68-52></a> <span class=n>sub_id</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-53><a id=__codelineno-68-53 name=__codelineno-68-53 href=#__codelineno-68-53></a> <span class=n>context_merge_kwargs</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-68-54><a id=__codelineno-68-54 name=__codelineno-68-54 href=#__codelineno-68-54></a> <span class=p>),</span>
</span><span id=__span-68-55><a id=__codelineno-68-55 name=__codelineno-68-55 href=#__codelineno-68-55></a> <span class=n>calc_func</span><span class=o>=</span><span class=s1>&#39;coverage&#39;</span><span class=p>,</span>
</span><span id=__span-68-56><a id=__codelineno-68-56 name=__codelineno-68-56 href=#__codelineno-68-56></a> <span class=n>overlapping</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-68-57><a id=__codelineno-68-57 name=__codelineno-68-57 href=#__codelineno-68-57></a> <span class=n>post_calc_func</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff3386a3d90</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-58><a id=__codelineno-68-58 name=__codelineno-68-58 href=#__codelineno-68-58></a> <span class=n>agg_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-59><a id=__codelineno-68-59 name=__codelineno-68-59 href=#__codelineno-68-59></a> <span class=n>tags</span><span class=o>=</span><span class=p>[</span>
</span><span id=__span-68-60><a id=__codelineno-68-60 name=__codelineno-68-60 href=#__codelineno-68-60></a> <span class=s1>&#39;splitter&#39;</span><span class=p>,</span>
</span><span id=__span-68-61><a id=__codelineno-68-61 name=__codelineno-68-61 href=#__codelineno-68-61></a> <span class=s1>&#39;splits&#39;</span><span class=p>,</span>
</span><span id=__span-68-62><a id=__codelineno-68-62 name=__codelineno-68-62 href=#__codelineno-68-62></a> <span class=s1>&#39;coverage&#39;</span>
</span><span id=__span-68-63><a id=__codelineno-68-63 name=__codelineno-68-63 href=#__codelineno-68-63></a> <span class=p>]</span>
</span><span id=__span-68-64><a id=__codelineno-68-64 name=__codelineno-68-64 href=#__codelineno-68-64></a> <span class=p>),</span>
</span><span id=__span-68-65><a id=__codelineno-68-65 name=__codelineno-68-65 href=#__codelineno-68-65></a> <span class=n>set_coverage</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-68-66><a id=__codelineno-68-66 name=__codelineno-68-66 href=#__codelineno-68-66></a> <span class=n>title</span><span class=o>=</span><span class=n>RepFunc</span><span class=p>(</span>
</span><span id=__span-68-67><a id=__codelineno-68-67 name=__codelineno-68-67 href=#__codelineno-68-67></a> <span class=n>template</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff3386a3e20</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-68><a id=__codelineno-68-68 name=__codelineno-68-68 href=#__codelineno-68-68></a> <span class=n>context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-69><a id=__codelineno-68-69 name=__codelineno-68-69 href=#__codelineno-68-69></a> <span class=n>strict</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-70><a id=__codelineno-68-70 name=__codelineno-68-70 href=#__codelineno-68-70></a> <span class=n>sub_id</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-71><a id=__codelineno-68-71 name=__codelineno-68-71 href=#__codelineno-68-71></a> <span class=n>context_merge_kwargs</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-68-72><a id=__codelineno-68-72 name=__codelineno-68-72 href=#__codelineno-68-72></a> <span class=p>),</span>
</span><span id=__span-68-73><a id=__codelineno-68-73 name=__codelineno-68-73 href=#__codelineno-68-73></a> <span class=n>check_has_multiple_sets</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-68-74><a id=__codelineno-68-74 name=__codelineno-68-74 href=#__codelineno-68-74></a> <span class=n>calc_func</span><span class=o>=</span><span class=s1>&#39;set_coverage&#39;</span><span class=p>,</span>
</span><span id=__span-68-75><a id=__codelineno-68-75 name=__codelineno-68-75 href=#__codelineno-68-75></a> <span class=n>overlapping</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-68-76><a id=__codelineno-68-76 name=__codelineno-68-76 href=#__codelineno-68-76></a> <span class=n>relative</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-68-77><a id=__codelineno-68-77 name=__codelineno-68-77 href=#__codelineno-68-77></a> <span class=n>post_calc_func</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff3386a3eb0</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-78><a id=__codelineno-68-78 name=__codelineno-68-78 href=#__codelineno-68-78></a> <span class=n>agg_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-79><a id=__codelineno-68-79 name=__codelineno-68-79 href=#__codelineno-68-79></a> <span class=n>tags</span><span class=o>=</span><span class=p>[</span>
</span><span id=__span-68-80><a id=__codelineno-68-80 name=__codelineno-68-80 href=#__codelineno-68-80></a> <span class=s1>&#39;splitter&#39;</span><span class=p>,</span>
</span><span id=__span-68-81><a id=__codelineno-68-81 name=__codelineno-68-81 href=#__codelineno-68-81></a> <span class=s1>&#39;splits&#39;</span><span class=p>,</span>
</span><span id=__span-68-82><a id=__codelineno-68-82 name=__codelineno-68-82 href=#__codelineno-68-82></a> <span class=s1>&#39;coverage&#39;</span>
</span><span id=__span-68-83><a id=__codelineno-68-83 name=__codelineno-68-83 href=#__codelineno-68-83></a> <span class=p>]</span>
</span><span id=__span-68-84><a id=__codelineno-68-84 name=__codelineno-68-84 href=#__codelineno-68-84></a> <span class=p>),</span>
</span><span id=__span-68-85><a id=__codelineno-68-85 name=__codelineno-68-85 href=#__codelineno-68-85></a> <span class=n>set_mean_rel_coverage</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-68-86><a id=__codelineno-68-86 name=__codelineno-68-86 href=#__codelineno-68-86></a> <span class=n>title</span><span class=o>=</span><span class=s1>&#39;Mean Rel Coverage [%]&#39;</span><span class=p>,</span>
</span><span id=__span-68-87><a id=__codelineno-68-87 name=__codelineno-68-87 href=#__codelineno-68-87></a> <span class=n>check_has_multiple_sets</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-68-88><a id=__codelineno-68-88 name=__codelineno-68-88 href=#__codelineno-68-88></a> <span class=n>check_normalize</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-68-89><a id=__codelineno-68-89 name=__codelineno-68-89 href=#__codelineno-68-89></a> <span class=n>calc_func</span><span class=o>=</span><span class=s1>&#39;range_coverage&#39;</span><span class=p>,</span>
</span><span id=__span-68-90><a id=__codelineno-68-90 name=__codelineno-68-90 href=#__codelineno-68-90></a> <span class=n>relative</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-68-91><a id=__codelineno-68-91 name=__codelineno-68-91 href=#__codelineno-68-91></a> <span class=n>post_calc_func</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff3386a3f40</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-92><a id=__codelineno-68-92 name=__codelineno-68-92 href=#__codelineno-68-92></a> <span class=n>agg_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-93><a id=__codelineno-68-93 name=__codelineno-68-93 href=#__codelineno-68-93></a> <span class=n>tags</span><span class=o>=</span><span class=p>[</span>
</span><span id=__span-68-94><a id=__codelineno-68-94 name=__codelineno-68-94 href=#__codelineno-68-94></a> <span class=s1>&#39;splitter&#39;</span><span class=p>,</span>
</span><span id=__span-68-95><a id=__codelineno-68-95 name=__codelineno-68-95 href=#__codelineno-68-95></a> <span class=s1>&#39;splits&#39;</span><span class=p>,</span>
</span><span id=__span-68-96><a id=__codelineno-68-96 name=__codelineno-68-96 href=#__codelineno-68-96></a> <span class=s1>&#39;coverage&#39;</span>
</span><span id=__span-68-97><a id=__codelineno-68-97 name=__codelineno-68-97 href=#__codelineno-68-97></a> <span class=p>]</span>
</span><span id=__span-68-98><a id=__codelineno-68-98 name=__codelineno-68-98 href=#__codelineno-68-98></a> <span class=p>),</span>
</span><span id=__span-68-99><a id=__codelineno-68-99 name=__codelineno-68-99 href=#__codelineno-68-99></a> <span class=n>overlap_coverage</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-68-100><a id=__codelineno-68-100 name=__codelineno-68-100 href=#__codelineno-68-100></a> <span class=n>title</span><span class=o>=</span><span class=n>RepFunc</span><span class=p>(</span>
</span><span id=__span-68-101><a id=__codelineno-68-101 name=__codelineno-68-101 href=#__codelineno-68-101></a> <span class=n>template</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff35a380040</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-102><a id=__codelineno-68-102 name=__codelineno-68-102 href=#__codelineno-68-102></a> <span class=n>context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-103><a id=__codelineno-68-103 name=__codelineno-68-103 href=#__codelineno-68-103></a> <span class=n>strict</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-104><a id=__codelineno-68-104 name=__codelineno-68-104 href=#__codelineno-68-104></a> <span class=n>sub_id</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-105><a id=__codelineno-68-105 name=__codelineno-68-105 href=#__codelineno-68-105></a> <span class=n>context_merge_kwargs</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-68-106><a id=__codelineno-68-106 name=__codelineno-68-106 href=#__codelineno-68-106></a> <span class=p>),</span>
</span><span id=__span-68-107><a id=__codelineno-68-107 name=__codelineno-68-107 href=#__codelineno-68-107></a> <span class=n>calc_func</span><span class=o>=</span><span class=s1>&#39;coverage&#39;</span><span class=p>,</span>
</span><span id=__span-68-108><a id=__codelineno-68-108 name=__codelineno-68-108 href=#__codelineno-68-108></a> <span class=n>overlapping</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-68-109><a id=__codelineno-68-109 name=__codelineno-68-109 href=#__codelineno-68-109></a> <span class=n>post_calc_func</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff35a3800d0</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-110><a id=__codelineno-68-110 name=__codelineno-68-110 href=#__codelineno-68-110></a> <span class=n>agg_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-111><a id=__codelineno-68-111 name=__codelineno-68-111 href=#__codelineno-68-111></a> <span class=n>tags</span><span class=o>=</span><span class=p>[</span>
</span><span id=__span-68-112><a id=__codelineno-68-112 name=__codelineno-68-112 href=#__codelineno-68-112></a> <span class=s1>&#39;splitter&#39;</span><span class=p>,</span>
</span><span id=__span-68-113><a id=__codelineno-68-113 name=__codelineno-68-113 href=#__codelineno-68-113></a> <span class=s1>&#39;splits&#39;</span><span class=p>,</span>
</span><span id=__span-68-114><a id=__codelineno-68-114 name=__codelineno-68-114 href=#__codelineno-68-114></a> <span class=s1>&#39;coverage&#39;</span>
</span><span id=__span-68-115><a id=__codelineno-68-115 name=__codelineno-68-115 href=#__codelineno-68-115></a> <span class=p>]</span>
</span><span id=__span-68-116><a id=__codelineno-68-116 name=__codelineno-68-116 href=#__codelineno-68-116></a> <span class=p>),</span>
</span><span id=__span-68-117><a id=__codelineno-68-117 name=__codelineno-68-117 href=#__codelineno-68-117></a> <span class=n>set_overlap_coverage</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-68-118><a id=__codelineno-68-118 name=__codelineno-68-118 href=#__codelineno-68-118></a> <span class=n>title</span><span class=o>=</span><span class=n>RepFunc</span><span class=p>(</span>
</span><span id=__span-68-119><a id=__codelineno-68-119 name=__codelineno-68-119 href=#__codelineno-68-119></a> <span class=n>template</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff35a380160</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-120><a id=__codelineno-68-120 name=__codelineno-68-120 href=#__codelineno-68-120></a> <span class=n>context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-121><a id=__codelineno-68-121 name=__codelineno-68-121 href=#__codelineno-68-121></a> <span class=n>strict</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-122><a id=__codelineno-68-122 name=__codelineno-68-122 href=#__codelineno-68-122></a> <span class=n>sub_id</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-123><a id=__codelineno-68-123 name=__codelineno-68-123 href=#__codelineno-68-123></a> <span class=n>context_merge_kwargs</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-68-124><a id=__codelineno-68-124 name=__codelineno-68-124 href=#__codelineno-68-124></a> <span class=p>),</span>
</span><span id=__span-68-125><a id=__codelineno-68-125 name=__codelineno-68-125 href=#__codelineno-68-125></a> <span class=n>check_has_multiple_sets</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-68-126><a id=__codelineno-68-126 name=__codelineno-68-126 href=#__codelineno-68-126></a> <span class=n>calc_func</span><span class=o>=</span><span class=s1>&#39;set_coverage&#39;</span><span class=p>,</span>
</span><span id=__span-68-127><a id=__codelineno-68-127 name=__codelineno-68-127 href=#__codelineno-68-127></a> <span class=n>overlapping</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-68-128><a id=__codelineno-68-128 name=__codelineno-68-128 href=#__codelineno-68-128></a> <span class=n>post_calc_func</span><span class=o>=&lt;</span><span class=n>function</span> <span class=n>Splitter</span><span class=o>.&lt;</span><span class=k>lambda</span><span class=o>&gt;</span> <span class=n>at</span> <span class=mh>0x7ff35a3801f0</span><span class=o>&gt;</span><span class=p>,</span>
</span><span id=__span-68-129><a id=__codelineno-68-129 name=__codelineno-68-129 href=#__codelineno-68-129></a> <span class=n>agg_func</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-68-130><a id=__codelineno-68-130 name=__codelineno-68-130 href=#__codelineno-68-130></a> <span class=n>tags</span><span class=o>=</span><span class=p>[</span>
</span><span id=__span-68-131><a id=__codelineno-68-131 name=__codelineno-68-131 href=#__codelineno-68-131></a> <span class=s1>&#39;splitter&#39;</span><span class=p>,</span>
</span><span id=__span-68-132><a id=__codelineno-68-132 name=__codelineno-68-132 href=#__codelineno-68-132></a> <span class=s1>&#39;splits&#39;</span><span class=p>,</span>
</span><span id=__span-68-133><a id=__codelineno-68-133 name=__codelineno-68-133 href=#__codelineno-68-133></a> <span class=s1>&#39;coverage&#39;</span>
</span><span id=__span-68-134><a id=__codelineno-68-134 name=__codelineno-68-134 href=#__codelineno-68-134></a> <span class=p>]</span>
</span><span id=__span-68-135><a id=__codelineno-68-135 name=__codelineno-68-135 href=#__codelineno-68-135></a> <span class=p>)</span>
</span><span id=__span-68-136><a id=__codelineno-68-136 name=__codelineno-68-136 href=#__codelineno-68-136></a><span class=p>)</span>
</span></code></pre></div> <p>Returns <code>Splitter._metrics</code>, which gets (hybrid-) copied upon creation of each instance. Thus, changing this config won't affect the class.</p> <p>To change metrics, you can either change the config in-place, override this property, or overwrite the instance variable <code>Splitter._metrics</code>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.n_sets>n_sets <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1773-L1776 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.n_sets title="Permanent link">&para;</a></h3> <p>Number of sets.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.n_splits>n_splits <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1768-L1771 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.n_splits title="Permanent link">&para;</a></h3> <p>Number of splits.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.parse_and_inject_takeables>parse_and_inject_takeables <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L3064-L3085 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.parse_and_inject_takeables title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-69-1><a id=__codelineno-69-1 name=__codelineno-69-1 href=#__codelineno-69-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>parse_and_inject_takeables</span><span class=p>(</span>
</span><span id=__span-69-2><a id=__codelineno-69-2 name=__codelineno-69-2 href=#__codelineno-69-2></a> <span class=n>flat_ann_args</span>
</span><span id=__span-69-3><a id=__codelineno-69-3 name=__codelineno-69-3 href=#__codelineno-69-3></a><span class=p>)</span>
</span></code></pre></div> <p>Parse <a href=index.html#vectorbtpro.generic.splitting.base.Takeable title=vectorbtpro.generic.splitting.base.Takeable>Takeable</a> instances from function annotations and inject them into flattened annotated arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.plot>plot <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4839-L4929 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.plot title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-70-1><a id=__codelineno-70-1 name=__codelineno-70-1 href=#__codelineno-70-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>(</span>
</span><span id=__span-70-2><a id=__codelineno-70-2 name=__codelineno-70-2 href=#__codelineno-70-2></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-70-3><a id=__codelineno-70-3 name=__codelineno-70-3 href=#__codelineno-70-3></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-70-4><a id=__codelineno-70-4 name=__codelineno-70-4 href=#__codelineno-70-4></a> <span class=n>mask_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-70-5><a id=__codelineno-70-5 name=__codelineno-70-5 href=#__codelineno-70-5></a> <span class=n>trace_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-70-6><a id=__codelineno-70-6 name=__codelineno-70-6 href=#__codelineno-70-6></a> <span class=n>add_trace_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-70-7><a id=__codelineno-70-7 name=__codelineno-70-7 href=#__codelineno-70-7></a> <span class=n>fig</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-70-8><a id=__codelineno-70-8 name=__codelineno-70-8 href=#__codelineno-70-8></a> <span class=o>**</span><span class=n>layout_kwargs</span>
</span><span id=__span-70-9><a id=__codelineno-70-9 name=__codelineno-70-9 href=#__codelineno-70-9></a><span class=p>)</span>
</span></code></pre></div> <p>Plot splits as rows and sets as colors.</p> <p><strong>Args</strong></p> <dl> <dt><strong><code>split_group_by</code></strong> :&ensp;<code>any</code></dt> <dd>Split groups. See <a href=../../../base/accessors/index.html#vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper title=vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper>BaseIDXAccessor.get_grouper()</a>.</dd> <dt><strong><code>set_group_by</code></strong> :&ensp;<code>any</code></dt> <dd>Set groups. See <a href=../../../base/accessors/index.html#vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper title=vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper>BaseIDXAccessor.get_grouper()</a>.</dd> <dt><strong><code>mask_kwargs</code></strong> :&ensp;<code>dict</code></dt> <dd>Keyword arguments passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_iter_set_masks title=vectorbtpro.generic.splitting.base.Splitter.get_iter_set_masks>Splitter.get_iter_set_masks()</a>.</dd> <dt><strong><code>trace_kwargs</code></strong> :&ensp;<code>dict</code></dt> <dd> <p>Keyword arguments passed to <code>plotly.graph_objects.Heatmap</code>.</p> <p>Can be a sequence, one per set.</p> </dd> <dt><strong><code>add_trace_kwargs</code></strong> :&ensp;<code>dict</code></dt> <dd>Keyword arguments passed to <code>add_trace</code>.</dd> <dt><strong><code>fig</code></strong> :&ensp;<code>Figure</code> or <code>FigureWidget</code></dt> <dd>Figure to add traces to.</dd> <dt><strong><code>**layout_kwargs</code></strong></dt> <dd>Keyword arguments for layout.</dd> </dl> <p><strong>Usage</strong></p> <ul> <li>Plot a scikit-learn splitter:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-71-1><a id=__codelineno-71-1 name=__codelineno-71-1 href=#__codelineno-71-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-71-2><a id=__codelineno-71-2 name=__codelineno-71-2 href=#__codelineno-71-2></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>sklearn.model_selection</span> <span class=kn>import</span> <span class=n>TimeSeriesSplit</span>
</span><span id=__span-71-3><a id=__codelineno-71-3 name=__codelineno-71-3 href=#__codelineno-71-3></a>
</span><span id=__span-71-4><a id=__codelineno-71-4 name=__codelineno-71-4 href=#__codelineno-71-4></a><span class=gp>&gt;&gt;&gt; </span><span class=n>index</span> <span class=o>=</span> <span class=n>pd</span><span class=o>.</span><span class=n>date_range</span><span class=p>(</span><span class=s2>&quot;2020&quot;</span><span class=p>,</span> <span class=s2>&quot;2021&quot;</span><span class=p>,</span> <span class=n>freq</span><span class=o>=</span><span class=s2>&quot;D&quot;</span><span class=p>)</span>
</span><span id=__span-71-5><a id=__codelineno-71-5 name=__codelineno-71-5 href=#__codelineno-71-5></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_sklearn</span><span class=p>(</span><span class=n>index</span><span class=p>,</span> <span class=n>TimeSeriesSplit</span><span class=p>())</span>
</span><span id=__span-71-6><a id=__codelineno-71-6 name=__codelineno-71-6 href=#__codelineno-71-6></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/Splitter.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/Splitter.dark.svg#only-dark></p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.plot_coverage>plot_coverage <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4931-L5025 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.plot_coverage title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-72-1><a id=__codelineno-72-1 name=__codelineno-72-1 href=#__codelineno-72-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>plot_coverage</span><span class=p>(</span>
</span><span id=__span-72-2><a id=__codelineno-72-2 name=__codelineno-72-2 href=#__codelineno-72-2></a> <span class=n>stacked</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-72-3><a id=__codelineno-72-3 name=__codelineno-72-3 href=#__codelineno-72-3></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-72-4><a id=__codelineno-72-4 name=__codelineno-72-4 href=#__codelineno-72-4></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-72-5><a id=__codelineno-72-5 name=__codelineno-72-5 href=#__codelineno-72-5></a> <span class=n>mask_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-72-6><a id=__codelineno-72-6 name=__codelineno-72-6 href=#__codelineno-72-6></a> <span class=n>trace_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-72-7><a id=__codelineno-72-7 name=__codelineno-72-7 href=#__codelineno-72-7></a> <span class=n>add_trace_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-72-8><a id=__codelineno-72-8 name=__codelineno-72-8 href=#__codelineno-72-8></a> <span class=n>fig</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-72-9><a id=__codelineno-72-9 name=__codelineno-72-9 href=#__codelineno-72-9></a> <span class=o>**</span><span class=n>layout_kwargs</span>
</span><span id=__span-72-10><a id=__codelineno-72-10 name=__codelineno-72-10 href=#__codelineno-72-10></a><span class=p>)</span>
</span></code></pre></div> <p>Plot index as rows and sets as lines.</p> <p><strong>Args</strong></p> <dl> <dt><strong><code>stacked</code></strong> :&ensp;<code>bool</code></dt> <dd>Whether to plot as an area plot.</dd> <dt><strong><code>split_group_by</code></strong> :&ensp;<code>any</code></dt> <dd>Split groups. See <a href=../../../base/accessors/index.html#vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper title=vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper>BaseIDXAccessor.get_grouper()</a>.</dd> <dt><strong><code>set_group_by</code></strong> :&ensp;<code>any</code></dt> <dd>Set groups. See <a href=../../../base/accessors/index.html#vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper title=vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper>BaseIDXAccessor.get_grouper()</a>.</dd> <dt><strong><code>mask_kwargs</code></strong> :&ensp;<code>dict</code></dt> <dd>Keyword arguments passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_iter_set_masks title=vectorbtpro.generic.splitting.base.Splitter.get_iter_set_masks>Splitter.get_iter_set_masks()</a>.</dd> <dt><strong><code>trace_kwargs</code></strong> :&ensp;<code>dict</code></dt> <dd> <p>Keyword arguments passed to <code>plotly.graph_objects.Scatter</code>.</p> <p>Can be a sequence, one per set.</p> </dd> <dt><strong><code>add_trace_kwargs</code></strong> :&ensp;<code>dict</code></dt> <dd>Keyword arguments passed to <code>add_trace</code>.</dd> <dt><strong><code>fig</code></strong> :&ensp;<code>Figure</code> or <code>FigureWidget</code></dt> <dd>Figure to add traces to.</dd> <dt><strong><code>**layout_kwargs</code></strong></dt> <dd>Keyword arguments for layout.</dd> </dl> <p><strong>Usage</strong></p> <ul> <li>Area plot:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-73-1><a id=__codelineno-73-1 name=__codelineno-73-1 href=#__codelineno-73-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-73-2><a id=__codelineno-73-2 name=__codelineno-73-2 href=#__codelineno-73-2></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>sklearn.model_selection</span> <span class=kn>import</span> <span class=n>TimeSeriesSplit</span>
</span><span id=__span-73-3><a id=__codelineno-73-3 name=__codelineno-73-3 href=#__codelineno-73-3></a>
</span><span id=__span-73-4><a id=__codelineno-73-4 name=__codelineno-73-4 href=#__codelineno-73-4></a><span class=gp>&gt;&gt;&gt; </span><span class=n>index</span> <span class=o>=</span> <span class=n>pd</span><span class=o>.</span><span class=n>date_range</span><span class=p>(</span><span class=s2>&quot;2020&quot;</span><span class=p>,</span> <span class=s2>&quot;2021&quot;</span><span class=p>,</span> <span class=n>freq</span><span class=o>=</span><span class=s2>&quot;D&quot;</span><span class=p>)</span>
</span><span id=__span-73-5><a id=__codelineno-73-5 name=__codelineno-73-5 href=#__codelineno-73-5></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_sklearn</span><span class=p>(</span><span class=n>index</span><span class=p>,</span> <span class=n>TimeSeriesSplit</span><span class=p>())</span>
</span><span id=__span-73-6><a id=__codelineno-73-6 name=__codelineno-73-6 href=#__codelineno-73-6></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot_coverage</span><span class=p>()</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/Splitter_coverage_area.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/Splitter_coverage_area.dark.svg#only-dark></p> <ul> <li>Line plot:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-74-1><a id=__codelineno-74-1 name=__codelineno-74-1 href=#__codelineno-74-1></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>plot_coverage</span><span class=p>(</span><span class=n>stacked</span><span class=o>=</span><span class=kc>False</span><span class=p>)</span><span class=o>.</span><span class=n>show</span><span class=p>()</span>
</span></code></pre></div> <p><img alt class=iimg loading=lazy src=../../../../assets/images/api/Splitter_coverage_line.light.svg#only-light> <img alt class=iimg loading=lazy src=../../../../assets/images/api/Splitter_coverage_line.dark.svg#only-dark></p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.plots_defaults>plots_defaults <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L5027-L5037 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.plots_defaults title="Permanent link">&para;</a></h3> <p>Defaults for <a href=../../plots_builder/index.html#vectorbtpro.generic.plots_builder.PlotsBuilderMixin.plots title=vectorbtpro.generic.splitting.base.Splitter.plots>PlotsBuilderMixin.plots()</a>.</p> <p>Merges <a href=../../plots_builder/index.html#vectorbtpro.generic.plots_builder.PlotsBuilderMixin.plots_defaults title=vectorbtpro.generic.plots_builder.PlotsBuilderMixin.plots_defaults>PlotsBuilderMixin.plots_defaults</a> and <code>plots</code> from <a href=../../../_settings/index.html#vectorbtpro._settings.splitter title=vectorbtpro._settings.splitter>splitter</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.range_coverage>range_coverage <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4614-L4617 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.range_coverage title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_range_coverage title=vectorbtpro.generic.splitting.base.Splitter.get_range_coverage>Splitter.get_range_coverage()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.range_overlap_matrix>range_overlap_matrix <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4724-L4727 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.range_overlap_matrix title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_overlap_matrix title=vectorbtpro.generic.splitting.base.Splitter.get_overlap_matrix>Splitter.get_overlap_matrix()</a> with <code>by="range"</code>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.remap_range>remap_range <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L2543-L2580 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.remap_range title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-75-1><a id=__codelineno-75-1 name=__codelineno-75-1 href=#__codelineno-75-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>remap_range</span><span class=p>(</span>
</span><span id=__span-75-2><a id=__codelineno-75-2 name=__codelineno-75-2 href=#__codelineno-75-2></a> <span class=n>range_</span><span class=p>,</span>
</span><span id=__span-75-3><a id=__codelineno-75-3 name=__codelineno-75-3 href=#__codelineno-75-3></a> <span class=n>target_index</span><span class=p>,</span>
</span><span id=__span-75-4><a id=__codelineno-75-4 name=__codelineno-75-4 href=#__codelineno-75-4></a> <span class=n>target_freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-75-5><a id=__codelineno-75-5 name=__codelineno-75-5 href=#__codelineno-75-5></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-75-6><a id=__codelineno-75-6 name=__codelineno-75-6 href=#__codelineno-75-6></a> <span class=n>jitted</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-75-7><a id=__codelineno-75-7 name=__codelineno-75-7 href=#__codelineno-75-7></a> <span class=n>silence_warnings</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-75-8><a id=__codelineno-75-8 name=__codelineno-75-8 href=#__codelineno-75-8></a> <span class=n>index</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-75-9><a id=__codelineno-75-9 name=__codelineno-75-9 href=#__codelineno-75-9></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-75-10><a id=__codelineno-75-10 name=__codelineno-75-10 href=#__codelineno-75-10></a><span class=p>)</span>
</span></code></pre></div> <p>Remap a range to a target index.</p> <p>If <code>index</code> and <code>target_index</code> are the same, returns the range. Otherwise, uses <a href=../../../base/resampling/base/index.html#vectorbtpro.base.resampling.base.Resampler.resample_source_mask title=vectorbtpro.base.resampling.base.Resampler.resample_source_mask>Resampler.resample_source_mask()</a> to resample the range into the target index. In such a case, <code>freq</code> and <code>target_freq</code> must be provided.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.resolve_column_stack_kwargs>resolve_column_stack_kwargs <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1606-L1621 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.resolve_column_stack_kwargs title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-76-1><a id=__codelineno-76-1 name=__codelineno-76-1 href=#__codelineno-76-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>resolve_column_stack_kwargs</span><span class=p>(</span>
</span><span id=__span-76-2><a id=__codelineno-76-2 name=__codelineno-76-2 href=#__codelineno-76-2></a> <span class=o>*</span><span class=n>objs</span><span class=p>,</span>
</span><span id=__span-76-3><a id=__codelineno-76-3 name=__codelineno-76-3 href=#__codelineno-76-3></a> <span class=n>reindex_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-76-4><a id=__codelineno-76-4 name=__codelineno-76-4 href=#__codelineno-76-4></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-76-5><a id=__codelineno-76-5 name=__codelineno-76-5 href=#__codelineno-76-5></a><span class=p>)</span>
</span></code></pre></div> <p>Resolve keyword arguments for initializing <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> after stacking along columns.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.resolve_row_stack_kwargs>resolve_row_stack_kwargs <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1591-L1604 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.resolve_row_stack_kwargs title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-77-1><a id=__codelineno-77-1 name=__codelineno-77-1 href=#__codelineno-77-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>resolve_row_stack_kwargs</span><span class=p>(</span>
</span><span id=__span-77-2><a id=__codelineno-77-2 name=__codelineno-77-2 href=#__codelineno-77-2></a> <span class=o>*</span><span class=n>objs</span><span class=p>,</span>
</span><span id=__span-77-3><a id=__codelineno-77-3 name=__codelineno-77-3 href=#__codelineno-77-3></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-77-4><a id=__codelineno-77-4 name=__codelineno-77-4 href=#__codelineno-77-4></a><span class=p>)</span>
</span></code></pre></div> <p>Resolve keyword arguments for initializing <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> after stacking along rows.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.row_stack>row_stack <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1623-L1650 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.row_stack title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-78-1><a id=__codelineno-78-1 name=__codelineno-78-1 href=#__codelineno-78-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>row_stack</span><span class=p>(</span>
</span><span id=__span-78-2><a id=__codelineno-78-2 name=__codelineno-78-2 href=#__codelineno-78-2></a> <span class=o>*</span><span class=n>objs</span><span class=p>,</span>
</span><span id=__span-78-3><a id=__codelineno-78-3 name=__codelineno-78-3 href=#__codelineno-78-3></a> <span class=n>wrapper_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-78-4><a id=__codelineno-78-4 name=__codelineno-78-4 href=#__codelineno-78-4></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-78-5><a id=__codelineno-78-5 name=__codelineno-78-5 href=#__codelineno-78-5></a><span class=p>)</span>
</span></code></pre></div> <p>Stack multiple <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instances along rows.</p> <p>Uses <a href=../../../base/wrapping/index.html#vectorbtpro.base.wrapping.ArrayWrapper.row_stack title=vectorbtpro.base.wrapping.ArrayWrapper.row_stack>ArrayWrapper.row_stack()</a> to stack the wrappers.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.select_indices>select_indices <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L2384-L2524 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.select_indices title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-79-1><a id=__codelineno-79-1 name=__codelineno-79-1 href=#__codelineno-79-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>select_indices</span><span class=p>(</span>
</span><span id=__span-79-2><a id=__codelineno-79-2 name=__codelineno-79-2 href=#__codelineno-79-2></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-79-3><a id=__codelineno-79-3 name=__codelineno-79-3 href=#__codelineno-79-3></a> <span class=n>set_</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-79-4><a id=__codelineno-79-4 name=__codelineno-79-4 href=#__codelineno-79-4></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-79-5><a id=__codelineno-79-5 name=__codelineno-79-5 href=#__codelineno-79-5></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-79-6><a id=__codelineno-79-6 name=__codelineno-79-6 href=#__codelineno-79-6></a><span class=p>)</span>
</span></code></pre></div> <p>Get indices corresponding to selected splits and sets.</p> <p>Arguments <code>split</code> and <code>set_</code> can be either integers and labels. Also, multiple values are accepted; in such a case, the corresponding ranges are merged. If split/set labels are of an integer data type, treats the provided values as labels rather than indices, unless the split/set index is not of an integer data type or the values are wrapped with <a href=../../../utils/selection/index.html#vectorbtpro.utils.selection.PosSel title=vectorbtpro.utils.selection.PosSel>PosSel</a>.</p> <p>If <code>split_group_by</code> and/or <code>set_group_by</code> are provided, their groupers get created using <a href=../../../base/accessors/index.html#vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper title=vectorbtpro.base.accessors.BaseIDXAccessor.get_grouper>BaseIDXAccessor.get_grouper()</a> and arguments <code>split</code> and <code>set_</code> become relative to the groups.</p> <p>If <code>split</code>/<code>set_</code> is not provided, selects all indices.</p> <p>Returns four arrays: split group indices, set group indices, split indices, and set indices.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.select_range>select_range <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L2526-L2541 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.select_range title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-80-1><a id=__codelineno-80-1 name=__codelineno-80-1 href=#__codelineno-80-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>select_range</span><span class=p>(</span>
</span><span id=__span-80-2><a id=__codelineno-80-2 name=__codelineno-80-2 href=#__codelineno-80-2></a> <span class=n>merge_split_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-80-3><a id=__codelineno-80-3 name=__codelineno-80-3 href=#__codelineno-80-3></a> <span class=o>**</span><span class=n>select_indices_kwargs</span>
</span><span id=__span-80-4><a id=__codelineno-80-4 name=__codelineno-80-4 href=#__codelineno-80-4></a><span class=p>)</span>
</span></code></pre></div> <p>Select a range.</p> <p>Passes <code>**select_indices_kwargs</code> to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.select_indices title=vectorbtpro.generic.splitting.base.Splitter.select_indices>Splitter.select_indices()</a> to get the indices for selected splits and sets. If multiple ranges correspond to those indices, merges them using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.merge_split title=vectorbtpro.generic.splitting.base.Splitter.merge_split>Splitter.merge_split()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.set_coverage>set_coverage <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4566-L4569 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.set_coverage title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_set_coverage title=vectorbtpro.generic.splitting.base.Splitter.get_set_coverage>Splitter.get_set_coverage()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.set_labels>set_labels <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1763-L1766 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.set_labels title="Permanent link">&para;</a></h3> <p>Set labels.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.set_overlap_matrix>set_overlap_matrix <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4719-L4722 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.set_overlap_matrix title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_overlap_matrix title=vectorbtpro.generic.splitting.base.Splitter.get_overlap_matrix>Splitter.get_overlap_matrix()</a> with <code>by="set"</code>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.shuffle_splits>shuffle_splits <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L3840-L3861 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.shuffle_splits title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-81-1><a id=__codelineno-81-1 name=__codelineno-81-1 href=#__codelineno-81-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>shuffle_splits</span><span class=p>(</span>
</span><span id=__span-81-2><a id=__codelineno-81-2 name=__codelineno-81-2 href=#__codelineno-81-2></a> <span class=n>size</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-81-3><a id=__codelineno-81-3 name=__codelineno-81-3 href=#__codelineno-81-3></a> <span class=n>replace</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-81-4><a id=__codelineno-81-4 name=__codelineno-81-4 href=#__codelineno-81-4></a> <span class=n>p</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-81-5><a id=__codelineno-81-5 name=__codelineno-81-5 href=#__codelineno-81-5></a> <span class=n>seed</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-81-6><a id=__codelineno-81-6 name=__codelineno-81-6 href=#__codelineno-81-6></a> <span class=n>wrapper_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-81-7><a id=__codelineno-81-7 name=__codelineno-81-7 href=#__codelineno-81-7></a> <span class=o>**</span><span class=n>init_kwargs</span>
</span><span id=__span-81-8><a id=__codelineno-81-8 name=__codelineno-81-8 href=#__codelineno-81-8></a><span class=p>)</span>
</span></code></pre></div> <p>Shuffle splits.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.split_coverage>split_coverage <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4521-L4524 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.split_coverage title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_split_coverage title=vectorbtpro.generic.splitting.base.Splitter.get_split_coverage>Splitter.get_split_coverage()</a> with default arguments.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.split_labels>split_labels <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1758-L1761 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.split_labels title="Permanent link">&para;</a></h3> <p>Split labels.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.split_overlap_matrix>split_overlap_matrix <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4714-L4717 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.split_overlap_matrix title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_overlap_matrix title=vectorbtpro.generic.splitting.base.Splitter.get_overlap_matrix>Splitter.get_overlap_matrix()</a> with <code>by="split"</code>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.split_range>split_range <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L2132-L2306 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.split_range title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-82-1><a id=__codelineno-82-1 name=__codelineno-82-1 href=#__codelineno-82-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>split_range</span><span class=p>(</span>
</span><span id=__span-82-2><a id=__codelineno-82-2 name=__codelineno-82-2 href=#__codelineno-82-2></a> <span class=n>range_</span><span class=p>,</span>
</span><span id=__span-82-3><a id=__codelineno-82-3 name=__codelineno-82-3 href=#__codelineno-82-3></a> <span class=n>new_split</span><span class=p>,</span>
</span><span id=__span-82-4><a id=__codelineno-82-4 name=__codelineno-82-4 href=#__codelineno-82-4></a> <span class=n>backwards</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-82-5><a id=__codelineno-82-5 name=__codelineno-82-5 href=#__codelineno-82-5></a> <span class=n>allow_zero_len</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-82-6><a id=__codelineno-82-6 name=__codelineno-82-6 href=#__codelineno-82-6></a> <span class=n>range_format</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-82-7><a id=__codelineno-82-7 name=__codelineno-82-7 href=#__codelineno-82-7></a> <span class=n>wrap_with_template</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-82-8><a id=__codelineno-82-8 name=__codelineno-82-8 href=#__codelineno-82-8></a> <span class=n>wrap_with_fixrange</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-82-9><a id=__codelineno-82-9 name=__codelineno-82-9 href=#__codelineno-82-9></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-82-10><a id=__codelineno-82-10 name=__codelineno-82-10 href=#__codelineno-82-10></a> <span class=n>index</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-82-11><a id=__codelineno-82-11 name=__codelineno-82-11 href=#__codelineno-82-11></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-82-12><a id=__codelineno-82-12 name=__codelineno-82-12 href=#__codelineno-82-12></a><span class=p>)</span>
</span></code></pre></div> <p>Split a fixed range into a split of multiple fixed ranges.</p> <p>Range must be either a template, a callable, a tuple (start and stop), a slice, a sequence of indices, or a mask. This range will then be re-mapped into the index.</p> <p>Each sub-range in <code>new_split</code> can be either a fixed or relative range, that is, an instance of <a href=index.html#vectorbtpro.generic.splitting.base.RelRange title=vectorbtpro.generic.splitting.base.RelRange>RelRange</a> or a number that will be used as a length to create an <a href=index.html#vectorbtpro.generic.splitting.base.RelRange title=vectorbtpro.generic.splitting.base.RelRange>RelRange</a>. Each sub-range will then be re-mapped into the main range. Argument <code>new_split</code> can also be provided as an integer or a float indicating the length; in such a case the second part (or the first one depending on <code>backwards</code>) will stretch. If <code>new_split</code> is a string, the following options are supported:</p> <ul> <li>'by_gap': Split <code>range_</code> by gap using <a href=../nb/index.html#vectorbtpro.generic.splitting.nb.split_range_by_gap_nb title=vectorbtpro.generic.splitting.nb.split_range_by_gap_nb>split_range_by_gap_nb()</a>.</li> </ul> <p>New ranges are returned relative to the index and in the same order as passed.</p> <p>For <code>range_format</code>, see <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_ready_range title=vectorbtpro.generic.splitting.base.Splitter.get_ready_range>Splitter.get_ready_range()</a>. Enable <code>wrap_with_template</code> to wrap the resulting ranges with a template of the type <a href=../../../utils/template/index.html#vectorbtpro.utils.template.Rep title=vectorbtpro.utils.template.Rep>Rep</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.split_set>split_set <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L3916-L3977 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.split_set title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-83-1><a id=__codelineno-83-1 name=__codelineno-83-1 href=#__codelineno-83-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>split_set</span><span class=p>(</span>
</span><span id=__span-83-2><a id=__codelineno-83-2 name=__codelineno-83-2 href=#__codelineno-83-2></a> <span class=n>new_split</span><span class=p>,</span>
</span><span id=__span-83-3><a id=__codelineno-83-3 name=__codelineno-83-3 href=#__codelineno-83-3></a> <span class=n>column</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-83-4><a id=__codelineno-83-4 name=__codelineno-83-4 href=#__codelineno-83-4></a> <span class=n>new_set_labels</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-83-5><a id=__codelineno-83-5 name=__codelineno-83-5 href=#__codelineno-83-5></a> <span class=n>wrapper_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-83-6><a id=__codelineno-83-6 name=__codelineno-83-6 href=#__codelineno-83-6></a> <span class=n>init_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-83-7><a id=__codelineno-83-7 name=__codelineno-83-7 href=#__codelineno-83-7></a> <span class=o>**</span><span class=n>split_range_kwargs</span>
</span><span id=__span-83-8><a id=__codelineno-83-8 name=__codelineno-83-8 href=#__codelineno-83-8></a><span class=p>)</span>
</span></code></pre></div> <p>Split a set (column) into multiple sets (columns).</p> <p>Arguments <code>new_split</code> and <code>**split_range_kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.split_range title=vectorbtpro.generic.splitting.base.Splitter.split_range>Splitter.split_range()</a>.</p> <p>Column must be provided if there are two or more sets.</p> <p>Use <code>new_set_labels</code> to specify the labels of the new sets; it must have the same length as there are new ranges in the new split. To provide final labels, define <code>columns</code> in <code>wrapper_kwargs</code>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.splits>splits <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1753-L1756 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.splits title="Permanent link">&para;</a></h3> <p><a href=index.html#vectorbtpro.generic.splitting.base.Splitter.splits_arr title=vectorbtpro.generic.splitting.base.Splitter.splits_arr>Splitter.splits_arr</a> as a DataFrame.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.splits_arr>splits_arr <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1745-L1751 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.splits_arr title="Permanent link">&para;</a></h3> <p>Two-dimensional, object-dtype DataFrame with splits.</p> <p>First axis represents splits. Second axis represents sets. Elements represent ranges. Range must be either a slice, a sequence of indices, a mask, or a callable that returns such.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.stats_defaults>stats_defaults <span class=dobjtype>property</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L4731-L4741 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.stats_defaults title="Permanent link">&para;</a></h3> <p>Defaults for <a href=../../stats_builder/index.html#vectorbtpro.generic.stats_builder.StatsBuilderMixin.stats title=vectorbtpro.generic.splitting.base.Splitter.stats>StatsBuilderMixin.stats()</a>.</p> <p>Merges <a href=../../stats_builder/index.html#vectorbtpro.generic.stats_builder.StatsBuilderMixin.stats_defaults title=vectorbtpro.generic.stats_builder.StatsBuilderMixin.stats_defaults>StatsBuilderMixin.stats_defaults</a> and <code>stats</code> from <a href=../../../_settings/index.html#vectorbtpro._settings.splitter title=vectorbtpro._settings.splitter>splitter</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.subplots>subplots <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.subplots title="Permanent link">&para;</a></h3> <p>Subplots supported by <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a>.</p> <div class="language-python highlight"><pre><span></span><code><span id=__span-84-1><a id=__codelineno-84-1 name=__codelineno-84-1 href=#__codelineno-84-1></a><span class=n>HybridConfig</span><span class=p>(</span>
</span><span id=__span-84-2><a id=__codelineno-84-2 name=__codelineno-84-2 href=#__codelineno-84-2></a> <span class=n>plot</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-84-3><a id=__codelineno-84-3 name=__codelineno-84-3 href=#__codelineno-84-3></a> <span class=n>title</span><span class=o>=</span><span class=s1>&#39;Splits&#39;</span><span class=p>,</span>
</span><span id=__span-84-4><a id=__codelineno-84-4 name=__codelineno-84-4 href=#__codelineno-84-4></a> <span class=n>yaxis_kwargs</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-84-5><a id=__codelineno-84-5 name=__codelineno-84-5 href=#__codelineno-84-5></a> <span class=n>title</span><span class=o>=</span><span class=s1>&#39;Split&#39;</span>
</span><span id=__span-84-6><a id=__codelineno-84-6 name=__codelineno-84-6 href=#__codelineno-84-6></a> <span class=p>),</span>
</span><span id=__span-84-7><a id=__codelineno-84-7 name=__codelineno-84-7 href=#__codelineno-84-7></a> <span class=n>plot_func</span><span class=o>=</span><span class=s1>&#39;plot&#39;</span><span class=p>,</span>
</span><span id=__span-84-8><a id=__codelineno-84-8 name=__codelineno-84-8 href=#__codelineno-84-8></a> <span class=n>tags</span><span class=o>=</span><span class=s1>&#39;splitter&#39;</span>
</span><span id=__span-84-9><a id=__codelineno-84-9 name=__codelineno-84-9 href=#__codelineno-84-9></a> <span class=p>),</span>
</span><span id=__span-84-10><a id=__codelineno-84-10 name=__codelineno-84-10 href=#__codelineno-84-10></a> <span class=n>plot_coverage</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-84-11><a id=__codelineno-84-11 name=__codelineno-84-11 href=#__codelineno-84-11></a> <span class=n>title</span><span class=o>=</span><span class=s1>&#39;Coverage&#39;</span><span class=p>,</span>
</span><span id=__span-84-12><a id=__codelineno-84-12 name=__codelineno-84-12 href=#__codelineno-84-12></a> <span class=n>yaxis_kwargs</span><span class=o>=</span><span class=nb>dict</span><span class=p>(</span>
</span><span id=__span-84-13><a id=__codelineno-84-13 name=__codelineno-84-13 href=#__codelineno-84-13></a> <span class=n>title</span><span class=o>=</span><span class=s1>&#39;Count&#39;</span>
</span><span id=__span-84-14><a id=__codelineno-84-14 name=__codelineno-84-14 href=#__codelineno-84-14></a> <span class=p>),</span>
</span><span id=__span-84-15><a id=__codelineno-84-15 name=__codelineno-84-15 href=#__codelineno-84-15></a> <span class=n>plot_func</span><span class=o>=</span><span class=s1>&#39;plot_coverage&#39;</span><span class=p>,</span>
</span><span id=__span-84-16><a id=__codelineno-84-16 name=__codelineno-84-16 href=#__codelineno-84-16></a> <span class=n>tags</span><span class=o>=</span><span class=s1>&#39;splitter&#39;</span>
</span><span id=__span-84-17><a id=__codelineno-84-17 name=__codelineno-84-17 href=#__codelineno-84-17></a> <span class=p>)</span>
</span><span id=__span-84-18><a id=__codelineno-84-18 name=__codelineno-84-18 href=#__codelineno-84-18></a><span class=p>)</span>
</span></code></pre></div> <p>Returns <code>Splitter._subplots</code>, which gets (hybrid-) copied upon creation of each instance. Thus, changing this config won't affect the class.</p> <p>To change subplots, you can either change the config in-place, override this property, or overwrite the instance variable <code>Splitter._subplots</code>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.take>take <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L2664-L3060 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.take title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-85-1><a id=__codelineno-85-1 name=__codelineno-85-1 href=#__codelineno-85-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>take</span><span class=p>(</span>
</span><span id=__span-85-2><a id=__codelineno-85-2 name=__codelineno-85-2 href=#__codelineno-85-2></a> <span class=n>obj</span><span class=p>,</span>
</span><span id=__span-85-3><a id=__codelineno-85-3 name=__codelineno-85-3 href=#__codelineno-85-3></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-85-4><a id=__codelineno-85-4 name=__codelineno-85-4 href=#__codelineno-85-4></a> <span class=n>set_</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-85-5><a id=__codelineno-85-5 name=__codelineno-85-5 href=#__codelineno-85-5></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-85-6><a id=__codelineno-85-6 name=__codelineno-85-6 href=#__codelineno-85-6></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-85-7><a id=__codelineno-85-7 name=__codelineno-85-7 href=#__codelineno-85-7></a> <span class=n>squeeze_one_split</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-85-8><a id=__codelineno-85-8 name=__codelineno-85-8 href=#__codelineno-85-8></a> <span class=n>squeeze_one_set</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-85-9><a id=__codelineno-85-9 name=__codelineno-85-9 href=#__codelineno-85-9></a> <span class=n>into</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-85-10><a id=__codelineno-85-10 name=__codelineno-85-10 href=#__codelineno-85-10></a> <span class=n>remap_to_obj</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
</span><span id=__span-85-11><a id=__codelineno-85-11 name=__codelineno-85-11 href=#__codelineno-85-11></a> <span class=n>obj_index</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-85-12><a id=__codelineno-85-12 name=__codelineno-85-12 href=#__codelineno-85-12></a> <span class=n>obj_freq</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-85-13><a id=__codelineno-85-13 name=__codelineno-85-13 href=#__codelineno-85-13></a> <span class=n>range_format</span><span class=o>=</span><span class=s1>&#39;slice_or_any&#39;</span><span class=p>,</span>
</span><span id=__span-85-14><a id=__codelineno-85-14 name=__codelineno-85-14 href=#__codelineno-85-14></a> <span class=n>point_wise</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-85-15><a id=__codelineno-85-15 name=__codelineno-85-15 href=#__codelineno-85-15></a> <span class=n>attach_bounds</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-85-16><a id=__codelineno-85-16 name=__codelineno-85-16 href=#__codelineno-85-16></a> <span class=n>right_inclusive</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-85-17><a id=__codelineno-85-17 name=__codelineno-85-17 href=#__codelineno-85-17></a> <span class=n>template_context</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-85-18><a id=__codelineno-85-18 name=__codelineno-85-18 href=#__codelineno-85-18></a> <span class=n>silence_warnings</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
</span><span id=__span-85-19><a id=__codelineno-85-19 name=__codelineno-85-19 href=#__codelineno-85-19></a> <span class=n>index_combine_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-85-20><a id=__codelineno-85-20 name=__codelineno-85-20 href=#__codelineno-85-20></a> <span class=n>stack_axis</span><span class=o>=</span><span class=mi>1</span><span class=p>,</span>
</span><span id=__span-85-21><a id=__codelineno-85-21 name=__codelineno-85-21 href=#__codelineno-85-21></a> <span class=n>stack_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-85-22><a id=__codelineno-85-22 name=__codelineno-85-22 href=#__codelineno-85-22></a> <span class=n>freq</span><span class=o>=</span><span class=kc>None</span>
</span><span id=__span-85-23><a id=__codelineno-85-23 name=__codelineno-85-23 href=#__codelineno-85-23></a><span class=p>)</span>
</span></code></pre></div> <p>Take all ranges from an array-like object and optionally column-stack them.</p> <p>Uses <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.select_indices title=vectorbtpro.generic.splitting.base.Splitter.select_indices>Splitter.select_indices()</a> to get the indices for selected splits and sets. Arguments <code>split_group_by</code> and <code>set_group_by</code> can be used to group splits and sets respectively. Ranges belonging to the same split and set group will be merged.</p> <p>For each index pair, resolves the source range using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.select_range title=vectorbtpro.generic.splitting.base.Splitter.select_range>Splitter.select_range()</a> and <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_ready_range title=vectorbtpro.generic.splitting.base.Splitter.get_ready_range>Splitter.get_ready_range()</a>. Then, remaps this range into the object index using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_ready_obj_range title=vectorbtpro.generic.splitting.base.Splitter.get_ready_obj_range>Splitter.get_ready_obj_range()</a> and takes the slice from the object using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.take_range title=vectorbtpro.generic.splitting.base.Splitter.take_range>Splitter.take_range()</a>. If the object is a custom template, substitutes its instead of calling <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.take_range title=vectorbtpro.generic.splitting.base.Splitter.take_range>Splitter.take_range()</a>. Finally, uses <a href=../../../base/merging/index.html#vectorbtpro.base.merging.column_stack_merge title=vectorbtpro.base.merging.column_stack_merge>column_stack_merge()</a> (<code>stack_axis=1</code>) or <a href=../../../base/merging/index.html#vectorbtpro.base.merging.row_stack_merge title=vectorbtpro.base.merging.row_stack_merge>row_stack_merge()</a> (<code>stack_axis=0</code>) with <code>stack_kwargs</code> to merge the taken slices.</p> <p>If <code>attach_bounds</code> is enabled, measures the bounds of each range and makes it an additional level in the final index hierarchy. The argument supports the following options:</p> <ul> <li>True, 'index', 'source', or 'source_index': Attach source (index) bounds</li> <li>'target' or 'target_index': Attach target (index) bounds</li> <li>False: Do not attach</li> </ul> <p>Argument <code>into</code> supports the following options:</p> <ul> <li>None: Series of range slices</li> <li>'stacked': Stack all slices into a single object</li> <li>'stacked_by_split': Stack set slices in each split and return a Series of objects</li> <li>'stacked_by_set': Stack split slices in each set and return a Series of objects</li> <li>'split_major_meta': Generator with ranges processed lazily in split-major order. Returns meta with indices and labels, and the generator.</li> <li>'set_major_meta': Generator with ranges processed lazily in set-major order. Returns meta with indices and labels, and the generator.</li> </ul> <p>Prepend any stacked option with "from_start_" (also "reset_") or "from_end_" to reset the index from start and from end respectively.</p> <p><strong>Usage</strong></p> <ul> <li>Roll a window and stack it along columns by keeping the index:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-86-1><a id=__codelineno-86-1 name=__codelineno-86-1 href=#__codelineno-86-1></a><span class=gp>&gt;&gt;&gt; </span><span class=kn>from</span> <span class=nn>vectorbtpro</span> <span class=kn>import</span> <span class=o>*</span>
</span><span id=__span-86-2><a id=__codelineno-86-2 name=__codelineno-86-2 href=#__codelineno-86-2></a>
</span><span id=__span-86-3><a id=__codelineno-86-3 name=__codelineno-86-3 href=#__codelineno-86-3></a><span class=gp>&gt;&gt;&gt; </span><span class=n>data</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>YFData</span><span class=o>.</span><span class=n>pull</span><span class=p>(</span>
</span><span id=__span-86-4><a id=__codelineno-86-4 name=__codelineno-86-4 href=#__codelineno-86-4></a><span class=gp>... </span> <span class=s2>&quot;BTC-USD&quot;</span><span class=p>,</span>
</span><span id=__span-86-5><a id=__codelineno-86-5 name=__codelineno-86-5 href=#__codelineno-86-5></a><span class=gp>... </span> <span class=n>start</span><span class=o>=</span><span class=s2>&quot;2020-01-01 UTC&quot;</span><span class=p>,</span>
</span><span id=__span-86-6><a id=__codelineno-86-6 name=__codelineno-86-6 href=#__codelineno-86-6></a><span class=gp>... </span> <span class=n>end</span><span class=o>=</span><span class=s2>&quot;2021-01-01 UTC&quot;</span>
</span><span id=__span-86-7><a id=__codelineno-86-7 name=__codelineno-86-7 href=#__codelineno-86-7></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-86-8><a id=__codelineno-86-8 name=__codelineno-86-8 href=#__codelineno-86-8></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span> <span class=o>=</span> <span class=n>vbt</span><span class=o>.</span><span class=n>Splitter</span><span class=o>.</span><span class=n>from_n_rolling</span><span class=p>(</span>
</span><span id=__span-86-9><a id=__codelineno-86-9 name=__codelineno-86-9 href=#__codelineno-86-9></a><span class=gp>... </span> <span class=n>data</span><span class=o>.</span><span class=n>wrapper</span><span class=o>.</span><span class=n>index</span><span class=p>,</span>
</span><span id=__span-86-10><a id=__codelineno-86-10 name=__codelineno-86-10 href=#__codelineno-86-10></a><span class=gp>... </span> <span class=mi>3</span><span class=p>,</span>
</span><span id=__span-86-11><a id=__codelineno-86-11 name=__codelineno-86-11 href=#__codelineno-86-11></a><span class=gp>... </span> <span class=n>length</span><span class=o>=</span><span class=mi>5</span>
</span><span id=__span-86-12><a id=__codelineno-86-12 name=__codelineno-86-12 href=#__codelineno-86-12></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-86-13><a id=__codelineno-86-13 name=__codelineno-86-13 href=#__codelineno-86-13></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>take</span><span class=p>(</span><span class=n>data</span><span class=o>.</span><span class=n>close</span><span class=p>,</span> <span class=n>into</span><span class=o>=</span><span class=s2>&quot;stacked&quot;</span><span class=p>)</span>
</span><span id=__span-86-14><a id=__codelineno-86-14 name=__codelineno-86-14 href=#__codelineno-86-14></a><span class=go>split 0 1 2</span>
</span><span id=__span-86-15><a id=__codelineno-86-15 name=__codelineno-86-15 href=#__codelineno-86-15></a><span class=go>Date</span>
</span><span id=__span-86-16><a id=__codelineno-86-16 name=__codelineno-86-16 href=#__codelineno-86-16></a><span class=go>2020-01-01 00:00:00+00:00 7200.174316 NaN NaN</span>
</span><span id=__span-86-17><a id=__codelineno-86-17 name=__codelineno-86-17 href=#__codelineno-86-17></a><span class=go>2020-01-02 00:00:00+00:00 6985.470215 NaN NaN</span>
</span><span id=__span-86-18><a id=__codelineno-86-18 name=__codelineno-86-18 href=#__codelineno-86-18></a><span class=go>2020-01-03 00:00:00+00:00 7344.884277 NaN NaN</span>
</span><span id=__span-86-19><a id=__codelineno-86-19 name=__codelineno-86-19 href=#__codelineno-86-19></a><span class=go>2020-01-04 00:00:00+00:00 7410.656738 NaN NaN</span>
</span><span id=__span-86-20><a id=__codelineno-86-20 name=__codelineno-86-20 href=#__codelineno-86-20></a><span class=go>2020-01-05 00:00:00+00:00 7411.317383 NaN NaN</span>
</span><span id=__span-86-21><a id=__codelineno-86-21 name=__codelineno-86-21 href=#__codelineno-86-21></a><span class=go>2020-06-29 00:00:00+00:00 NaN 9190.854492 NaN</span>
</span><span id=__span-86-22><a id=__codelineno-86-22 name=__codelineno-86-22 href=#__codelineno-86-22></a><span class=go>2020-06-30 00:00:00+00:00 NaN 9137.993164 NaN</span>
</span><span id=__span-86-23><a id=__codelineno-86-23 name=__codelineno-86-23 href=#__codelineno-86-23></a><span class=go>2020-07-01 00:00:00+00:00 NaN 9228.325195 NaN</span>
</span><span id=__span-86-24><a id=__codelineno-86-24 name=__codelineno-86-24 href=#__codelineno-86-24></a><span class=go>2020-07-02 00:00:00+00:00 NaN 9123.410156 NaN</span>
</span><span id=__span-86-25><a id=__codelineno-86-25 name=__codelineno-86-25 href=#__codelineno-86-25></a><span class=go>2020-07-03 00:00:00+00:00 NaN 9087.303711 NaN</span>
</span><span id=__span-86-26><a id=__codelineno-86-26 name=__codelineno-86-26 href=#__codelineno-86-26></a><span class=go>2020-12-27 00:00:00+00:00 NaN NaN 26272.294922</span>
</span><span id=__span-86-27><a id=__codelineno-86-27 name=__codelineno-86-27 href=#__codelineno-86-27></a><span class=go>2020-12-28 00:00:00+00:00 NaN NaN 27084.808594</span>
</span><span id=__span-86-28><a id=__codelineno-86-28 name=__codelineno-86-28 href=#__codelineno-86-28></a><span class=go>2020-12-29 00:00:00+00:00 NaN NaN 27362.437500</span>
</span><span id=__span-86-29><a id=__codelineno-86-29 name=__codelineno-86-29 href=#__codelineno-86-29></a><span class=go>2020-12-30 00:00:00+00:00 NaN NaN 28840.953125</span>
</span><span id=__span-86-30><a id=__codelineno-86-30 name=__codelineno-86-30 href=#__codelineno-86-30></a><span class=go>2020-12-31 00:00:00+00:00 NaN NaN 29001.720703</span>
</span></code></pre></div> <ul> <li>Disgard the index and attach index bounds to the column hierarchy:</li> </ul> <div class="language-pycon highlight"><pre><span></span><code><span id=__span-87-1><a id=__codelineno-87-1 name=__codelineno-87-1 href=#__codelineno-87-1></a><span class=gp>&gt;&gt;&gt; </span><span class=n>splitter</span><span class=o>.</span><span class=n>take</span><span class=p>(</span>
</span><span id=__span-87-2><a id=__codelineno-87-2 name=__codelineno-87-2 href=#__codelineno-87-2></a><span class=gp>... </span> <span class=n>data</span><span class=o>.</span><span class=n>close</span><span class=p>,</span>
</span><span id=__span-87-3><a id=__codelineno-87-3 name=__codelineno-87-3 href=#__codelineno-87-3></a><span class=gp>... </span> <span class=n>into</span><span class=o>=</span><span class=s2>&quot;reset_stacked&quot;</span><span class=p>,</span>
</span><span id=__span-87-4><a id=__codelineno-87-4 name=__codelineno-87-4 href=#__codelineno-87-4></a><span class=gp>... </span> <span class=n>attach_bounds</span><span class=o>=</span><span class=s2>&quot;index&quot;</span>
</span><span id=__span-87-5><a id=__codelineno-87-5 name=__codelineno-87-5 href=#__codelineno-87-5></a><span class=gp>... </span><span class=p>)</span>
</span><span id=__span-87-6><a id=__codelineno-87-6 name=__codelineno-87-6 href=#__codelineno-87-6></a><span class=go>split 0 1 \</span>
</span><span id=__span-87-7><a id=__codelineno-87-7 name=__codelineno-87-7 href=#__codelineno-87-7></a><span class=go>start 2020-01-01 00:00:00+00:00 2020-06-29 00:00:00+00:00</span>
</span><span id=__span-87-8><a id=__codelineno-87-8 name=__codelineno-87-8 href=#__codelineno-87-8></a><span class=go>end 2020-01-06 00:00:00+00:00 2020-07-04 00:00:00+00:00</span>
</span><span id=__span-87-9><a id=__codelineno-87-9 name=__codelineno-87-9 href=#__codelineno-87-9></a><span class=go>0 7200.174316 9190.854492</span>
</span><span id=__span-87-10><a id=__codelineno-87-10 name=__codelineno-87-10 href=#__codelineno-87-10></a><span class=go>1 6985.470215 9137.993164</span>
</span><span id=__span-87-11><a id=__codelineno-87-11 name=__codelineno-87-11 href=#__codelineno-87-11></a><span class=go>2 7344.884277 9228.325195</span>
</span><span id=__span-87-12><a id=__codelineno-87-12 name=__codelineno-87-12 href=#__codelineno-87-12></a><span class=go>3 7410.656738 9123.410156</span>
</span><span id=__span-87-13><a id=__codelineno-87-13 name=__codelineno-87-13 href=#__codelineno-87-13></a><span class=go>4 7411.317383 9087.303711</span>
</span><span id=__span-87-14><a id=__codelineno-87-14 name=__codelineno-87-14 href=#__codelineno-87-14></a>
</span><span id=__span-87-15><a id=__codelineno-87-15 name=__codelineno-87-15 href=#__codelineno-87-15></a><span class=go>split 2</span>
</span><span id=__span-87-16><a id=__codelineno-87-16 name=__codelineno-87-16 href=#__codelineno-87-16></a><span class=go>start 2020-12-27 00:00:00+00:00</span>
</span><span id=__span-87-17><a id=__codelineno-87-17 name=__codelineno-87-17 href=#__codelineno-87-17></a><span class=go>end 2021-01-01 00:00:00+00:00</span>
</span><span id=__span-87-18><a id=__codelineno-87-18 name=__codelineno-87-18 href=#__codelineno-87-18></a><span class=go>0 26272.294922</span>
</span><span id=__span-87-19><a id=__codelineno-87-19 name=__codelineno-87-19 href=#__codelineno-87-19></a><span class=go>1 27084.808594</span>
</span><span id=__span-87-20><a id=__codelineno-87-20 name=__codelineno-87-20 href=#__codelineno-87-20></a><span class=go>2 27362.437500</span>
</span><span id=__span-87-21><a id=__codelineno-87-21 name=__codelineno-87-21 href=#__codelineno-87-21></a><span class=go>3 28840.953125</span>
</span><span id=__span-87-22><a id=__codelineno-87-22 name=__codelineno-87-22 href=#__codelineno-87-22></a><span class=go>4 29001.720703</span>
</span></code></pre></div> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.take_range>take_range <span class=dobjtype>class method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L2651-L2662 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.take_range title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-88-1><a id=__codelineno-88-1 name=__codelineno-88-1 href=#__codelineno-88-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>take_range</span><span class=p>(</span>
</span><span id=__span-88-2><a id=__codelineno-88-2 name=__codelineno-88-2 href=#__codelineno-88-2></a> <span class=n>obj</span><span class=p>,</span>
</span><span id=__span-88-3><a id=__codelineno-88-3 name=__codelineno-88-3 href=#__codelineno-88-3></a> <span class=n>ready_range</span><span class=p>,</span>
</span><span id=__span-88-4><a id=__codelineno-88-4 name=__codelineno-88-4 href=#__codelineno-88-4></a> <span class=n>point_wise</span><span class=o>=</span><span class=kc>False</span>
</span><span id=__span-88-5><a id=__codelineno-88-5 name=__codelineno-88-5 href=#__codelineno-88-5></a><span class=p>)</span>
</span></code></pre></div> <p>Take a ready range from an array-like object.</p> <p>Set <code>point_wise</code> to True to select one range point at a time and return a tuple.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.to_fixed>to_fixed <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1824-L1840 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.to_fixed title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-89-1><a id=__codelineno-89-1 name=__codelineno-89-1 href=#__codelineno-89-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>to_fixed</span><span class=p>(</span>
</span><span id=__span-89-2><a id=__codelineno-89-2 name=__codelineno-89-2 href=#__codelineno-89-2></a> <span class=n>split_range_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-89-3><a id=__codelineno-89-3 name=__codelineno-89-3 href=#__codelineno-89-3></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-89-4><a id=__codelineno-89-4 name=__codelineno-89-4 href=#__codelineno-89-4></a><span class=p>)</span>
</span></code></pre></div> <p>Convert relative ranges into fixed ones and return a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance.</p> <p>Keyword arguments <code>split_range_kwargs</code> are passed to <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.split_range title=vectorbtpro.generic.splitting.base.Splitter.split_range>Splitter.split_range()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Splitter.to_grouped>to_grouped <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L1842-L1893 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Splitter.to_grouped title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-90-1><a id=__codelineno-90-1 name=__codelineno-90-1 href=#__codelineno-90-1></a><span class=n>Splitter</span><span class=o>.</span><span class=n>to_grouped</span><span class=p>(</span>
</span><span id=__span-90-2><a id=__codelineno-90-2 name=__codelineno-90-2 href=#__codelineno-90-2></a> <span class=n>split</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-90-3><a id=__codelineno-90-3 name=__codelineno-90-3 href=#__codelineno-90-3></a> <span class=n>set_</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-90-4><a id=__codelineno-90-4 name=__codelineno-90-4 href=#__codelineno-90-4></a> <span class=n>split_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-90-5><a id=__codelineno-90-5 name=__codelineno-90-5 href=#__codelineno-90-5></a> <span class=n>set_group_by</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-90-6><a id=__codelineno-90-6 name=__codelineno-90-6 href=#__codelineno-90-6></a> <span class=n>merge_split_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
</span><span id=__span-90-7><a id=__codelineno-90-7 name=__codelineno-90-7 href=#__codelineno-90-7></a> <span class=o>**</span><span class=n>kwargs</span>
</span><span id=__span-90-8><a id=__codelineno-90-8 name=__codelineno-90-8 href=#__codelineno-90-8></a><span class=p>)</span>
</span></code></pre></div> <p>Merge all ranges within the same group and return a new <a href=index.html#vectorbtpro.generic.splitting.base.Splitter title=vectorbtpro.generic.splitting.base.Splitter>Splitter</a> instance.</p> <hr> <h2 id=vectorbtpro.generic.splitting.base.Takeable>Takeable <span class=dobjtype>class</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L304-L330 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Takeable title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-91-1><a id=__codelineno-91-1 name=__codelineno-91-1 href=#__codelineno-91-1></a><span class=n>Takeable</span><span class=p>(</span>
</span><span id=__span-91-2><a id=__codelineno-91-2 name=__codelineno-91-2 href=#__codelineno-91-2></a> <span class=n>obj</span><span class=o>=</span><span class=n>vectorbtpro</span><span class=o>.</span><span class=n>generic</span><span class=o>.</span><span class=n>splitting</span><span class=o>.</span><span class=n>base</span><span class=o>.</span><span class=n>_DEF</span><span class=p>,</span>
</span><span id=__span-91-3><a id=__codelineno-91-3 name=__codelineno-91-3 href=#__codelineno-91-3></a> <span class=n>remap_to_obj</span><span class=o>=</span><span class=n>vectorbtpro</span><span class=o>.</span><span class=n>generic</span><span class=o>.</span><span class=n>splitting</span><span class=o>.</span><span class=n>base</span><span class=o>.</span><span class=n>_DEF</span><span class=p>,</span>
</span><span id=__span-91-4><a id=__codelineno-91-4 name=__codelineno-91-4 href=#__codelineno-91-4></a> <span class=n>index</span><span class=o>=</span><span class=n>vectorbtpro</span><span class=o>.</span><span class=n>generic</span><span class=o>.</span><span class=n>splitting</span><span class=o>.</span><span class=n>base</span><span class=o>.</span><span class=n>_DEF</span><span class=p>,</span>
</span><span id=__span-91-5><a id=__codelineno-91-5 name=__codelineno-91-5 href=#__codelineno-91-5></a> <span class=n>freq</span><span class=o>=</span><span class=n>vectorbtpro</span><span class=o>.</span><span class=n>generic</span><span class=o>.</span><span class=n>splitting</span><span class=o>.</span><span class=n>base</span><span class=o>.</span><span class=n>_DEF</span><span class=p>,</span>
</span><span id=__span-91-6><a id=__codelineno-91-6 name=__codelineno-91-6 href=#__codelineno-91-6></a> <span class=n>point_wise</span><span class=o>=</span><span class=n>vectorbtpro</span><span class=o>.</span><span class=n>generic</span><span class=o>.</span><span class=n>splitting</span><span class=o>.</span><span class=n>base</span><span class=o>.</span><span class=n>_DEF</span>
</span><span id=__span-91-7><a id=__codelineno-91-7 name=__codelineno-91-7 href=#__codelineno-91-7></a><span class=p>)</span>
</span></code></pre></div> <p>Class that represents an object from which a range can be taken.</p> <p>Method generated by attrs for class Takeable.</p> <p><strong>Superclasses</strong></p> <ul> <li><a href=../../../utils/annotations/index.html#vectorbtpro.utils.annotations.Annotatable title=vectorbtpro.utils.annotations.Annotatable>Annotatable</a></li> </ul> <hr> <h3 id=vectorbtpro.generic.splitting.base.Takeable.check_obj>check_obj <span class=dobjtype>method</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py#L327-L330 target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Takeable.check_obj title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-92-1><a id=__codelineno-92-1 name=__codelineno-92-1 href=#__codelineno-92-1></a><span class=n>Takeable</span><span class=o>.</span><span class=n>check_obj</span><span class=p>()</span>
</span></code></pre></div> <p>Check whether value is missing.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Takeable.freq>freq <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Takeable.freq title="Permanent link">&para;</a></h3> <p>Frequency of <a href=index.html#vectorbtpro.generic.splitting.base.Takeable.index title=vectorbtpro.generic.splitting.base.Takeable.index>Takeable.index</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Takeable.index>index <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Takeable.index title="Permanent link">&para;</a></h3> <p>Index of the object.</p> <p>If not present, will be accessed using <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.get_obj_index title=vectorbtpro.generic.splitting.base.Splitter.get_obj_index>Splitter.get_obj_index()</a>.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Takeable.obj>obj <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Takeable.obj title="Permanent link">&para;</a></h3> <p>Takeable object.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Takeable.point_wise>point_wise <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Takeable.point_wise title="Permanent link">&para;</a></h3> <p>Whether to select one range point at a time and return a tuple.</p> <hr> <h3 id=vectorbtpro.generic.splitting.base.Takeable.remap_to_obj>remap_to_obj <span class=dobjtype>class variable</span><a class=githublink href=https://github.com/drew2323/vbtpro/blob/main/vectorbtpro/generic/splitting/base.py target=_blank title="Jump to source"><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg></span></a><a class=headerlink href=#vectorbtpro.generic.splitting.base.Takeable.remap_to_obj title="Permanent link">&para;</a></h3> <p>Whether to remap <a href=index.html#vectorbtpro.generic.splitting.base.Splitter.index title=vectorbtpro.generic.splitting.base.Splitter.index>Splitter.index</a> to the index of <a href=index.html#vectorbtpro.generic.splitting.base.Takeable.obj title=vectorbtpro.generic.splitting.base.Takeable.obj>Takeable.obj</a>.</p> <p>Otherwise, will assume that the object has the same index.</p> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../index.html class="md-footer__link md-footer__link--prev" aria-label="Previous: splitting"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> splitting </div> </div> </a> <a href=../decorators/index.html class="md-footer__link md-footer__link--next" aria-label="Next: decorators"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> decorators </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright &copy; 2021-2024 Oleg Polakow. All rights reserved. </div> </div> <div class=md-social> <a href=https://www.linkedin.com/in/polakowo target=_blank rel=noopener title=www.linkedin.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"/></svg> </a> <a href=https://github.com/polakowo target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 496 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <div class=md-progress data-md-component=progress role=progressbar></div> <div class=md-consent data-md-component=consent id=__consent hidden> <div class=md-consent__overlay></div> <aside class=md-consent__inner> <form class="md-consent__form md-grid md-typeset" name=consent> <h4>Cookie consent</h4> <p>We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.</p> <input class=md-toggle type=checkbox id=__settings> <div class=md-consent__settings> <ul class=task-list> <li class=task-list-item> <label class=task-list-control> <input type=checkbox name=analytics checked> <span class=task-list-indicator></span> Google Analytics </label> </li> <li class=task-list-item> <label class=task-list-control> <input type=checkbox name=github checked> <span class=task-list-indicator></span> GitHub </label> </li> </ul> </div> <div class=md-consent__controls> <button class="md-button md-button--primary">Accept</button> <label class=md-button for=__settings>Manage settings</label> </div> </form> </aside> </div> <script>var consent=__md_get("__consent");if(consent)for(var input of document.forms.consent.elements)input.name&&(input.checked=consent[input.name]||!1);else"file:"!==location.protocol&&setTimeout(function(){document.querySelector("[data-md-component=consent]").hidden=!1},250);var action,form=document.forms.consent;for(action of["submit","reset"])form.addEventListener(action,function(e){if(e.preventDefault(),"reset"===e.type)for(var n of document.forms.consent.elements)n.name&&(n.checked=!1);__md_set("__consent",Object.fromEntries(Array.from(new FormData(form).keys()).map(function(e){return[e,!0]}))),location.hash="",location.reload()})</script> <script id=__config type=application/json>{"base": "../../../..", "features": ["navigation.tracking", "navigation.tabs", "navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.prune", "navigation.path", "navigation.sections", "navigation.footer", "search.suggest", "search.share", "content.code.annotate", "content.code.copy", "content.code.select", "content.tooltips", "toc.follow", "toc.integrate", "announce.dismiss"], "search": "../../../../assets/javascripts/workers/search.1e90e0fb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src=../../../../assets/javascripts/bundle.8e8db93a.min.js></script> <script src=../../../../assets/javascripts/extra.js></script> </body>
<!-- Mirrored from vectorbt.pro/pvt_321460c7/api/generic/splitting/base/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 05 Mar 2024 10:59:07 GMT -->
</html>
Reference in New Issue View Git Blame Copy Permalink