Skip to content

Commit b83c243

Browse files
iuliaferolipquentin
authored and
github-actions[bot]
committed
Add Python ML examples to the API docs (#2489)
Co-authored-by: Quentin Pradet <[email protected]> (cherry picked from commit 8a19bb9)
1 parent 47bd55d commit b83c243

21 files changed

+256
-0
lines changed

‎docs/examples/095e3f21941a9cc75f398389a075152d.asciidoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// ml/trained-models/apis/infer-trained-model.asciidoc:1043
2+
3+
[source, python]
4+
----
5+
resp = client.ml.infer_trained_model(
6+
model_id="cross-encoder__ms-marco-tinybert-l-2-v2",
7+
body={
8+
"docs": [
9+
{
10+
"text_field": "Berlin has a population of 3,520,031 registered inhabitants in an area of 891.82 square kilometers."
11+
},
12+
{
13+
"text_field": "New York City is famous for the Metropolitan Museum of Art."
14+
},
15+
],
16+
"inference_config": {
17+
"text_similarity": {"text": "How many people live in Berlin?"}
18+
},
19+
},
20+
)
21+
print(resp)
22+
----

‎docs/examples/0e5d25c7bb738c42d471020d678e2966.asciidoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// ml/trained-models/apis/start-trained-model-deployment.asciidoc:173
2+
3+
[source, python]
4+
----
5+
resp = client.ml.start_trained_model_deployment(
6+
model_id="my_model",
7+
deployment_id="my_model_for_ingest",
8+
wait_for="started",
9+
timeout="1m",
10+
)
11+
print(resp)
12+
----

‎docs/examples/147d341cb212dcc015c129a9c5dcf9c9.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// ml/trained-models/apis/put-trained-models-aliases.asciidoc:82
2+
3+
[source, python]
4+
----
5+
resp = client.ml.put_trained_model_alias(
6+
model_id="flight-delay-prediction-1574775339910",
7+
model_alias="flight_delay_model",
8+
)
9+
print(resp)
10+
----

‎docs/examples/2d633b7f346b828d01f923ce9dbf6ad5.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// ml/trained-models/apis/put-trained-model-vocabulary.asciidoc:63
2+
3+
[source, python]
4+
----
5+
resp = client.ml.put_trained_model_vocabulary(
6+
model_id="elastic__distilbert-base-uncased-finetuned-conll03-english",
7+
body={"vocabulary": ["[PAD]", "[unused0]", ...]},
8+
)
9+
print(resp)
10+
----

‎docs/examples/35a272df8c919a12d7c3106a18245748.asciidoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// ml/trained-models/apis/infer-trained-model.asciidoc:849
2+
3+
[source, python]
4+
----
5+
resp = client.ml.infer_trained_model(
6+
model_id="lang_ident_model_1",
7+
body={
8+
"docs": [
9+
{
10+
"text": "The fool doth think he is wise, but the wise man knows himself to be a fool."
11+
}
12+
]
13+
},
14+
)
15+
print(resp)
16+
----

‎docs/examples/3c345feb7c52fd54bcb5d5505fd8bc3b.asciidoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// ml/trained-models/apis/infer-trained-model.asciidoc:1008
2+
3+
[source, python]
4+
----
5+
resp = client.ml.infer_trained_model(
6+
model_id="model2",
7+
body={
8+
"docs": [{"text_field": "<long text to extract answer>"}],
9+
"inference_config": {
10+
"question_answering": {"question": "<question to be answered>"}
11+
},
12+
},
13+
)
14+
print(resp)
15+
----

‎docs/examples/4c174e228b6b74497b73ef2be80de7ad.asciidoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
// ml/trained-models/apis/get-trained-models.asciidoc:1460
2+
3+
[source, python]
4+
----
5+
resp = client.ml.get_trained_models()
6+
print(resp)
7+
----

‎docs/examples/5837d5f50665ac0a26181d3aaeb3f204.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// ml/trained-models/apis/start-trained-model-deployment.asciidoc:181
2+
3+
[source, python]
4+
----
5+
resp = client.ml.start_trained_model_deployment(
6+
model_id="my_model",
7+
deployment_id="my_model_for_search",
8+
)
9+
print(resp)
10+
----

‎docs/examples/776b553df0e507c96dbdbaedecaca0cc.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// ml/trained-models/apis/infer-trained-model.asciidoc:880
2+
3+
[source, python]
4+
----
5+
resp = client.ml.infer_trained_model(
6+
model_id="model2",
7+
body={"docs": [{"text_field": "The movie was awesome!!"}]},
8+
)
9+
print(resp)
10+
----

‎docs/examples/7e4cb3de3e3c75646b60f9f81ddc59cc.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc:43
2+
3+
[source, python]
4+
----
5+
resp = client.ml.clear_trained_model_deployment_cache(
6+
model_id="elastic__distilbert-base-uncased-finetuned-conll03-english",
7+
)
8+
print(resp)
9+
----

‎docs/examples/821422f8a03dc98d024a15fc737fe9eb.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// ml/trained-models/apis/delete-trained-models-aliases.asciidoc:51
2+
3+
[source, python]
4+
----
5+
resp = client.ml.delete_trained_model_alias(
6+
model_id="flight-delay-prediction-1574775339910",
7+
model_alias="flight_delay_model",
8+
)
9+
print(resp)
10+
----

‎docs/examples/9225841fdcddaf83ebdb90c2b0399e20.asciidoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
// ml/trained-models/apis/get-trained-models-stats.asciidoc:405
2+
3+
[source, python]
4+
----
5+
resp = client.ml.get_trained_models_stats()
6+
print(resp)
7+
----

‎docs/examples/9cbb097e5498a9fde39e3b1d3b62a4d2.asciidoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// ml/trained-models/apis/infer-trained-model.asciidoc:945
2+
3+
[source, python]
4+
----
5+
resp = client.ml.infer_trained_model(
6+
model_id="model2",
7+
body={
8+
"docs": [{"text_field": "This is a very happy person"}],
9+
"inference_config": {
10+
"zero_shot_classification": {
11+
"labels": ["glad", "sad", "bad", "rad"],
12+
"multi_label": False,
13+
}
14+
},
15+
},
16+
)
17+
print(resp)
18+
----

‎docs/examples/aa6282d4bc92c753c4bd7a5b166abece.asciidoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// ml/trained-models/apis/start-trained-model-deployment.asciidoc:133
2+
3+
[source, python]
4+
----
5+
resp = client.ml.start_trained_model_deployment(
6+
model_id="elastic__distilbert-base-uncased-finetuned-conll03-english",
7+
wait_for="started",
8+
timeout="1m",
9+
)
10+
print(resp)
11+
----

‎docs/examples/be6b0bfcdce1ef100af89f74da5d4748.asciidoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// ml/trained-models/apis/put-trained-model-definition-part.asciidoc:64
2+
3+
[source, python]
4+
----
5+
resp = client.ml.put_trained_model_definition_part(
6+
model_id="elastic__distilbert-base-uncased-finetuned-conll03-english",
7+
part="0",
8+
body={
9+
"definition": "...",
10+
"total_definition_length": 265632637,
11+
"total_parts": 64,
12+
},
13+
)
14+
print(resp)
15+
----

‎docs/examples/cc90639f2e65bd89cb73296cac6135cf.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// ml/trained-models/apis/delete-trained-models.asciidoc:54
2+
3+
[source, python]
4+
----
5+
resp = client.ml.delete_trained_model(
6+
model_id="regression-job-one-1574775307356",
7+
)
8+
print(resp)
9+
----

‎docs/examples/cee491dd0a8d10ed0cb11a2faa0c99f0.asciidoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// ml/trained-models/apis/infer-trained-model.asciidoc:1078
2+
3+
[source, python]
4+
----
5+
resp = client.ml.infer_trained_model(
6+
model_id="model2",
7+
body={
8+
"docs": [
9+
{
10+
"text_field": "The Amazon rainforest covers most of the Amazon basin in South America"
11+
}
12+
],
13+
"inference_config": {
14+
"ner": {"tokenization": {"bert": {"truncate": "first"}}}
15+
},
16+
},
17+
)
18+
print(resp)
19+
----

‎docs/examples/d50b030edfe6d1128eb76aa5ba9d4e27.asciidoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// ml/trained-models/apis/put-trained-models-aliases.asciidoc:94
2+
3+
[source, python]
4+
----
5+
resp = client.ml.put_trained_model_alias(
6+
model_id="flight-delay-prediction-1580004349800",
7+
model_alias="flight_delay_model",
8+
reassign="true",
9+
)
10+
print(resp)
11+
----

‎docs/examples/dbf93d02ab86a09929a21232b19709cc.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// ml/trained-models/apis/stop-trained-model-deployment.asciidoc:67
2+
3+
[source, python]
4+
----
5+
resp = client.ml.stop_trained_model_deployment(
6+
model_id="my_model_for_search",
7+
)
8+
print(resp)
9+
----

‎docs/examples/ff776c0fccf93e1c7050f7cb7efbae0b.asciidoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// ml/trained-models/apis/infer-trained-model.asciidoc:905
2+
3+
[source, python]
4+
----
5+
resp = client.ml.infer_trained_model(
6+
model_id="model2",
7+
body={
8+
"docs": [{"text_field": "Hi my name is Josh and I live in Berlin"}]
9+
},
10+
)
11+
print(resp)
12+
----

‎utils/generate-examples.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,20 @@
110110
"inference/delete-inference.asciidoc",
111111
"inference/post-inference.asciidoc",
112112
"inference/put-inference.asciidoc",
113+
"ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc",
114+
"ml/trained-models/apis/delete-trained-models-aliases.asciidoc",
115+
"ml/trained-models/apis/delete-trained-models.asciidoc",
116+
"ml/trained-models/apis/get-trained-models-stats.asciidoc",
117+
"ml/trained-models/apis/get-trained-models.asciidoc",
118+
"ml/trained-models/apis/infer-trained-model-deployment.asciidoc",
119+
"ml/trained-models/apis/infer-trained-model.asciidoc",
120+
"ml/trained-models/apis/put-trained-model-definition-part.asciidoc",
121+
"ml/trained-models/apis/put-trained-model-vocabulary.asciidoc",
122+
"ml/trained-models/apis/put-trained-models-aliases.asciidoc",
123+
"ml/trained-models/apis/put-trained-models.asciidoc",
124+
"ml/trained-models/apis/start-trained-model-deployment.asciidoc",
125+
"ml/trained-models/apis/stop-trained-model-deployment.asciidoc",
126+
"ml/trained-models/apis/update-trained-model-deployment.asciidoc",
113127
]
114128

115129

0 commit comments

Comments
 (0)