Skip to content

Commit e32b889

Browse files
authored
[ML] Deemphasizing X-Pack (#312)
ML is now a feature of the Elastic Stack
1 parent 46cea29 commit e32b889

File tree

7 files changed

+22
-21
lines changed

7 files changed

+22
-21
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to X-Pack Machine Learning Core
1+
# Contributing to Elasticsearch Machine Learning Core
22

33
We love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the Elastic Stack itself.
44

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Machine Learning for the Elastic Stack
22

3-
<https://www.elastic.co/products/x-pack>
3+
<https://www.elastic.co/products/stack/machine-learning>
44

5-
The ml-cpp repo is a part of Machine Learning for X-Pack and is available with
6-
either a trial or platinum license for the
5+
The ml-cpp repo is a part of Machine Learning for the Elastic Stack, which is
6+
available with either a trial or platinum license for the
77
[Elastic Stack](https://www.elastic.co/products).
88

99
This repo only contains the the C++ code that implements the core analytics for
1010
machine learning.
1111

12-
Code for integrating into the Elastic Stack and source for its documentation can
13-
be found in the main
12+
Code for integrating into Elasticsearch and source for its documentation can be
13+
found in the main
1414
[elasticsearch repo](https://github.com/elastic/elasticsearch).
1515

1616
## Elastic License Functionality
@@ -23,24 +23,25 @@ subject to the Elastic License are in the [3rd_party](3rd_party) and
2323

2424
## Getting Started
2525

26-
Before starting with Machine Learning for X-Pack, it's a good idea to get some
27-
experience with the
26+
Before starting with Machine Learning, it's a good idea to get some experience
27+
with the rest of the
2828
[Elastic Stack](https://www.elastic.co/guide/en/elastic-stack/current/index.html)
2929
first.
3030

3131
To get started with Machine Learning please have a look at
32-
<https://www.elastic.co/guide/en/x-pack/current/ml-getting-started.html>.
32+
<https://www.elastic.co/guide/en/elastic-stack-overview/current/ml-getting-started.html>.
3333

3434
Full documentation of Machine Learning can be found at
35-
<https://www.elastic.co/guide/en/x-pack/current/xpack-ml.html>.
35+
<https://www.elastic.co/guide/en/elastic-stack-overview/current/xpack-ml.html>.
3636

3737
## Questions/Bug Reports/Help
3838

3939
We are happy to help and to make sure your questions can be answered by the
4040
right people, please follow the guidelines below:
4141

4242
* If you have a general question about functionality please use our
43-
[discuss](https://discuss.elastic.co/c/x-pack) forums.
43+
[discuss](https://discuss.elastic.co/tags/c/elasticsearch/machine-learning)
44+
forums.
4445
* If you have a support contract please use your dedicated support channel.
4546
* For questions regarding subscriptions please
4647
[contact](https://www.elastic.co/subscriptions#request-info) us.

bin/autodetect/Main.cc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ int main(int argc, char** argv) {
166166
const TDataSearcherUPtr restoreSearcher{[isRestoreFileNamedPipe, &ioMgr]() -> TDataSearcherUPtr {
167167
if (ioMgr.restoreStream()) {
168168
// Check whether state is restored from a file, if so we assume that this is a debugging case
169-
// and therefore does not originate from X-Pack.
169+
// and therefore does not originate from the ML Java code.
170170
if (!isRestoreFileNamedPipe) {
171171
// apply a filter to overcome differences in the way persistence vs. restore works
172172
auto strm = std::make_shared<boost::iostreams::filtering_istream>();

bin/categorize/Main.cc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ int main(int argc, char** argv) {
121121
const TDataSearcherUPtr restoreSearcher{[isRestoreFileNamedPipe, &ioMgr]() -> TDataSearcherUPtr {
122122
if (ioMgr.restoreStream()) {
123123
// Check whether state is restored from a file, if so we assume that this is a debugging case
124-
// and therefore does not originate from X-Pack.
124+
// and therefore does not originate from the ML Java code.
125125
if (!isRestoreFileNamedPipe) {
126126
// apply a filter to overcome differences in the way persistence vs. restore works
127127
auto strm = std::make_shared<boost::iostreams::filtering_istream>();

include/api/CForecastRunner.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ class API_EXPORT CForecastRunner final : private core::CNonCopyable {
7676
//! max memory allowed to use for forecast models persisting to disk
7777
static const size_t MAX_FORECAST_MODEL_PERSISTANCE_MEMORY = 524288000ull; // 500MB
7878

79-
//! Note: This value is lower than on X-pack side to prevent side-effects,
80-
//! if you change this value also change the limit on X-pack side.
81-
//! The purpose of this value is to guard the rest of the system regarding
82-
//! an out of disk space
79+
//! Note: This value is lower than in the ML Java code to prevent side-effects.
80+
//! If you change this value also change the limit in the ML Java code.
81+
//! The purpose of this value is to guard the rest of the system against
82+
//! running out of disk space.
8383
//! minimum disk space required for disk persistence
8484
static const size_t MIN_FORECAST_AVAILABLE_DISK_SPACE = 4294967296ull; // 4GB
8585

lib/api/CForecastRunner.cc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ void CForecastRunner::forecastWorker() {
228228
boost::system::error_code errorCode;
229229
boost::filesystem::remove_all(temporaryFolder, errorCode);
230230
if (errorCode) {
231-
// not an error: there is also cleanup code on X-pack side
231+
// not an error: there is also cleanup code on the Java side
232232
LOG_WARN(<< "Failed to cleanup temporary data from: "
233233
<< forecastJob.s_TemporaryFolder << " error "
234234
<< errorCode.message());
@@ -429,7 +429,7 @@ bool CForecastRunner::parseAndValidateForecastRequest(const std::string& control
429429
// use -1 as default to allow 0 as 'never expires'
430430
expiresIn = properties.get<core_t::TTime>("expires_in", -1l);
431431

432-
// note: this is not exposed on x-pack side
432+
// note: this is not exposed on the Java side
433433
forecastJob.s_BoundsPercentile = properties.get<double>("boundspercentile", 95.0);
434434
} catch (const std::exception& e) {
435435
LOG_ERROR(<< ERROR_FORECAST_REQUEST_FAILED_TO_PARSE << e.what());

mk/make_rc_defines.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ if git -c core.fileMode=false diff-index --quiet HEAD -- ; then
1616
ML_FILEFLAGS=0
1717
else
1818
ML_FILEFLAGS=VS_FF_PRIVATEBUILD
19-
fi
19+
fi
2020
echo $1 | grep '\.dll$' > /dev/null
2121
if [ $? -eq 0 ] ; then
2222
ML_FILETYPE=VFT_DLL
@@ -39,6 +39,6 @@ echo -DML_USER=\'\"$ML_USER\"\' \
3939
-DML_NAME=\'\"$ML_NAME\"\' \
4040
-DML_YEAR=\'\"$ML_YEAR\"\' \
4141
-DML_ICON=\'\"$ML_ICON\"\' \
42-
-DRIGHT_CLICK_PRODUCT_NAME=\'\"Elastic X-Pack\"\' \
42+
-DRIGHT_CLICK_PRODUCT_NAME=\'\"Elasticsearch machine learning\"\' \
4343
-N
4444

0 commit comments

Comments
 (0)