diff --git a/src/ansys/simai/core/data/models.py b/src/ansys/simai/core/data/models.py index d62e63f..66bdbfa 100644 --- a/src/ansys/simai/core/data/models.py +++ b/src/ansys/simai/core/data/models.py @@ -114,17 +114,17 @@ def cancel_build(self, model: Identifiable[Model]): """Cancel an ongoing build given the model. Args: - model: a model object or model id whose ongoing build to cancel + model: a model object whose ongoing build to cancel. + Returns: + ``True`` if ``is_being_trained=False`` in JSON response after successful cancellation. + + Example: .. code-block:: python - simai.models.cancel_build(new_model) + build_cancelled = simai.models.cancel_build(new_model) """ model_object = get_object_from_identifiable(model, self._client.models) response = self._client._api.cancel_build(model_object.project_id) - return ( - "Build cancelled" - if not response.get("is_being_trained") - else "Build cancellation unsuccessful, training in progress" - ) + return not response.get("is_being_trained") diff --git a/tests/test_models.py b/tests/test_models.py index 38444f9..4ab8eb2 100644 --- a/tests/test_models.py +++ b/tests/test_models.py @@ -666,4 +666,4 @@ def test_cancel_existing_build(simai_client, model_factory): response = simai_client.models.cancel_build(new_model) assert len(responses.calls) == 1 - assert response == "Build cancelled" + assert response is True