From e726ecbe4a3ecf49e50439666abe0585f8682790 Mon Sep 17 00:00:00 2001
From: kohlhaasrebecca <rebecca.kohlhaas@outlook.com>
Date: Fri, 19 Jul 2024 09:26:47 +0200
Subject: [PATCH] [docs] Change links to diagrams
---
docs/source/al_description.rst | 2 +-
docs/source/bayes_description.rst | 6 +++---
docs/source/bmc_description.rst | 2 +-
docs/source/index.rst | 2 +-
docs/source/input_description.rst | 4 ++--
docs/source/model_description.rst | 2 +-
docs/source/packagedescription.rst | 2 +-
docs/source/post_description.rst | 4 ++--
docs/source/surrogate_description.rst | 2 +-
9 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/docs/source/al_description.rst b/docs/source/al_description.rst
index 4b3ce9859..37eed69fa 100644
--- a/docs/source/al_description.rst
+++ b/docs/source/al_description.rst
@@ -7,7 +7,7 @@ The relevant functions are contained in the class :any:`bayesvalidrox.surrogate_
.. warning::
Exploration with 'voronoi' is disabled for release v1.1.0!
-.. image:: ../diagrams/active_learning_reduced.png
+.. image:: ./docs/diagrams/active_learning_reduced.png
:width: 550
:alt: UML diagram for the classes and functions used in active learning in BayesValidRox.
diff --git a/docs/source/bayes_description.rst b/docs/source/bayes_description.rst
index 5017bceea..2c49ab2c6 100644
--- a/docs/source/bayes_description.rst
+++ b/docs/source/bayes_description.rst
@@ -19,7 +19,7 @@ Bayesian inference
.. container:: rightside
- .. image:: ../diagrams/bayesian_validation.png
+ .. image:: ./docs/diagrams/bayesian_validation.png
:width: 300
:alt: UML diagram for classes related to Bayesian inference.
@@ -115,11 +115,11 @@ For inference with MCMC, chain diagnostics are also written out in the console.
.. container:: rightside
- .. image:: ../../examples/user_guide/Outputs_Bayes_model_Calib/Posterior_Dist_model_emulator.pdf
+ .. image:: ./examples/user_guide/Outputs_Bayes_model_Calib/Posterior_Dist_model_emulator.pdf
:width: 400
:alt: Posterior distribution of the input parameter
- .. image:: ../../examples/user_guide/Outputs_Bayes_model_Calib/Post_Prior_Perd_model_emulator_A.pdf
+ .. image:: ./examples/user_guide/Outputs_Bayes_model_Calib/Post_Prior_Perd_model_emulator_A.pdf
:width: 400
:alt: Comparison of posterior prediction to the observation
\ No newline at end of file
diff --git a/docs/source/bmc_description.rst b/docs/source/bmc_description.rst
index 3ebd9d525..78cc03d03 100644
--- a/docs/source/bmc_description.rst
+++ b/docs/source/bmc_description.rst
@@ -10,7 +10,7 @@ Bayesian multi-model comparison
.. container:: rightside
- .. image:: ../diagrams/bayesian_model_comparison.png
+ .. image:: ./docs/diagrams/bayesian_model_comparison.png
:width: 400
:alt: UML diagram for classes related to Bayesian multi-model comparison.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 8671dc83e..bcf65d14c 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -5,7 +5,7 @@ Surrogate-assisted Bayesian validation of computational models
==============================================================
**BayesValidRox** is an open-source python package that provides methods for surrogate modeling, Bayesian inference and model comparison.
-.. image:: ../diagrams/balance.png
+.. image:: ./docs/diagrams/balance.png
:width: 600
:alt: Weighting model results against data with associated uncertainty, costs and sparsity
diff --git a/docs/source/input_description.rst b/docs/source/input_description.rst
index ee506fc23..04d4beede 100644
--- a/docs/source/input_description.rst
+++ b/docs/source/input_description.rst
@@ -18,7 +18,7 @@ This uncertainty can be described as probability distributions over possible val
.. container:: rightside
- .. image:: ../diagrams/input_classes.png
+ .. image:: ./docs/diagrams/input_classes.png
:width: 300
:alt: UML diagram for input-related classes in bayesvalidrox
@@ -76,6 +76,6 @@ The generated samples can be visualized against their marginal distributions.
The results will be saved in the folder ``Outputs_Priors``.
-.. image:: ../../examples/user_guide/Outputs_Priors/prior_$X$.png
+.. image:: ./examples/user_guide/Outputs_Priors/prior_$X$.png
:width: 400
:alt: Generated samples against their marginal distribution
diff --git a/docs/source/model_description.rst b/docs/source/model_description.rst
index 42103caa6..a275d21f8 100644
--- a/docs/source/model_description.rst
+++ b/docs/source/model_description.rst
@@ -13,7 +13,7 @@ Models
.. container:: rightside
- .. image:: ../diagrams/model.png
+ .. image:: ./docs/diagrams/model.png
:width: 150
:alt: UML diagram for the bayesvalidrox class :any:`bayesvalidrox.pylink.pylink.PyLinkForwardModel`.
diff --git a/docs/source/packagedescription.rst b/docs/source/packagedescription.rst
index 1d1fd6517..532c1e4cf 100644
--- a/docs/source/packagedescription.rst
+++ b/docs/source/packagedescription.rst
@@ -34,7 +34,7 @@ Overview
This package is split into multiple aspects corresponding to its folder structure.
-.. image:: ../diagrams/folder_structure.png
+.. image:: ./docs/diagrams/folder_structure.png
:width: 600
:alt: Folder structure of **bayesvalidrox**
diff --git a/docs/source/post_description.rst b/docs/source/post_description.rst
index 987f18e7d..1a636d681 100644
--- a/docs/source/post_description.rst
+++ b/docs/source/post_description.rst
@@ -12,7 +12,7 @@ Postprocessing
.. container:: rightside
- .. image:: ../diagrams/postprocessing.png
+ .. image:: ./docs/diagrams/postprocessing.png
:width: 300
:alt: UML diagram for the classes and functions used in active learning in BayesValidRox.
@@ -60,7 +60,7 @@ The visual comparison of model and metamodel results is saved in the folder ``Ou
.. container:: rightside
- .. image:: ../../examples/user_guide/Outputs_PostProcessing_calib/Model_vs_PCEModel_y_1.pdf
+ .. image:: ./examples/user_guide/Outputs_PostProcessing_calib/Model_vs_PCEModel_y_1.pdf
:width: 400
:alt: Visual comparison of model and metamodel outputs
\ No newline at end of file
diff --git a/docs/source/surrogate_description.rst b/docs/source/surrogate_description.rst
index 2a1da4b3f..cbf2d9dd7 100644
--- a/docs/source/surrogate_description.rst
+++ b/docs/source/surrogate_description.rst
@@ -8,7 +8,7 @@ We call this dataset the training data, with training samples :math:`(x_i)_{i=1,
BayesValidRox creates surrogate models as objects of the class :any:`bayesvalidrox.surrogate_models.surrogate_models.MetaModel`.
Training is performed by the class :any:`bayesvalidrox.surrogate_models.engine.Engine`.
-.. image:: ../diagrams/metamod_training_reduced.png
+.. image:: ./docs/diagrams/metamod_training_reduced.png
:width: 800
:alt: UML diagram for metamodel-related classes in bayesvalidrox
--
GitLab