Skip to content

Commit fe54c29

Browse files
committed
Documentation
1 parent 377a10c commit fe54c29

File tree

1 file changed

+21
-22
lines changed

1 file changed

+21
-22
lines changed

README.adoc

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,26 @@ The overall complexity of the implemented algorithm to estimate the regression c
163163
`N` denotes the size of the training data set (the number of documents in the search result set) and `C` the number
164164
of the indicated explanatory variables (fields).
165165

166+
## Installation
167+
168+
### Elasticsearch 5.x
169+
For installing this plugin please choose first the proper version under the compatible
170+
matrix which matches your Elasticsearch version and use the download link for the following command.
171+
172+
[source]
173+
----
174+
./bin/elasticsearch-plugin install https://github.com/scaleborn/elasticsearch-linear-regression/releases/download/5.3.0.1/elasticsearch-linear-regression-5.3.0.1.zip
175+
----
176+
The plugin will be installed under the name "linear-regression".
177+
Do not forget to restart the node after installing.
178+
179+
.Compatibility matrix
180+
[frame="all"]
181+
|===
182+
| Plugin version | Elasticsearch version | Release date
183+
| https://github.com/scaleborn/elasticsearch-linear-regression/releases/download/5.3.0.1/elasticsearch-linear-regression-5.3.0.1.zip[5.3.0.1] | 5.3.0 | Jun 1, 2017
184+
|===
185+
166186
## Examples
167187
### Predicting house prices
168188
The idea is very simple. We have data in our Elasticsearch index representing
@@ -199,7 +219,7 @@ The indexed data will have this form:
199219
--------------------------------------------------
200220

201221
We can now query the index for houses in "Morro Bay" and let predict the price
202-
of our dream house with respect to the desired features like 3 bedrooms,
222+
for our dream house with respect to the desired features like 3 bedrooms,
203223
2 bathrooms and at least 2000 square feet:
204224
[source,js]
205225
--------------------------------------------------
@@ -240,27 +260,6 @@ $ 650,000 to pay for the desired house in "Morro Bay".
240260
}
241261
--------------------------------------------------
242262

243-
## Installation
244-
245-
### Elasticsearch 5.x
246-
For installing this plugin please choose first the proper version under the compatible
247-
matrix which matches your Elasticsearch version and use the download link for the following command.
248-
249-
[source]
250-
----
251-
./bin/elasticsearch-plugin install https://github.com/scaleborn/elasticsearch-linear-regression/releases/download/5.3.0.1/elasticsearch-linear-regression-5.3.0.1.zip
252-
----
253-
The plugin will be installed under the name "linear-regression".
254-
Do not forget to restart the node after installing.
255-
256-
.Compatibility matrix
257-
[frame="all"]
258-
|===
259-
| Plugin version | Elasticsearch version | Release date
260-
| https://github.com/scaleborn/elasticsearch-linear-regression/releases/download/5.3.0.1/elasticsearch-linear-regression-5.3.0.1.zip[5.3.0.1] | 5.3.0 | Jun 1, 2017
261-
|===
262-
263-
264263
## License
265264
Copyright 2017 Scaleborn UG (haftungsbeschränkt).
266265

0 commit comments

Comments
 (0)