-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Jun 28, 2023
1 parent
d98e526
commit 01e1298
Showing
4 changed files
with
4 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · DateSelectors.jl</title><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script><link href="assets/invenia.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="index.html"><img class="docs-light-only" src="assets/logo.png" alt="DateSelectors.jl logo"/><img class="docs-dark-only" src="assets/logo-dark.png" alt="DateSelectors.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">DateSelectors.jl</a></span></div><form class="docs-search" action="search.html"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="index.html">Home</a></li><li class="is-active"><a class="tocitem" href="api.html">API</a><ul class="internal"><li class="toplevel"><a class="tocitem" href="#Selectors"><span>Selectors</span></a></li><li class="toplevel"><a class="tocitem" href="#Index"><span>Index</span></a></li></ul></li><li><a class="tocitem" href="examples.html">Examples</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="api.html">API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="api.html">API</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/invenia/DateSelectors.jl/blob/main/docs/src/api.md#L" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="Base.Iterators.partition" href="#Base.Iterators.partition"><code>Base.Iterators.partition</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">partition(dates::AbstractInterval{Date}, s::DateSelector) | ||
| partition(dates::StepRange{Date, Day}, selector::DateSelector) | ||
| partition(dates::AbstractVector{Date}, s::DateSelector)</code></pre><p>Partition the set of <code>dates</code> into disjoint <code>validation</code> and <code>holdout</code> sets according to the <code>selector</code> and return a <code>NamedTuple({:validation, :holdout})</code> of iterators.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/DateSelectors.jl/blob/f229f7518cce27a17b3d8780090323790173c670/src/common.jl#LL10-L17">source</a></section></article><h1 id="Selectors"><a class="docs-heading-anchor" href="#Selectors">Selectors</a><a id="Selectors-1"></a><a class="docs-heading-anchor-permalink" href="#Selectors" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="DateSelectors.DateSelector" href="#DateSelectors.DateSelector"><code>DateSelectors.DateSelector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">DateSelector</code></pre><p>Determines how to <a href="api.html#Base.Iterators.partition"><code>partition</code></a> a date set into disjoint validation and holdout sets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/DateSelectors.jl/blob/f229f7518cce27a17b3d8780090323790173c670/src/common.jl#LL2-L6">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="DateSelectors.NoneSelector" href="#DateSelectors.NoneSelector"><code>DateSelectors.NoneSelector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">NoneSelector()</code></pre><p>Assign all dates to the validation set, select no holdout dates.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/DateSelectors.jl/blob/f229f7518cce27a17b3d8780090323790173c670/src/NoneSelector.jl#LL1-L5">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="DateSelectors.PeriodicSelector" href="#DateSelectors.PeriodicSelector"><code>DateSelectors.PeriodicSelector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">PeriodicSelector(period::DatePeriod, stride::DatePeriod=Day(1), offset::DatePeriod=Day(0))</code></pre><p>Assign holdout dates by taking a set of size <code>stride</code> once per <code>period</code>. The offset is relative to <em>Monday 1st Jan 1900</em>, and controls when the selected section starts.</p><p>For example, <code>PeriodicSelector(Week(1), Day(2), Day(1))</code> will select 2 days per week. With this selected periods offset by 1 day from 1st Jan 1900. I.e. if applied to the first two weeks of the year 1900, it would select 2nd, 3rd, 9th and 8th of Jan 1900.</p><p>Note: this cannot be actually used to select days earlier than <code>offset</code> after 1st Jan 1900.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/DateSelectors.jl/blob/f229f7518cce27a17b3d8780090323790173c670/src/PeriodicSelector.jl#LL2-L15">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="DateSelectors.RandomSelector" href="#DateSelectors.RandomSelector"><code>DateSelectors.RandomSelector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">RandomSelector(seed, holdout_fraction=1//2, block_size=Day(1), offset=Day(0))</code></pre><p>Determine holdout set by randomly subsampling contiguous blocks of size <code>block_size</code> without replacement using a <code>MersenneTwister</code> seeded with <code>seed</code>. The probability of any given block being in the holdout set is given by <code>holdout_fraction</code>.</p><p>The <code>offset</code> is rarely needed, but is used to control block boundries. It is given as a offset relative to <em>Monday 1st Jan 1900</em>. For example, with the default offset of <code>Day(0)</code>, and if using a <code>Week(1)</code> <code>block_size</code>, then every block will start on a Monday, and will go for 1 or more weeks from there.</p><p>Note that at the boundries of the partitioned dates the blocks may not be of size <code>block_size</code> if they go over the edge – this is infact the common case.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/DateSelectors.jl/blob/f229f7518cce27a17b3d8780090323790173c670/src/RandomSelector.jl#LL1-L15">source</a></section></article><h1 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h1><ul><li><a href="api.html#DateSelectors.DateSelector"><code>DateSelectors.DateSelector</code></a></li><li><a href="api.html#DateSelectors.NoneSelector"><code>DateSelectors.NoneSelector</code></a></li><li><a href="api.html#DateSelectors.PeriodicSelector"><code>DateSelectors.PeriodicSelector</code></a></li><li><a href="api.html#DateSelectors.RandomSelector"><code>DateSelectors.RandomSelector</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="index.html">« Home</a><a class="docs-footer-nextpage" href="examples.html">Examples »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.23 on <span class="colophon-date" title="Tuesday 27 June 2023 03:05">Tuesday 27 June 2023</span>. Using Julia version 1.9.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| partition(dates::AbstractVector{Date}, s::DateSelector)</code></pre><p>Partition the set of <code>dates</code> into disjoint <code>validation</code> and <code>holdout</code> sets according to the <code>selector</code> and return a <code>NamedTuple({:validation, :holdout})</code> of iterators.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/DateSelectors.jl/blob/f229f7518cce27a17b3d8780090323790173c670/src/common.jl#LL10-L17">source</a></section></article><h1 id="Selectors"><a class="docs-heading-anchor" href="#Selectors">Selectors</a><a id="Selectors-1"></a><a class="docs-heading-anchor-permalink" href="#Selectors" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="DateSelectors.DateSelector" href="#DateSelectors.DateSelector"><code>DateSelectors.DateSelector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">DateSelector</code></pre><p>Determines how to <a href="api.html#Base.Iterators.partition"><code>partition</code></a> a date set into disjoint validation and holdout sets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/DateSelectors.jl/blob/f229f7518cce27a17b3d8780090323790173c670/src/common.jl#LL2-L6">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="DateSelectors.NoneSelector" href="#DateSelectors.NoneSelector"><code>DateSelectors.NoneSelector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">NoneSelector()</code></pre><p>Assign all dates to the validation set, select no holdout dates.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/DateSelectors.jl/blob/f229f7518cce27a17b3d8780090323790173c670/src/NoneSelector.jl#LL1-L5">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="DateSelectors.PeriodicSelector" href="#DateSelectors.PeriodicSelector"><code>DateSelectors.PeriodicSelector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">PeriodicSelector(period::DatePeriod, stride::DatePeriod=Day(1), offset::DatePeriod=Day(0))</code></pre><p>Assign holdout dates by taking a set of size <code>stride</code> once per <code>period</code>. The offset is relative to <em>Monday 1st Jan 1900</em>, and controls when the selected section starts.</p><p>For example, <code>PeriodicSelector(Week(1), Day(2), Day(1))</code> will select 2 days per week. With this selected periods offset by 1 day from 1st Jan 1900. I.e. if applied to the first two weeks of the year 1900, it would select 2nd, 3rd, 9th and 8th of Jan 1900.</p><p>Note: this cannot be actually used to select days earlier than <code>offset</code> after 1st Jan 1900.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/DateSelectors.jl/blob/f229f7518cce27a17b3d8780090323790173c670/src/PeriodicSelector.jl#LL2-L15">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="DateSelectors.RandomSelector" href="#DateSelectors.RandomSelector"><code>DateSelectors.RandomSelector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">RandomSelector(seed, holdout_fraction=1//2, block_size=Day(1), offset=Day(0))</code></pre><p>Determine holdout set by randomly subsampling contiguous blocks of size <code>block_size</code> without replacement using a <code>MersenneTwister</code> seeded with <code>seed</code>. The probability of any given block being in the holdout set is given by <code>holdout_fraction</code>.</p><p>The <code>offset</code> is rarely needed, but is used to control block boundries. It is given as a offset relative to <em>Monday 1st Jan 1900</em>. For example, with the default offset of <code>Day(0)</code>, and if using a <code>Week(1)</code> <code>block_size</code>, then every block will start on a Monday, and will go for 1 or more weeks from there.</p><p>Note that at the boundries of the partitioned dates the blocks may not be of size <code>block_size</code> if they go over the edge – this is infact the common case.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/DateSelectors.jl/blob/f229f7518cce27a17b3d8780090323790173c670/src/RandomSelector.jl#LL1-L15">source</a></section></article><h1 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h1><ul><li><a href="api.html#DateSelectors.DateSelector"><code>DateSelectors.DateSelector</code></a></li><li><a href="api.html#DateSelectors.NoneSelector"><code>DateSelectors.NoneSelector</code></a></li><li><a href="api.html#DateSelectors.PeriodicSelector"><code>DateSelectors.PeriodicSelector</code></a></li><li><a href="api.html#DateSelectors.RandomSelector"><code>DateSelectors.RandomSelector</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="index.html">« Home</a><a class="docs-footer-nextpage" href="examples.html">Examples »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.23 on <span class="colophon-date" title="Wednesday 28 June 2023 03:03">Wednesday 28 June 2023</span>. Using Julia version 1.9.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.