Skip to content

Added Python ML examples to the API docs #2489

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

Merged
merged 6 commits into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
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
22 changes: 22 additions & 0 deletions docs/examples/095e3f21941a9cc75f398389a075152d.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// ml/trained-models/apis/infer-trained-model.asciidoc:1043

[source, python]
----
resp = client.ml.infer_trained_model(
model_id="cross-encoder__ms-marco-tinybert-l-2-v2",
body={
"docs": [
{
"text_field": "Berlin has a population of 3,520,031 registered inhabitants in an area of 891.82 square kilometers."
},
{
"text_field": "New York City is famous for the Metropolitan Museum of Art."
},
],
"inference_config": {
"text_similarity": {"text": "How many people live in Berlin?"}
},
},
)
print(resp)
----
12 changes: 12 additions & 0 deletions docs/examples/0e5d25c7bb738c42d471020d678e2966.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// ml/trained-models/apis/start-trained-model-deployment.asciidoc:173

[source, python]
----
resp = client.ml.start_trained_model_deployment(
model_id="my_model",
deployment_id="my_model_for_ingest",
wait_for="started",
timeout="1m",
)
print(resp)
----
10 changes: 10 additions & 0 deletions docs/examples/147d341cb212dcc015c129a9c5dcf9c9.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// ml/trained-models/apis/put-trained-models-aliases.asciidoc:82

[source, python]
----
resp = client.ml.put_trained_model_alias(
model_id="flight-delay-prediction-1574775339910",
model_alias="flight_delay_model",
)
print(resp)
----
10 changes: 10 additions & 0 deletions docs/examples/2d633b7f346b828d01f923ce9dbf6ad5.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// ml/trained-models/apis/put-trained-model-vocabulary.asciidoc:63

[source, python]
----
resp = client.ml.put_trained_model_vocabulary(
model_id="elastic__distilbert-base-uncased-finetuned-conll03-english",
body={"vocabulary": ["[PAD]", "[unused0]", ...]},
)
print(resp)
----
16 changes: 16 additions & 0 deletions docs/examples/35a272df8c919a12d7c3106a18245748.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// ml/trained-models/apis/infer-trained-model.asciidoc:849

[source, python]
----
resp = client.ml.infer_trained_model(
model_id="lang_ident_model_1",
body={
"docs": [
{
"text": "The fool doth think he is wise, but the wise man knows himself to be a fool."
}
]
},
)
print(resp)
----
15 changes: 15 additions & 0 deletions docs/examples/3c345feb7c52fd54bcb5d5505fd8bc3b.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// ml/trained-models/apis/infer-trained-model.asciidoc:1008

[source, python]
----
resp = client.ml.infer_trained_model(
model_id="model2",
body={
"docs": [{"text_field": "<long text to extract answer>"}],
"inference_config": {
"question_answering": {"question": "<question to be answered>"}
},
},
)
print(resp)
----
7 changes: 7 additions & 0 deletions docs/examples/4c174e228b6b74497b73ef2be80de7ad.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// ml/trained-models/apis/get-trained-models.asciidoc:1460

[source, python]
----
resp = client.ml.get_trained_models()
print(resp)
----
10 changes: 10 additions & 0 deletions docs/examples/5837d5f50665ac0a26181d3aaeb3f204.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// ml/trained-models/apis/start-trained-model-deployment.asciidoc:181

[source, python]
----
resp = client.ml.start_trained_model_deployment(
model_id="my_model",
deployment_id="my_model_for_search",
)
print(resp)
----
10 changes: 10 additions & 0 deletions docs/examples/776b553df0e507c96dbdbaedecaca0cc.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// ml/trained-models/apis/infer-trained-model.asciidoc:880

[source, python]
----
resp = client.ml.infer_trained_model(
model_id="model2",
body={"docs": [{"text_field": "The movie was awesome!!"}]},
)
print(resp)
----
9 changes: 9 additions & 0 deletions docs/examples/7e4cb3de3e3c75646b60f9f81ddc59cc.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc:43

[source, python]
----
resp = client.ml.clear_trained_model_deployment_cache(
model_id="elastic__distilbert-base-uncased-finetuned-conll03-english",
)
print(resp)
----
10 changes: 10 additions & 0 deletions docs/examples/821422f8a03dc98d024a15fc737fe9eb.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// ml/trained-models/apis/delete-trained-models-aliases.asciidoc:51

[source, python]
----
resp = client.ml.delete_trained_model_alias(
model_id="flight-delay-prediction-1574775339910",
model_alias="flight_delay_model",
)
print(resp)
----
7 changes: 7 additions & 0 deletions docs/examples/9225841fdcddaf83ebdb90c2b0399e20.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// ml/trained-models/apis/get-trained-models-stats.asciidoc:405

