Skip to content

Commit

Permalink
#8 Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mbok committed Oct 8, 2017
1 parent 8e57ef8 commit e3feecd
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ image:http://latex.codecogs.com/gif.latex?h(x)%20=%20\theta_{0}%20+%20\sum_{j=1}

This plugin enhances Elasticsearch's query engine by new aggregations and a score function to make use
of linear regression for data stored in Elasticsearch.
The [aggregations](#aggregations) utilize the index data during search
The <<aggregations,aggregations>> utilize the index data during search
as training data for estimating a linear regression model in order to expose information like:

* prediction / forecasting of a value for the target variable,
Expand All @@ -22,13 +22,14 @@ as training data for estimating a linear regression model in order to expose inf
Estimation is performed regarding the https://en.wikipedia.org/wiki/Ordinary_least_squares[OLS]
(ordinary least-squares) approach over the search result set.

The [score function](#score-function) allows to rank the documents given the coefficients of the estimated model
The <<score-function,score function>> allows to rank the documents given the coefficients of the estimated model
by the error term. This may help

* to identify breakouts or rather outliers,
* to be used for recommending documents matching best the regression model.
[[aggregations]]
## Aggregations
Both aggregations are numeric aggregations that estimate the linear regression coefficients
image:http://latex.codecogs.com/gif.latex?\theta_0,%20\theta_1,%20\theta_2,.%20.%20.,%20\theta_C%20[]
Expand Down

0 comments on commit e3feecd

Please sign in to comment.