Skip to content

Commit

Permalink
Add quick description of the new function in the RTD
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthieuSchaller committed Aug 10, 2024
1 parent 7c21b00 commit 530fdf4
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/source/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,15 @@ model.
Which shows that the emulator can predict the model with
high accuracy.

Note that the `predict_values()` method also returns the estimated
variance of the values it returns. In cases where the variance is
not required, the method `predict_values_no_error()` can instead be
used. In some cases, this latter function can be much faster than the
one additionally returning the variances.


.. image:: predict_vs_model.png

This covers the most basic way to use SWIFT-Emulator and
should give a good baseline for using some of the
additional features it offers.
additional features it offers.

0 comments on commit 530fdf4

Please sign in to comment.