Merge branch 'main' into docs

Giskard-AI · Jul 22, 2024 · 7645f8e · 7645f8e
2 parents 7aea4e9 + b724425
commit 7645f8e
Show file tree

Hide file tree

Showing 7 changed files with 6 additions and 29 deletions.
diff --git a/script-docs/_static/guide/local_eval_conv.png b/script-docs/_static/guide/local_eval_conv.png
diff --git a/script-docs/_static/quickstart/api_key.png b/script-docs/_static/quickstart/api_key.png
diff --git a/script-docs/_static/quickstart/dataset_conversation.png b/script-docs/_static/quickstart/dataset_conversation.png
diff --git a/script-docs/_static/quickstart/new_project.png b/script-docs/_static/quickstart/new_project.png
diff --git a/script-docs/guide/local-evaluation.rst b/script-docs/guide/local-evaluation.rst
@@ -98,7 +98,7 @@ We can now launch the evaluation run:
 
 .. code-block:: python
 
-    eval_run = evaluation = hub.evaluate(
+    eval_run = hub.evaluate(
         model=my_local_bot,
         dataset=dataset_id,
         # optionally, specify a name
@@ -124,9 +124,4 @@ the evaluation run to complete and then print the results:
     Evaluation metrics output
 
 You can also check the results in the Hub interface and compare it with other
-evaluation runs. For example, you can inspect each conversation and see the:
-
-.. figure:: ../_static/guide/local_eval_conv.png
-
-    Example of conversation evaluation. Note that our "echo" agent was used to
-    generate the response.
+evaluation runs.
diff --git a/script-docs/guide/run-evaluations.rst b/script-docs/guide/run-evaluations.rst
@@ -76,15 +76,15 @@ We can now launch the evaluation run:
 
 .. code-block:: python
 
-    eval_run = evaluation = hub.evaluate(
+    eval_run = hub.evaluate(
         model=model.id,
         dataset=dataset_id
         # optionally, specify a name
         name="staging-build-a4f321",
     )
 
 
-The evaluation run will be queued and processed by the Hub. The ``evalute``
+The evaluation run will be queued and processed by the Hub. The ``evaluate``
 method will immediately return an :class:`~giskard_hub.data.EvaluationRun` object
 while the evaluation is running. Note however that this object will not contain
 the evaluation results until the evaluation is completed.

diff --git a/script-docs/quickstart.rst b/script-docs/quickstart.rst
@@ -19,12 +19,6 @@ Get your API key
 Head over to your Giskard Hub instance and click on the user icon in the top right corner. You will find your personal
 API key, click on the button to copy it.
 
-.. image:: /_static/quickstart/api_key.png
-   :width: 779px
-   :scale: 50%
-   :align: center
-   :alt: ""
-
 .. note::
 
    If you don't see your API key in the UI, it means your administrator has not enabled API keys. Please contact them to get one. 
@@ -79,12 +73,7 @@ Create a project
         description="This is a test project to get started with the Giskard Hub client library",
     )
 
-That's it! You have created a project. You will now see it in the Hub UI project selector:
-
-.. image:: /_static/quickstart/new_project.png
-   :scale: 50%
-   :align: center
-   :alt: ""
+That's it! You have created a project.
 
 .. tip::
 
@@ -139,13 +128,6 @@ These are the attributes you can set for a conversation (the only required attri
 You can add as many conversations as you want to the dataset.
 
 
-Again, you'll find your newly created dataset in the Hub UI:
-
-.. image:: /_static/quickstart/dataset_conversation.png
-   :align: center
-   :alt: ""
-
-
 Configure a model
 -----------------
 
@@ -198,7 +180,7 @@ If all is working well, this will return something like
 Run a remote evaluation
 -----------------------
 
-We can now lunch a remote evaluation of our model!
+We can now launch a remote evaluation of our model!
 
 .. code-block:: python