Skip to content

Commit

Permalink
deploy: b44c6f5
Browse files Browse the repository at this point in the history
  • Loading branch information
@gforsyth
gforsyth committed Nov 29, 2023
1 parent 28bf6b4 commit 65f212d
Show file tree
Hide file tree
Showing 8 changed files with 220 additions and 598 deletions.
370 changes: 7 additions & 363 deletions reference/core.html
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions reference/selectors.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -522,8 +522,8 @@ <h2 class="anchored" data-anchor-id="parameters-6">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 6%">
<col style="width: 32%">
<col style="width: 52%">
<col style="width: 38%">
<col style="width: 47%">
<col style="width: 8%">
</colgroup>
<thead>
Expand All @@ -537,7 +537,7 @@ <h2 class="anchored" data-anchor-id="parameters-6">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>dtype</code></td>
<td>dt.DataType | str | type[dt.DataType]</td>
<td>ibis.ibis.DataType | str | type[ibis.ibis.DataType]</td>
<td>The dtype to match. May be a dtype instance, string, or dtype class.</td>
<td><em>required</em></td>
</tr>
Expand All @@ -553,9 +553,9 @@ <h1>where</h1>
<h2 class="anchored" data-anchor-id="parameters-7">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 7%">
<col style="width: 18%">
<col style="width: 67%">
<col style="width: 6%">
<col style="width: 24%">
<col style="width: 62%">
<col style="width: 6%">
</colgroup>
<thead>
Expand All @@ -569,7 +569,7 @@ <h2 class="anchored" data-anchor-id="parameters-7">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>predicate</code></td>
<td>Callable[[ir.Column], bool]</td>
<td>typing.Callable[[ibis.ibis.Column], bool]</td>
<td>A predicate function from <code>Column</code> to <code>bool</code>. Only columns where <code>predicate</code> returns <code>True</code> will be selected.</td>
<td><em>required</em></td>
</tr>
Expand Down
12 changes: 6 additions & 6 deletions reference/steps-encoding.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,8 +305,8 @@ <h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 4%">
<col style="width: 6%">
<col style="width: 85%">
<col style="width: 7%">
<col style="width: 84%">
<col style="width: 3%">
</colgroup>
<thead>
Expand All @@ -320,7 +320,7 @@ <h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td>SelectionType</td>
<td>ibisml.select.SelectionType</td>
<td>A selection of columns to one-hot encode.</td>
<td><em>required</em></td>
</tr>
Expand Down Expand Up @@ -359,8 +359,8 @@ <h2 class="anchored" data-anchor-id="parameters-1">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 4%">
<col style="width: 6%">
<col style="width: 85%">
<col style="width: 7%">
<col style="width: 84%">
<col style="width: 3%">
</colgroup>
<thead>
Expand All @@ -374,7 +374,7 @@ <h2 class="anchored" data-anchor-id="parameters-1">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td>SelectionType</td>
<td>ibisml.select.SelectionType</td>
<td>A selection of columns to categorical encode.</td>
<td><em>required</em></td>
</tr>
Expand Down
42 changes: 24 additions & 18 deletions reference/steps-imputation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -307,16 +307,16 @@ <h1>Imputation</h1>
</section>
<section id="ibisml.ImputeMean" class="level1">
<h1>ImputeMean</h1>
<p><code>ImputeMean()</code></p>
<p><code>ImputeMean(self, inputs)</code></p>
<p>A step for replacing NULL values in select columns with their respective mean in the training set.</p>
<section id="parameters" class="level2">
<h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 10%">
<col style="width: 8%">
<col style="width: 68%">
<col style="width: 12%">
<col style="width: 25%">
<col style="width: 55%">
<col style="width: 10%">
</colgroup>
<thead>
<tr class="header">
Expand All @@ -329,7 +329,7 @@ <h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td></td>
<td>ibisml.select.SelectionType</td>
<td>A selection of columns to impute. All columns must be numeric.</td>
<td><em>required</em></td>
</tr>
Expand All @@ -345,11 +345,17 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
</section>
<section id="ibisml.ImputeMode" class="level1">
<h1>ImputeMode</h1>
<p><code>ImputeMode()</code></p>
<p><code>ImputeMode(self, inputs)</code></p>
<p>A step for replacing NULL values in select columns with their respective modes in the training set.</p>
<section id="parameters-1" class="level2">
<h2 class="anchored" data-anchor-id="parameters-1">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 11%">
<col style="width: 33%">
<col style="width: 40%">
<col style="width: 13%">
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
Expand All @@ -361,7 +367,7 @@ <h2 class="anchored" data-anchor-id="parameters-1">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td></td>
<td>ibisml.select.SelectionType</td>
<td>A selection of columns to impute.</td>
<td><em>required</em></td>
</tr>
Expand All @@ -377,16 +383,16 @@ <h2 class="anchored" data-anchor-id="examples-1">Examples</h2>
</section>
<section id="ibisml.ImputeMedian" class="level1">
<h1>ImputeMedian</h1>
<p><code>ImputeMedian()</code></p>
<p><code>ImputeMedian(self, inputs)</code></p>
<p>A step for replacing NULL values in select columns with their respective medians in the training set.</p>
<section id="parameters-2" class="level2">
<h2 class="anchored" data-anchor-id="parameters-2">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 10%">
<col style="width: 8%">
<col style="width: 68%">
<col style="width: 12%">
<col style="width: 25%">
<col style="width: 55%">
<col style="width: 10%">
</colgroup>
<thead>
<tr class="header">
Expand All @@ -399,7 +405,7 @@ <h2 class="anchored" data-anchor-id="parameters-2">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td></td>
<td>ibisml.select.SelectionType</td>
<td>A selection of columns to impute. All columns must be numeric.</td>
<td><em>required</em></td>
</tr>
Expand All @@ -421,10 +427,10 @@ <h1>FillNA</h1>
<h2 class="anchored" data-anchor-id="parameters-3">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 11%">
<col style="width: 12%">
<col style="width: 66%">
<col style="width: 9%">
<col style="width: 10%">
<col style="width: 21%">
<col style="width: 59%">
<col style="width: 8%">
</colgroup>
<thead>
<tr class="header">
Expand All @@ -437,13 +443,13 @@ <h2 class="anchored" data-anchor-id="parameters-3">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td>SelectionType</td>
<td>ibisml.select.SelectionType</td>
<td>A selection of columns to fillna.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td><code>fill_value</code></td>
<td>Any</td>
<td>typing.Any</td>
<td>The fill value to use. Must be castable to the dtype of all columns in inputs.</td>
<td><em>required</em></td>
</tr>
Expand Down
40 changes: 20 additions & 20 deletions reference/steps-other.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,9 @@ <h1>Cast</h1>
<h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 6%">
<col style="width: 27%">
<col style="width: 58%">
<col style="width: 5%">
<col style="width: 33%">
<col style="width: 53%">
<col style="width: 7%">
</colgroup>
<thead>
Expand All @@ -329,13 +329,13 @@ <h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td>SelectionType</td>
<td>ibisml.select.SelectionType</td>
<td>A selection of columns to cast.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td><code>dtype</code></td>
<td>dt.DataType | type[dt.DataType] | str</td>
<td>ibis.ibis.DataType | type[ibis.ibis.DataType] | str</td>
<td>The dtype to cast to. May be a dtype instance, class, or a string representation of one.</td>
<td><em>required</em></td>
</tr>
Expand All @@ -359,10 +359,10 @@ <h1>Drop</h1>
<h2 class="anchored" data-anchor-id="parameters-1">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 11%">
<col style="width: 34%">
<col style="width: 39%">
<col style="width: 14%">
<col style="width: 21%">
<col style="width: 47%">
<col style="width: 17%">
</colgroup>
<thead>
<tr class="header">
Expand All @@ -375,7 +375,7 @@ <h2 class="anchored" data-anchor-id="parameters-1">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td>SelectionType</td>
<td>ibisml.select.SelectionType</td>
<td>A selection of columns to drop.</td>
<td><em>required</em></td>
</tr>
Expand All @@ -400,8 +400,8 @@ <h2 class="anchored" data-anchor-id="parameters-2">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 4%">
<col style="width: 18%">
<col style="width: 73%">
<col style="width: 27%">
<col style="width: 65%">
<col style="width: 3%">
</colgroup>
<thead>
Expand All @@ -415,19 +415,19 @@ <h2 class="anchored" data-anchor-id="parameters-2">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td>SelectionType</td>
<td>ibisml.select.SelectionType</td>
<td>A selection of columns to use as inputs to <code>expr</code>/<code>named_exprs</code>.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td><code>expr</code></td>
<td>Callable[[ir.Column], ir.Column] | Deferred | None</td>
<td>typing.Callable[[ibis.ibis.Column], ibis.ibis.Column] | ibis.common.deferred.Deferred | None</td>
<td>An optional callable (<code>Column -&gt; Column</code>) or deferred expression to apply to all columns in inputs. Output columns will have the same name as their respective inputs (effectively replacing them in the output table).</td>
<td><code>None</code></td>
</tr>
<tr class="odd">
<td><code>named_exprs</code></td>
<td>Callable[[ir.Column], ir.Column] | Deferred</td>
<td>typing.Callable[[ibis.ibis.Column], ibis.ibis.Column] | ibis.common.deferred.Deferred</td>
<td>Named callables (<code>Column -&gt; Column</code>) or deferred expressions to apply to all columns in inputs. Output columns will be named <code>{column}_{name}</code> where <code>column</code> is the input column name and <code>name</code> is the expression/callable name.</td>
<td><code>{}</code></td>
</tr>
Expand All @@ -452,10 +452,10 @@ <h1>Mutate</h1>
<h2 class="anchored" data-anchor-id="parameters-3">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 7%">
<col style="width: 26%">
<col style="width: 60%">
<col style="width: 5%">
<col style="width: 6%">
<col style="width: 39%">
<col style="width: 49%">
<col style="width: 4%">
</colgroup>
<thead>
<tr class="header">
Expand All @@ -468,13 +468,13 @@ <h2 class="anchored" data-anchor-id="parameters-3">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>exprs</code></td>
<td>Callable[[ir.Table], ir.Column] | Deferred</td>
<td>typing.Callable[[ibis.ibis.Table], ibis.ibis.Column] | ibis.common.deferred.Deferred</td>
<td>Callables (<code>Table -&gt; Column</code>) or deferred expressions to use to define new columns in the output table.</td>
<td><code>()</code></td>
</tr>
<tr class="even">
<td><code>named_exprs</code></td>
<td>Callable[[ir.Table], ir.Column] | Deferred</td>
<td>typing.Callable[[ibis.ibis.Table], ibis.ibis.Column] | ibis.common.deferred.Deferred</td>
<td>Named callables (<code>Table -&gt; Column</code>) or deferred expressions to use to define new columns in the output table.</td>
<td><code>{}</code></td>
</tr>
Expand Down
10 changes: 5 additions & 5 deletions reference/steps-standardization.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -298,10 +298,10 @@ <h1>ScaleStandard</h1>
<h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 9%">
<col style="width: 14%">
<col style="width: 64%">
<col style="width: 11%">
<col style="width: 8%">
<col style="width: 24%">
<col style="width: 56%">
<col style="width: 10%">
</colgroup>
<thead>
<tr class="header">
Expand All @@ -314,7 +314,7 @@ <h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td>SelectionType</td>
<td>ibisml.select.SelectionType</td>
<td>A selection of columns to normalize. All columns must be numeric.</td>
<td><em>required</em></td>
</tr>
Expand Down
18 changes: 9 additions & 9 deletions reference/steps-temporal.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,8 +305,8 @@ <h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 2%">
<col style="width: 13%">
<col style="width: 78%">
<col style="width: 15%">
<col style="width: 76%">
<col style="width: 5%">
</colgroup>
<thead>
Expand All @@ -320,13 +320,13 @@ <h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td>SelectionType</td>
<td>ibisml.select.SelectionType</td>
<td>A selection of date columns to expand into new features.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td><code>components</code></td>
<td>Sequence[Literal[‘day’, ‘week’, ‘month’, ‘year’, ‘dow’, ‘doy’]]</td>
<td>typing.Sequence[typing.Literal[‘day’, ‘week’, ‘month’, ‘year’, ‘dow’, ‘doy’]]</td>
<td>A sequence of components to expand. Options include - <code>day</code>: the day of the month as a numeric value - <code>week</code>: the week of the year as a numeric value - <code>month</code>: the month of the year as a categorical value - <code>year</code>: the year as a numeric value - <code>dow</code>: the day of the week as a categorical value - <code>doy</code>: the day of the year as a numeric value Defaults to <code>["dow", "month", "year"]</code>.</td>
<td><code>('dow', 'month', 'year')</code></td>
</tr>
Expand All @@ -351,9 +351,9 @@ <h1>ExpandTime</h1>
<h2 class="anchored" data-anchor-id="parameters-1">Parameters</h2>
<table class="table">
<colgroup>
<col style="width: 5%">
<col style="width: 24%">
<col style="width: 58%">
<col style="width: 4%">
<col style="width: 28%">
<col style="width: 55%">
<col style="width: 11%">
</colgroup>
<thead>
Expand All @@ -367,13 +367,13 @@ <h2 class="anchored" data-anchor-id="parameters-1">Parameters</h2>
<tbody>
<tr class="odd">
<td><code>inputs</code></td>
<td>SelectionType</td>
<td>ibisml.select.SelectionType</td>
<td>A selection of time columns to expand into new features.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td><code>components</code></td>
<td>Sequence[Literal[‘hour’, ‘minute’, ‘second’, ‘millisecond’]]</td>
<td>typing.Sequence[typing.Literal[‘hour’, ‘minute’, ‘second’, ‘millisecond’]]</td>
<td>A sequence of components to expand. Options include <code>hour</code>, <code>minute</code>, <code>second</code>, and <code>millisecond</code>. Defaults to <code>["hour", "minute", "second"]</code>.</td>
<td><code>('hour', 'minute', 'second')</code></td>
</tr>
Expand Down
Loading

0 comments on commit 65f212d

Please sign in to comment.