Skip to content

Commit 395b080

Browse files
authored
Merge pull request #27 from ruivieira/main
Update reference and explainers model url
2 parents 930e1ca + 89f2e54 commit 395b080

File tree

2 files changed

+508
-25
lines changed

2 files changed

+508
-25
lines changed

docs/modules/ROOT/pages/saliency-explanations-on-odh.adoc

+19-3
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,17 @@ We will use LIME as our explainer for this tutorial. More information on LIME ca
155155

156156
Request a LIME explanation for the selected inference ID.
157157

158+
[NOTE]
159+
====
160+
The URL of the model server's service must be specified in the `config.model.target` field.
161+
162+
This field only accepts model servers in the same namespace as the TrustyAI service, with or without protocol or port number.
163+
164+
- `http[s]://service[:port]`
165+
- `service[:port]`
166+
167+
====
168+
158169
[source,shell]
159170
----
160171
curl -sk -X POST -H "Authorization: Bearer ${TOKEN}" \
@@ -163,7 +174,7 @@ curl -sk -X POST -H "Authorization: Bearer ${TOKEN}" \
163174
\"predictionId\": \"$INFERENCE_ID\",
164175
\"config\": {
165176
\"model\": {
166-
\"target\": \"modelmesh-serving.${NAMESPACE}.svc.cluster.local:8033\",
177+
\"target\": \"modelmesh-serving:8033\",
167178
\"name\": \"explainer-test\",
168179
\"version\": \"v1\"
169180
}
@@ -182,7 +193,7 @@ curl -sk -X POST -H "Authorization: Bearer ${TOKEN}" \
182193
\"predictionId\": \"$INFERENCE_ID\",
183194
\"config\": {
184195
\"model\": { <1>
185-
\"target\": \"modelmesh-serving.${NAMESPACE}.svc.cluster.local:8033\",
196+
\"target\": \"modelmesh-serving:8033\",
186197
\"name\": \"explainer-test\",
187198
\"version\": \"v1\"
188199
},
@@ -196,6 +207,11 @@ curl -sk -X POST -H "Authorization: Bearer ${TOKEN}" \
196207
<1> The `model` field specifies configuration regarding the model to be used.
197208
<2> The `explainer` field specifies the configuration of the explainer itself. In this instance, the number of samples.
198209

210+
[NOTE]
211+
====
212+
A detailed reference of all supported explainer configurations can be found xref:trustyai-service-api-reference.adoc#LimeExplainerConfig[here for LIME] and xref:trustyai-service-api-reference.adoc#SHAPExplainerConfig[here for SHAP].
213+
====
214+
199215
=== Results
200216

201217
The output will show the saliency scores and confidence for each input feature used in the inference.
@@ -249,7 +265,7 @@ curl -sk -X POST -H "Authorization: Bearer ${TOKEN}" \
249265
\"predictionId\": \"$INFERENCE_ID\",
250266
\"config\": {
251267
\"model\": {
252-
\"target\": \"modelmesh-serving.${NAMESPACE}.svc.cluster.local:8033\",
268+
\"target\": \"modelmesh-serving:8033\",
253269
\"name\": \"explainer-test\",
254270
\"version\": \"v1\"
255271
},

0 commit comments

Comments
 (0)