[source, python]
----
resp = client.ml.get_trained_models_stats()
print(resp)
----
18 changes: 18 additions & 0 deletions docs/examples/9cbb097e5498a9fde39e3b1d3b62a4d2.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// ml/trained-models/apis/infer-trained-model.asciidoc:945

[source, python]
----
resp = client.ml.infer_trained_model(
model_id="model2",
body={
"docs": [{"text_field": "This is a very happy person"}],
"inference_config": {
"zero_shot_classification": {
"labels": ["glad", "sad", "bad", "rad"],
"multi_label": False,
}
},
},
)
print(resp)
----
11 changes: 11 additions & 0 deletions docs/examples/aa6282d4bc92c753c4bd7a5b166abece.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// ml/trained-models/apis/start-trained-model-deployment.asciidoc:133

[source, python]
----
resp = client.ml.start_trained_model_deployment(
model_id="elastic__distilbert-base-uncased-finetuned-conll03-english",
wait_for="started",
timeout="1m",
)
print(resp)
----
15 changes: 15 additions & 0 deletions docs/examples/be6b0bfcdce1ef100af89f74da5d4748.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// ml/trained-models/apis/put-trained-model-definition-part.asciidoc:64

[source, python]
----
resp = client.ml.put_trained_model_definition_part(
model_id="elastic__distilbert-base-uncased-finetuned-conll03-english",
part="0",
body={
"definition": "...",
"total_definition_length": 265632637,
"total_parts": 64,
},
)
print(resp)
----
9 changes: 9 additions & 0 deletions docs/examples/cc90639f2e65bd89cb73296cac6135cf.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// ml/trained-models/apis/delete-trained-models.asciidoc:54

[source, python]
----
resp = client.ml.delete_trained_model(
model_id="regression-job-one-1574775307356",
)
print(resp)
----
19 changes: 19 additions & 0 deletions docs/examples/cee491dd0a8d10ed0cb11a2faa0c99f0.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// ml/trained-models/apis/infer-trained-model.asciidoc:1078

[source, python]
----
resp = client.ml.infer_trained_model(
model_id="model2",
body={
"docs": [
{
"text_field": "The Amazon rainforest covers most of the Amazon basin in South America"
}
],
"inference_config": {
"ner": {"tokenization": {"bert": {"truncate": "first"}}}
},
},
)
print(resp)
----
11 changes: 11 additions & 0 deletions docs/examples/d50b030edfe6d1128eb76aa5ba9d4e27.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// ml/trained-models/apis/put-trained-models-aliases.asciidoc:94

[source, python]
----
resp = client.ml.put_trained_model_alias(
model_id="flight-delay-prediction-1580004349800",
model_alias="flight_delay_model",
reassign="true",
)
print(resp)
----
9 changes: 9 additions & 0 deletions docs/examples/dbf93d02ab86a09929a21232b19709cc.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// ml/trained-models/apis/stop-trained-model-deployment.asciidoc:67

[source, python]
----
resp = client.ml.stop_trained_model_deployment(
model_id="my_model_for_search",
)
print(resp)
----
12 changes: 12 additions & 0 deletions docs/examples/ff776c0fccf93e1c7050f7cb7efbae0b.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// ml/trained-models/apis/infer-trained-model.asciidoc:905

[source, python]
----
resp = client.ml.infer_trained_model(
model_id="model2",
body={
"docs": [{"text_field": "Hi my name is Josh and I live in Berlin"}]
},
)
print(resp)
----
14 changes: 14 additions & 0 deletions utils/generate-examples.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,20 @@
"inference/delete-inference.asciidoc",
"inference/post-inference.asciidoc",
"inference/put-inference.asciidoc",
"ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc",
"ml/trained-models/apis/delete-trained-models-aliases.asciidoc",
"ml/trained-models/apis/delete-trained-models.asciidoc",
"ml/trained-models/apis/get-trained-models-stats.asciidoc",
"ml/trained-models/apis/get-trained-models.asciidoc",
"ml/trained-models/apis/infer-trained-model-deployment.asciidoc",
"ml/trained-models/apis/infer-trained-model.asciidoc",
"ml/trained-models/apis/put-trained-model-definition-part.asciidoc",
"ml/trained-models/apis/put-trained-model-vocabulary.asciidoc",
"ml/trained-models/apis/put-trained-models-aliases.asciidoc",
"ml/trained-models/apis/put-trained-models.asciidoc",
"ml/trained-models/apis/start-trained-model-deployment.asciidoc",
"ml/trained-models/apis/stop-trained-model-deployment.asciidoc",
"ml/trained-models/apis/update-trained-model-deployment.asciidoc",
]


Expand Down