Skip to content

Commit

Permalink
Changing experimental tag type to experimental-toolkit for toolkit fu…
Browse files Browse the repository at this point in the history
…nctions (github#1272)
  • Loading branch information
Brian Rowe authored Jul 6, 2022
1 parent 99eb45b commit f378faa
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions api/asap.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ hyperfunction_subfamily: 'downsample'
hyperfunction_type: other
---

# asap_smooth() <tag type="toolkit">Toolkit</tag><tag type="experimental">Experimental</tag>
# asap_smooth() <tag type="toolkit">Toolkit</tag><tag type="experimental-toolkit">Experimental</tag>
The [ASAP smoothing alogrithm][asap-algorithm] is designed to create
human-readable graphs that preserve the rough shape and larger trends
of the input data, while minimizing the local variance between points.
Expand Down Expand Up @@ -75,4 +75,4 @@ The output for this query:


[asap-algorithm]: https://arxiv.org/pdf/1703.00983.pdf
[hyperfunctions-timevectors]: timescaledb/:currentVersion:/how-to-guides/hyperfunctions/function-pipelines/#timevectors
[hyperfunctions-timevectors]: /timescaledb/:currentVersion:/how-to-guides/hyperfunctions/function-pipelines/#timevectors
2 changes: 1 addition & 1 deletion api/duration_in.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ hyperfunction_type: accessor

import Experimental from 'versionContent/_partials/_experimental.mdx';

# duration_in() <tag type="toolkit">Toolkit</tag><tag type="experimental">Experimental</tag>
# duration_in() <tag type="toolkit">Toolkit</tag><tag type="experimental-toolkit">Experimental</tag>
Use this function to report the total duration for a given state in a [state aggregate][state_agg].

<Experimental />
Expand Down
2 changes: 1 addition & 1 deletion api/freq_agg.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ hyperfunction_type: aggregate

import Experimental from 'versionContent/_partials/_experimental.mdx';

# freq_agg() <tag type="toolkit">Toolkit</tag><tag type="experimental">Experimental</tag>
# freq_agg() <tag type="toolkit">Toolkit</tag><tag type="experimental-toolkit">Experimental</tag>
The `freq_agg` aggregate uses the [SpaceSaving][spacesaving-algorithm] algorithm
to estimate the most common elements of a set. This API takes a sizing parameter and
a PostgreSQL column, and returns a FreqAgg object that can be passed to
Expand Down
2 changes: 1 addition & 1 deletion api/into_values-freq_agg.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ hyperfunction_type: accessor

import Experimental from 'versionContent/_partials/_experimental.mdx';

# into_values() <tag type="toolkit">Toolkit</tag><tag type="experimental">Experimental</tag>
# into_values() <tag type="toolkit">Toolkit</tag><tag type="experimental-toolkit">Experimental</tag>
This function returns the data accumulated in a
[frequency aggregate][freq_agg] or [top N aggregate][topn_agg].
The aggregate operates over `AnyElement` types, so this method
Expand Down
2 changes: 1 addition & 1 deletion api/into_values-state_agg.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ hyperfunction_type: accessor

import Experimental from 'versionContent/_partials/_experimental.mdx';

# into_values() <tag type="toolkit">Toolkit</tag><tag type="experimental">Experimental</tag>
# into_values() <tag type="toolkit">Toolkit</tag><tag type="experimental-toolkit">Experimental</tag>
Returns the data accumulated in a [state aggregate][state_agg].
```sql
into_values (
Expand Down
4 changes: 2 additions & 2 deletions api/lttb.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ hyperfunction_subfamily: 'downsample'
hyperfunction_type: other
---

# lttb() <tag type="toolkit">Toolkit</tag><tag type="experimental">Experimental</tag>
# lttb() <tag type="toolkit">Toolkit</tag><tag type="experimental-toolkit">Experimental</tag>
[Largest Triangle Three Buckets][gh-lttb] is a downsampling method that
tries to retain visual similarity between the downsampled data and the
original dataset. The TimescaleDB Toolkit implementation of this takes
Expand Down Expand Up @@ -55,4 +55,4 @@ The output for this query:


[gh-lttb]: https://github.com/sveinn-steinarsson/flot-downsample
[hyperfunctions-timevectors]: timescaledb/:currentVersion:/how-to-guides/hyperfunctions/function-pipelines/#timevectors
[hyperfunctions-timevectors]: /timescaledb/:currentVersion:/how-to-guides/hyperfunctions/function-pipelines/#timevectors
2 changes: 1 addition & 1 deletion api/state_agg.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ hyperfunction_type: aggregate

import Experimental from 'versionContent/_partials/_experimental.mdx';

# state_agg() <tag type="toolkit">Toolkit</tag><tag type="experimental">Experimental</tag>
# state_agg() <tag type="toolkit">Toolkit</tag><tag type="experimental-toolkit">Experimental</tag>
The `state_agg` aggregate measures the amount of time spent in each
distinct value of a state field. It is designed to work with a relatively small
number of states and might not perform well on queries where states are
Expand Down
2 changes: 1 addition & 1 deletion api/topn.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ hyperfunction_type: accessor

import Experimental from 'versionContent/_partials/_experimental.mdx';

# topn() <tag type="toolkit">Toolkit</tag><tag type="experimental">Experimental</tag>
# topn() <tag type="toolkit">Toolkit</tag><tag type="experimental-toolkit">Experimental</tag>
Returns the most common values accumulated in a [frequency aggregate][freq_agg]
or [top N aggregate][topn_agg].
```sql
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import Experimental from 'versionContent/_partials/_experimental.mdx';

# Function pipelines <tag type="toolkit">Toolkit</tag><tag type="experimental">Experimental</tag>
# Function pipelines <tag type="toolkit">Toolkit</tag><tag type="experimental-toolkit">Experimental</tag>
Function pipelines are an experimental feature, designed to radically improve
how you write queries to analyze data in PostgreSQL and SQL. They work by
applying principles from functional programming and popular tools like Python
Expand Down

0 comments on commit f378faa

Please sign in to comment.