Skip to content

Commit

Permalink
Docs: Mark variable_width_histogram experimental (#58574)
Browse files Browse the repository at this point in the history
We're tracking this aggregation's experimental-progress in #58573. We'd
like a little time to be able to make backwards incompatible changes to
the aggregation because we're not 100% sure about the request and
response format yet.
  • Loading branch information
nik9000 authored Jun 25, 2020
1 parent 2671ff7 commit dda78ff
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/reference/aggregations/bucket.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,6 @@ include::bucket/significanttext-aggregation.asciidoc[]

include::bucket/terms-aggregation.asciidoc[]

include::bucket/variablewidthhistogram-aggregation.asciidoc[]

include::bucket/range-field-note.asciidoc[]
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[[search-aggregations-bucket-variablewidthhistogram-aggregation]]
=== Variable Width Histogram Aggregation

experimental::["We're evaluating the request and response format for this new aggregation.",https://github.com/elastic/elasticsearch/issues/58573]

This is a multi-bucket aggregation similar to <<search-aggregations-bucket-histogram-aggregation>>.
However, the width of each bucket is not specified. Rather, a target number of buckets is provided and bucket intervals
are dynamically determined based on the document distribution. This is done using a simple one-pass document clustering algorithm
Expand Down

0 comments on commit dda78ff

Please sign in to comment.