forked from influxdata/docs-v2
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto-generated Flux docs (influxdata#4158)
* WIP testing autogen * WIP autogen docs, added contributors parital * updated stdlib * WIP autogen * Inject Flux stdlib frontmatter script (influxdata#4157) * added frontmatter injection script and frontmatter data file * regenerated stdlib * finalize frontmatter injection script * add frontmatter injection to CI build * remove debug line from frontmatter script * fresh docs generate * fresh generate
- Loading branch information
Showing
607 changed files
with
46,440 additions
and
21,117 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
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
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
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
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,32 +1,44 @@ | ||
--- | ||
title: Flux array package | ||
list_title: array package | ||
title: array package | ||
description: > | ||
The Flux `array` package provides functions for building tables from Flux arrays. | ||
Import the `array` package. | ||
aliases: | ||
- /influxdb/v2.0/reference/flux/stdlib/experimental/array/ | ||
- /influxdb/cloud/reference/flux/stdlib/experimental/array/ | ||
- /influxdb/v2.0/reference/flux/stdlib/array/ | ||
- /influxdb/cloud/reference/flux/stdlib/array/ | ||
The `array` package provides functions for building tables from Flux arrays. | ||
menu: | ||
flux_0_x_ref: | ||
name: array | ||
parent: Standard library | ||
name: array | ||
parent: stdlib | ||
identifier: array | ||
weight: 11 | ||
flux/v0.x/tags: [functions, array, package, table] | ||
cascade: | ||
related: | ||
- /flux/v0.x/data-types/composite/array/ | ||
introduced: 0.103.0 | ||
flux/v0.x/tags: [array, tables] | ||
introduced: 0.103.0 | ||
--- | ||
|
||
Flux `array` functions provide tools for building tables from Flux arrays. | ||
<!------------------------------------------------------------------------------ | ||
IMPORTANT: This page was generated from comments in the Flux source code. Any | ||
edits made directly to this page will be overwritten the next time the | ||
documentation is generated. | ||
To make updates to this documentation, update the comments above the package | ||
declaration in the Flux source code: | ||
https://github.com/influxdata/flux/blob/master/stdlib/array/array.flux | ||
Contributing to Flux: https://github.com/influxdata/flux#contributing | ||
Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md | ||
-------------------------------------------------------------------------------> | ||
|
||
The `array` package provides functions for building tables from Flux arrays. | ||
Import the `array` package: | ||
|
||
```js | ||
import "array" | ||
``` | ||
|
||
|
||
|
||
|
||
## Functions | ||
|
||
{{< children type="functions" show="pages" >}} |
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
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 |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: RohanSreerama5 package | ||
description: > | ||
The `RohanSreerama5` package contains packages and functions contributed by [@RohanSreerama5](https://github.com/RohanSreerama5). | ||
menu: | ||
flux_0_x_ref: | ||
name: RohanSreerama5 | ||
parent: contrib | ||
identifier: contrib/RohanSreerama5 | ||
weight: 21 | ||
--- | ||
|
||
<!------------------------------------------------------------------------------ | ||
IMPORTANT: This page was generated from comments in the Flux source code. Any | ||
edits made directly to this page will be overwritten the next time the | ||
documentation is generated. | ||
To make updates to this documentation, update the comments above the package | ||
declaration in the Flux source code: | ||
https://github.com/influxdata/flux/blob/master/stdlib/contrib/RohanSreerama5/RohanSreerama5.flux | ||
Contributing to Flux: https://github.com/influxdata/flux#contributing | ||
Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md | ||
-------------------------------------------------------------------------------> | ||
|
||
The `RohanSreerama5` package contains packages and functions contributed by [@RohanSreerama5](https://github.com/RohanSreerama5). | ||
|
||
|
||
|
||
|
||
## Packages | ||
|
||
{{< children show="sections" >}} |
49 changes: 49 additions & 0 deletions
49
content/flux/v0.x/stdlib/contrib/RohanSreerama5/naiveBayesClassifier/_index.md
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 |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
title: naiveBayesClassifier package | ||
description: > | ||
The `naiveBayesClassifier` package provides an implementation of | ||
a naive Bayes classifier. | ||
menu: | ||
flux_0_x_ref: | ||
name: naiveBayesClassifier | ||
parent: contrib/RohanSreerama5 | ||
identifier: contrib/RohanSreerama5/naiveBayesClassifier | ||
weight: 31 | ||
cascade: | ||
|
||
introduced: v0.86.0 | ||
--- | ||
|
||
<!------------------------------------------------------------------------------ | ||
IMPORTANT: This page was generated from comments in the Flux source code. Any | ||
edits made directly to this page will be overwritten the next time the | ||
documentation is generated. | ||
To make updates to this documentation, update the comments above the package | ||
declaration in the Flux source code: | ||
https://github.com/influxdata/flux/blob/master/stdlib/contrib/RohanSreerama5/naiveBayesClassifier/naiveBayesClassifier.flux | ||
Contributing to Flux: https://github.com/influxdata/flux#contributing | ||
Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md | ||
-------------------------------------------------------------------------------> | ||
|
||
The `naiveBayesClassifier` package provides an implementation of | ||
a naive Bayes classifier. | ||
Import the `contrib/RohanSreerama5/naiveBayesClassifier` package: | ||
|
||
```js | ||
import "contrib/RohanSreerama5/naiveBayesClassifier" | ||
``` | ||
|
||
Currently supports single field classification and binary data sets. | ||
|
||
For information about demonstrating functions in this package, see the | ||
[package README on GitHub](https://github.com/influxdata/flux/blob/master/stdlib/contrib/RohanSreerama5/naiveBayesClassifier/README.md). | ||
|
||
|
||
## Functions | ||
|
||
{{< children type="functions" show="pages" >}} |
72 changes: 72 additions & 0 deletions
72
content/flux/v0.x/stdlib/contrib/RohanSreerama5/naiveBayesClassifier/naivebayes.md
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 |
---|---|---|
@@ -0,0 +1,72 @@ | ||
--- | ||
title: naiveBayesClassifier.naiveBayes() function | ||
description: > | ||
`naiveBayesClassifier.naiveBayes()` performs a naive Bayes classification. | ||
menu: | ||
flux_0_x_ref: | ||
name: naiveBayesClassifier.naiveBayes | ||
parent: contrib/RohanSreerama5/naiveBayesClassifier | ||
identifier: contrib/RohanSreerama5/naiveBayesClassifier/naiveBayes | ||
weight: 301 | ||
flux/v0.x/tags: [transformations] | ||
--- | ||
|
||
<!------------------------------------------------------------------------------ | ||
IMPORTANT: This page was generated from comments in the Flux source code. Any | ||
edits made directly to this page will be overwritten the next time the | ||
documentation is generated. | ||
To make updates to this documentation, update the function comments above the | ||
function definition in the Flux source code: | ||
https://github.com/influxdata/flux/blob/master/stdlib/contrib/RohanSreerama5/naiveBayesClassifier/naiveBayesClassifier.flux#L29-L108 | ||
Contributing to Flux: https://github.com/influxdata/flux#contributing | ||
Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md | ||
-------------------------------------------------------------------------------> | ||
|
||
`naiveBayesClassifier.naiveBayes()` performs a naive Bayes classification. | ||
|
||
|
||
|
||
##### Function type signature | ||
|
||
```js | ||
( | ||
<-tables: stream[{C with _time: time, _measurement: E, _field: D}], | ||
myClass: string, | ||
myField: A, | ||
myMeasurement: B, | ||
) => stream[F] where A: Equatable, B: Equatable, D: Equatable, E: Equatable, F: Record | ||
``` | ||
|
||
{{% caption %}}For more information, see [Function type signatures](/flux/v0.x/function-type-signatures/).{{% /caption %}} | ||
|
||
## Parameters | ||
|
||
### myMeasurement | ||
({{< req >}}) | ||
Measurement to use as training data. | ||
|
||
|
||
|
||
### myField | ||
({{< req >}}) | ||
Field to use as training data. | ||
|
||
|
||
|
||
### myClass | ||
({{< req >}}) | ||
Class to classify against. | ||
|
||
|
||
|
||
### tables | ||
|
||
Input data. Default is piped-forward data (`<-`). | ||
|
||
|
||
|
Oops, something went wrong.