Skip to content

Commit 9cfa592

Browse files
committed
Closing OPEN-5185 Rename goals to tests [client]
1 parent 117d0b7 commit 9cfa592

File tree

11 files changed

+32
-32
lines changed

11 files changed

+32
-32
lines changed

examples/monitoring/llms/monitoring-llms.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@
237237
"id": "d00f6e8e",
238238
"metadata": {},
239239
"source": [
240-
"**That's it!** You're now able to set up goals and alerts for your production data. The next sections are optional and enable some features on the platform."
240+
"**That's it!** You're now able to set up tests and alerts for your production data. The next sections are optional and enable some features on the platform."
241241
]
242242
},
243243
{
@@ -306,7 +306,7 @@
306306
"\n",
307307
"[Back to top](#top)\n",
308308
"\n",
309-
"The ground truths are needed to create Performance goals. The `publish_ground_truths` method can be used to update the ground truths for batches of data already published to the Openlayer platform. The inference id is what gets used to merge the ground truths with the corresponding rows."
309+
"The ground truths are needed to create Performance tests. The `publish_ground_truths` method can be used to update the ground truths for batches of data already published to the Openlayer platform. The inference id is what gets used to merge the ground truths with the corresponding rows."
310310
]
311311
},
312312
{

examples/monitoring/quickstart/llms/openai_llm_monitor.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
"id": "76a350b4",
7878
"metadata": {},
7979
"source": [
80-
"That's it! Now you can continue using OpenAI LLMs normally. The data is automatically published to Openlayer and you can start creating goals around it!"
80+
"That's it! Now you can continue using OpenAI LLMs normally. The data is automatically published to Openlayer and you can start creating tests around it!"
8181
]
8282
},
8383
{

examples/monitoring/quickstart/traditional-ml/monitoring-quickstart.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@
253253
"id": "d00f6e8e",
254254
"metadata": {},
255255
"source": [
256-
"**That's it!** You're now able to set up goals and alerts for your production data. The next sections are optional and enable some features on the platform."
256+
"**That's it!** You're now able to set up tests and alerts for your production data. The next sections are optional and enable some features on the platform."
257257
]
258258
},
259259
{
@@ -337,7 +337,7 @@
337337
"\n",
338338
"[Back to top](#top)\n",
339339
"\n",
340-
"The ground truths are needed to create Performance goals. The `publish_ground_truths` method can be used to update the ground truths for batches of data already published to the Openlayer platform. The inference id is what gets used to merge the ground truths with the corresponding rows."
340+
"The ground truths are needed to create Performance tests. The `publish_ground_truths` method can be used to update the ground truths for batches of data already published to the Openlayer platform. The inference id is what gets used to merge the ground truths with the corresponding rows."
341341
]
342342
},
343343
{

examples/tabular-classification/documentation-tutorial/tabular-tutorial-part-3.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@
455455
"source": [
456456
"### <a id=\"model\">Uploading models</a>\n",
457457
"\n",
458-
"Once we're done with the consistency goals, we'll move on to performance goals, which have to do with the model itself. Therefore, now, we will upload a **full model** instead of a shell model. We will do so so that we can have explain the model's predictions on the platform using explainability techiques such as LIME and SHAP."
458+
"Once we're done with the consistency tests, we'll move on to performance tests, which have to do with the model itself. Therefore, now, we will upload a **full model** instead of a shell model. We will do so so that we can have explain the model's predictions on the platform using explainability techiques such as LIME and SHAP."
459459
]
460460
},
461461
{

examples/tabular-classification/sklearn/churn-classifier/churn-classifier-sklearn.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -785,7 +785,7 @@
785785
"outputs": [],
786786
"source": [
787787
"version.wait_for_completion()\n",
788-
"version.print_goal_report()"
788+
"version.print_test_report()"
789789
]
790790
}
791791
],

