Skip to content

Commit f9d521a

Browse files
committed
Tweaks as a result of QE feedback
1 parent ca564c6 commit f9d521a

File tree

3 files changed

+23
-27
lines changed

3 files changed

+23
-27
lines changed

modules/setting-up-lmeval.adoc

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ The following information explains how to create an `LMEvalJob` custom resource
1616

1717
ifdef::upstream[]
1818
[NOTE]
19-
2019
--
2120
LM-Eval is only available in the latest community builds. To use LM-Eval on {productname-long}, ensure that you use ODH 2.20 or later versions and add the following `devFlag` to your `DataScienceCluster` resource:
2221
[source]
@@ -84,21 +83,7 @@ You can configure the following properties for LM-Eval:
8483
8584
After updating the settings in the `ConfigMap`, restart the operator to apply the new values.
8685
87-
// Notes on the 'allow online' setting and patches
88-
89-
// upstream - allowOnline setting is enabled; end-user can disable if they wish.
90-
ifdef::upstream[]
91-
[IMPORTANT]
92-
--
93-
The `allowOnline` setting is enabled by default in {productname-long}. Using `allowOnline` gives the job permissions to automatically download artifacts from external sources. Change this setting to `false` if you do not want LM-Eval to access external sources.
94-
--
95-
endif::[]
96-
97-
// downstream - allowOnline is disabled; end-user needs include a patch in the ConfigMap in order to enable it.
98-
99-
ifndef::upstream[]
10086
[IMPORTANT]
10187
--
10288
The `allowOnline` and `allowCodeExecution` settings are *disabled* by default at the operator level in {productname-long}. LMEval jobs do not have internet access or permission to run any externally downloaded code unless explicitly enabled.
10389
--
104-
endif::[]

modules/updating-lmeval-job-configuration-using-the-cli.adoc

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ oc patch configmap trustyai-service-operator-config -n redhat-ods-applications \
5959
--type merge -p '{"data":{"lmes-allow-online":"true","lmes-allow-code-execution":"true"}}'
6060
----
6161
+
62-
.trustyai-service-operator-config configuration keys for LMEval job access
62+
.trustyai-service-operator-config configuration keys for LMEval job access
6363
[cols="3,2,5", options="header"]
6464
|===
6565
| ConfigMap Key
@@ -80,19 +80,30 @@ oc patch configmap trustyai-service-operator-config -n redhat-ods-applications \
8080
----
8181
oc rollout restart deployment trustyai-service-operator-controller-manager -n redhat-ods-applications
8282
----
83-
. Set the flags on your `LMEvalJob` resource:
84-
+
85-
[source,sh]
86-
----
87-
oc rollout restart deployment trustyai-service-operator-controller-manager -n redhat-ods-applications
88-
----
8983
. Enable online access or code execution or both on specific `LMEvalJob` resources:
84+
85+
.. For LMEval Jobs that already exist, apply the following patch:
9086
+
9187
[source,sh]
9288
----
93-
oc patch lmevaljobs example-lmeval -n <user-or-target-namespace> \
89+
oc patch lmevaljobs example-lmeval -n <user-or-target-namespace > \
9490
--type merge -p '{"spec":{"allowOnline":true,"allowCodeExecution":true}}'
95-
96-
oc get lmevaljobs example-lmeval -n <user-or-target-namespace> \
91+
oc get lmevaljobs example-lmeval -n <user-or-target-namespace > \
9792
-o jsonpath='{.spec.allowOnline}{"\n"}{.spec.allowCodeExecution}{"\n"}'
9893
----
94+
95+
.. For new LMEval Jobs, apply a YAML that includes the following fields:
96+
[source,yaml]
97+
----
98+
apiVersion: trustyai.opendatahub.io/v1alpha1
99+
kind: LMEvalJob
100+
metadata:
101+
name: example-lmeval
102+
spec:
103+
allowOnline: true
104+
allowCodeExecution: true
105+
106+
----
107+
108+
109+

modules/updating-lmeval-job-configuration-using-the-console.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ lmes-allow-code-execution: "true"
5050
--
5151
Each LMEval Job must explicitly be set to allow online access and code execution.
5252
--
53-
. Add the following fields to the `LMEvalJob` to enable online access and code execution for this job:
54-
53+
.
54+
Ensure that the following fields are set to 'true' to enable online access and code execution for this job when writing your `LMEvalJob` custom resource:
5555
[source,yaml]
5656
----
5757
apiVersion: trustyai.opendatahub.io/v1alpha1

0 commit comments

Comments
 (0)