From f5989ba4662905ad2b475814065996fcc26061cc Mon Sep 17 00:00:00 2001
From: kohlhaasrebecca <rebecca.kohlhaas@outlook.com>
Date: Tue, 23 Jul 2024 10:04:50 +0200
Subject: [PATCH] [docs] Changed links to diagrams
---
docs/source/al_description.rst | 2 +-
docs/source/bayes_description.rst | 6 +++---
docs/source/bmc_description.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 | 4 ++--
8 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/docs/source/al_description.rst b/docs/source/al_description.rst
index 37eed69fa..3238e8b05 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:: ./docs/diagrams/active_learning_reduced.png
+.. image:: ./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 2c49ab2c6..1566c4d5a 100644
--- a/docs/source/bayes_description.rst
+++ b/docs/source/bayes_description.rst
@@ -19,7 +19,7 @@ Bayesian inference
.. container:: rightside
- .. image:: ./docs/diagrams/bayesian_validation.png
+ .. image:: ./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 78cc03d03..86a4e18e6 100644
--- a/docs/source/bmc_description.rst
+++ b/docs/source/bmc_description.rst
@@ -10,7 +10,7 @@ Bayesian multi-model comparison
.. container:: rightside
- .. image:: ./docs/diagrams/bayesian_model_comparison.png
+ .. image:: ./diagrams/bayesian_model_comparison.png
:width: 400
:alt: UML diagram for classes related to Bayesian multi-model comparison.
diff --git a/docs/source/input_description.rst b/docs/source/input_description.rst
index 04d4beede..f6cf2d3c3 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:: ./docs/diagrams/input_classes.png
+ .. image:: ./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 a275d21f8..3ec77c22d 100644
--- a/docs/source/model_description.rst
+++ b/docs/source/model_description.rst
@@ -13,7 +13,7 @@ Models
.. container:: rightside
- .. image:: ./docs/diagrams/model.png
+ .. image:: ./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 532c1e4cf..a59c08e5c 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:: ./docs/diagrams/folder_structure.png
+.. image:: ./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 1a636d681..b83380c74 100644
--- a/docs/source/post_description.rst
+++ b/docs/source/post_description.rst
@@ -12,7 +12,7 @@ Postprocessing
.. container:: rightside
- .. image:: ./docs/diagrams/postprocessing.png
+ .. image:: ./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 cbf2d9dd7..5fe446806 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:: ./docs/diagrams/metamod_training_reduced.png
+.. image:: ./diagrams/metamod_training_reduced.png
:width: 800
:alt: UML diagram for metamodel-related classes in bayesvalidrox
@@ -49,7 +49,7 @@ Other available training methods in BayesValidRox are presented in :any:`al_desc
.. container:: rightside
- .. image:: ../diagrams/engine_train_normal.png
+ .. image:: ./diagrams/engine_train_normal.png
:width: 800
:alt: Diagram of main steps in ``Engine.train_normal()``
--
GitLab