Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Completes air-gapped ELSER install procedure #2655

Merged
merged 1 commit into from
Jan 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 36 additions & 5 deletions docs/en/stack/ml/nlp/ml-nlp-elser.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ allocations and threads per allocation values.
[role="screenshot"]
image::images/ml-nlp-deployment-id-elser-v2.png[alt="Deploying ELSER",align="center"]
--
5. Click Start.
5. Click **Start**.


[discrete]
Expand Down Expand Up @@ -255,14 +255,25 @@ options:
* put the model artifacts into a directory inside the config directory on all
{ref}/modules-node.html#master-node[master-eligible nodes].

You need the following files in your system:

[discrete]
[[elser-model-artifacts]]
=== Model artifact files

For the cross-platform verison, you need the following files in your system:
```
https://ml-models.elastic.co/elser_model_2.metadata.json
https://ml-models.elastic.co/elser_model_2.pt
https://ml-models.elastic.co/elser_model_2.vocab.json
```

For the optimized version, you need the following files in your system:
```
https://ml-models.elastic.co/elser_model_2_linux-x86_64.metadata.json
https://ml-models.elastic.co/elser_model_2_linux-x86_64.pt
https://ml-models.elastic.co/elser_model_2_linux-x86_64.vocab.json
```


[discrete]
=== Using an HTTP server
Expand All @@ -273,7 +284,7 @@ supports passwordless HTTP servers.
You can use any HTTP service to deploy ELSER. This example uses the official
Nginx Docker image to set a new HTTP download service up.

. Download the model artifact files from https://ml-models.elastic.co/.
. Download the <<elser-model-artifacts,model artifact files>>.
. Put the files into a subdirectory of your choice.
. Run the following commands:
+
Expand Down Expand Up @@ -316,7 +327,17 @@ master-eligible nodes can reach the server you specify.
--
. Repeat step 5 on all master-eligible nodes.
. {ref}/restart-cluster.html#restart-cluster-rolling[Restart] the
master-eligible nodes one by one.
master-eligible nodes one by one.
. Navigate to the **Trained Models** page in {kib}, ELSER can be found in the
list of trained models.
. Click the **Add trained model** button, select the ELSER model version you
downloaded in step 1 and want to deploy, and click **Download**. The selected
model will be downloaded from the HTTP/HTTPS server you configured.
. After the download is finished, start the deployment by clicking the
**Start deployment** button.
. Provide a deployment ID, select the priority, and set the number of
allocations and threads per allocation values.
. Click **Start**.

The HTTP server is only required for downloading the model. After the download
has finished, you can stop and delete the service. You can stop the Docker image
Expand All @@ -333,7 +354,7 @@ docker stop ml-models

For a file-based access, follow these steps:

. Download the model artifact files from https://ml-models.elastic.co/.
. Download the <<elser-model-artifacts,model artifact files>>.
. Put the files into a `models` subdirectory inside the `config` directory of
your Elasticsearch deployment.
. Point your Elasticsearch deployment to the model directory by adding the
Expand All @@ -347,6 +368,16 @@ xpack.ml.model_repository: file://${path.home}/config/models/`
. Repeat step 2 and step 3 on all master-eligible nodes.
. {ref}/restart-cluster.html#restart-cluster-rolling[Restart] the
master-eligible nodes one by one.
. Navigate to the **Trained Models** page in {kib}, ELSER can be found in the
list of trained models.
. Click the **Add trained model** button, select the ELSER model version you
downloaded in step 1 and want to deploy and click **Download**. The selected
model will be downloaded from the model directory where you put in step 2.
. After the download is finished, start the deployment by clicking the
**Start deployment** button.
. Provide a deployment ID, select the priority, and set the number of
allocations and threads per allocation values.
. Click **Start**.


[discrete]
Expand Down