examples/text-classification/documentation-tutorial/nlp-tutorial-part-3.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@
351351
"source": [
352352
"### <a id=\"model\">Uploading models</a>\n",
353353
"\n",
354-
"Once we're done with the consistency goals, we'll move on to performance goals, which have to do with the model itself. Therefore, now, we will upload a **full model** instead of a shell model. We will do so so that we can have explain the model's predictions on the platform using explainability techiques such as LIME."
354+
"Once we're done with the consistency tests, we'll move on to performance tests, which have to do with the model itself. Therefore, now, we will upload a **full model** instead of a shell model. We will do so so that we can have explain the model's predictions on the platform using explainability techiques such as LIME."
355355
]
356356
},
357357
{
@@ -553,7 +553,7 @@
553553
"metadata": {},
554554
"outputs": [],
555555
"source": [
556-
"project.commit(\"Fix data consistency goals\")"
556+
"project.commit(\"Fix data consistency tests\")"
557557
]
558558
},
559559
{

examples/text-classification/documentation-tutorial/nlp-tutorial-part-4.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@
355355
"source": [
356356
"### <a id=\"model\">Uploading models</a>\n",
357357
"\n",
358-
"Once we're done with the consistency goals, we'll move on to performance goals, which have to do with the model itself. Therefore, now, we will upload a **full model** instead of a shell model. We will do so so that we can have explain the model's predictions on the platform using explainability techiques such as LIME."
358+
"Once we're done with the consistency tests, we'll move on to performance tests, which have to do with the model itself. Therefore, now, we will upload a **full model** instead of a shell model. We will do so so that we can have explain the model's predictions on the platform using explainability techiques such as LIME."
359359
]
360360
},
361361
{

openlayer/__init__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -806,7 +806,7 @@ def _stage_resource(
806806
def load_project_version(self, version_id: str) -> Project:
807807
"""Loads an existing project version from the Openlayer platform. Can be used
808808
to check the status of the project version and the number of passing, failing
809-
and skipped goals.
809+
and skipped tests.
810810
811811
Parameters
812812
----------
@@ -816,12 +816,12 @@ def load_project_version(self, version_id: str) -> Project:
816816
817817
.. note::
818818
When you run :obj:`push`, it will return the project version object,
819-
which you can use to check your goal statuses.
819+
which you can use to check your test statuses.
820820
821821
Returns
822822
-------
823823
:obj:`project_versions.ProjectVersion`
824-
An object that is used to check for upload progress and goal statuses.
824+
An object that is used to check for upload progress and test statuses.
825825
Also contains other useful information about a project version.
826826
827827
Examples
@@ -833,10 +833,10 @@ def load_project_version(self, version_id: str) -> Project:
833833
>>>
834834
>>> version = client.load_project_version(id='YOUR_PROJECT_ID_HERE')
835835
>>> version.wait_for_completion()
836-
>>> version.print_goal_report()
836+
>>> version.print_test_report()
837837
838838
With the :obj:`project_versions.ProjectVersion` object loaded, you are able to
839-
check progress and goal statuses.
839+
check progress and test statuses.
840840
"""
841841
endpoint = f"versions/{version_id}"
842842
version_data = self.api.get_request(endpoint)

openlayer/project_versions.py

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -68,27 +68,27 @@ def status_message(self) -> str:
6868
return self._json["statusMessage"]
6969

7070
@property
71-
def passing_goal_count(self) -> int:
72-
"""Returns the number of passing goals for the project version."""
71+
def passing_test_count(self) -> int:
72+
"""Returns the number of passing tests for the project version."""
7373
return self._json["passingGoalCount"]
7474

7575
@property
76-
def failing_goal_count(self) -> int:
77-
"""Returns the number of failing goals for the project version."""
76+
def failing_test_count(self) -> int:
77+
"""Returns the number of failing tests for the project version."""
7878
return self._json["failingGoalCount"]
7979

8080
@property
81-
def skipped_goal_count(self) -> int:
82-
"""Returns the number of failing goals for the project version."""
81+
def skipped_test_count(self) -> int:
82+
"""Returns the number of failing tests for the project version."""
8383
return (
8484
self._json["totalGoalCount"]
8585
- self._json["passingGoalCount"]
8686
- self._json["failingGoalCount"]
8787
)
8888

8989
@property
90-
def total_goal_count(self) -> int:
91-
"""Returns the number of failing goals for the project version."""
90+
def total_test_count(self) -> int:
91+
"""Returns the number of failing tests for the project version."""
9292
return self._json["totalGoalCount"]
9393

9494
def wait_for_completion(self, timeout: Optional[int] = None):
@@ -134,20 +134,20 @@ def print_status_report(self):
134134
"""Prints the status report along with its status message."""
135135
print("Status:", self.status.value, "(" + f"{self.status_message}" + ")")
136136

137-
def print_goal_report(self):
138-
"""Prints the goal results of the project version."""
137+
def print_test_report(self):
138+
"""Prints the test results of the project version."""
139139
if self.status != TaskStatus.COMPLETED:
140140
print("Project version is not complete. Nothing to print.")
141141
return
142142
print(
143143
tabulate.tabulate(
144144
[
145-
["Passed", self.passing_goal_count],
146-
["Failed", self.failing_goal_count],
147-
["Skipped", self.skipped_goal_count],
148-
["Total", self.total_goal_count],
145+
["Passed", self.passing_test_count],
146+
["Failed", self.failing_test_count],
147+
["Skipped", self.skipped_test_count],
148+
["Total", self.total_test_count],
149149
],
150-
headers=["Goals", "Count"],
150+
headers=["Tests", "Count"],
151151
tablefmt="fancy_grid",
152152
),
153153
f"\nVisit {self.links['app']} to view detailed results.",

openlayer/projects.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ def push(self, *args, **kwargs):
483483
Returns
484484
-------
485485
:obj:`ProjectVersion`
486-
An object that is used to check for upload progress and goal statuses.
486+
An object that is used to check for upload progress and test statuses.
487487
Also contains other useful information about a project version.
488488
489489
Notes

0 commit comments

Comments
 (0)