Skip to content

Commit

Permalink
[DOCS] Completes air-gapped ELSER install procedure. (#2655) (#2657)
Browse files Browse the repository at this point in the history
(cherry picked from commit 0d82ed4)

Co-authored-by: István Zoltán Szabó <[email protected]>
  • Loading branch information
mergify[bot] and szabosteve authored Jan 26, 2024
1 parent 1f99365 commit 85a6c5a
Showing 1 changed file with 36 additions and 5 deletions.
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 @@ -130,7 +130,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 @@ -244,14 +244,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 @@ -262,7 +273,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 @@ -305,7 +316,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 @@ -322,7 +343,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 @@ -336,6 +357,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

0 comments on commit 85a6c5a

Please sign in to comment.