From 865cc335b27550dddada5b3e1a31df7fc4704502 Mon Sep 17 00:00:00 2001 From: Matteo Dora Date: Mon, 1 Jul 2024 17:39:07 +0200 Subject: [PATCH] Fix typos in the doc --- script-docs/guide/local-evaluation.rst | 2 +- script-docs/guide/run-evaluations.rst | 4 ++-- script-docs/quickstart.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/script-docs/guide/local-evaluation.rst b/script-docs/guide/local-evaluation.rst index 9d7d13b..37da812 100644 --- 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 diff --git a/script-docs/guide/run-evaluations.rst b/script-docs/guide/run-evaluations.rst index c52c557..44b1673 100644 --- a/script-docs/guide/run-evaluations.rst +++ b/script-docs/guide/run-evaluations.rst @@ -76,7 +76,7 @@ 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 @@ -84,7 +84,7 @@ We can now launch the evaluation run: ) -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 index 01c6ed8..24dbc1f 100644 --- a/script-docs/quickstart.rst +++ b/script-docs/quickstart.rst @@ -198,7 +198,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