From b8e3afa8264d00a080eb8e11384044f13917d0f3 Mon Sep 17 00:00:00 2001
From: kohlhaasrebecca <rebecca.kohlhaas@outlook.com>
Date: Thu, 25 Jan 2024 16:24:17 +0100
Subject: [PATCH] Cleaned comments
---
examples/OHagan-function/example_OHagan.py | 2 --
examples/beam/example_beam.py | 2 --
examples/ishigami/example_ishigami.py | 2 --
examples/model-comparison/example_model_comparison.py | 2 --
examples/pollution/example_valid_pollution.py | 2 --
src/bayesvalidrox/bayes_inference/bayes_model_comparison.py | 4 ----
src/bayesvalidrox/pylink/pylink.py | 4 ++++
src/bayesvalidrox/surrogate_models/engine.py | 4 +---
src/bayesvalidrox/surrogate_models/exp_designs.py | 3 +++
src/bayesvalidrox/surrogate_models/exploration.py | 3 +++
src/bayesvalidrox/surrogate_models/input_space.py | 3 +++
src/bayesvalidrox/surrogate_models/inputs.py | 3 +++
src/bayesvalidrox/surrogate_models/surrogate_models.py | 3 +++
tests/test_Discrepancy.py | 1 -
tests/test_ExpDesign.py | 1 -
tests/test_InputSpace.py | 1 -
tests/test_MetaModel.py | 2 --
tests/test_engine.py | 1 -
tests/test_polyconst.py | 1 -
tests/test_pylink.py | 1 -
20 files changed, 20 insertions(+), 25 deletions(-)
diff --git a/examples/OHagan-function/example_OHagan.py b/examples/OHagan-function/example_OHagan.py
index 170014ab5..8c7690767 100644
--- a/examples/OHagan-function/example_OHagan.py
+++ b/examples/OHagan-function/example_OHagan.py
@@ -16,8 +16,6 @@ of Stuttgart, www.iws.uni-stuttgart.de/lh2/
Pfaffenwaldring 61
70569 Stuttgart
-Created on Wed Jul 10 2019
-
"""
import numpy as np
diff --git a/examples/beam/example_beam.py b/examples/beam/example_beam.py
index 04d19518f..84b88255f 100644
--- a/examples/beam/example_beam.py
+++ b/examples/beam/example_beam.py
@@ -13,8 +13,6 @@ of Stuttgart www.iws.uni-stuttgart.de/lh2/
Pfaffenwaldring 61
70569 Stuttgart
-Created on Wed Jul 10 2019
-
"""
# Add BayesValidRox path
import sys
diff --git a/examples/ishigami/example_ishigami.py b/examples/ishigami/example_ishigami.py
index 1f3c7f80a..72c9dc2d3 100644
--- a/examples/ishigami/example_ishigami.py
+++ b/examples/ishigami/example_ishigami.py
@@ -15,8 +15,6 @@ of Stuttgart, www.iws.uni-stuttgart.de/lh2/
Pfaffenwaldring 61
70569 Stuttgart
-Created on Wed Jul 10 2019
-
"""
import numpy as np
diff --git a/examples/model-comparison/example_model_comparison.py b/examples/model-comparison/example_model_comparison.py
index 884b0d52a..ebd80fea8 100644
--- a/examples/model-comparison/example_model_comparison.py
+++ b/examples/model-comparison/example_model_comparison.py
@@ -14,8 +14,6 @@ University of Stuttgart, www.iws.uni-stuttgart.de/lh2/
Pfaffenwaldring 61
70569 Stuttgart
-Created on Wed Oct 10 2021
-
"""
from copy import deepcopy
diff --git a/examples/pollution/example_valid_pollution.py b/examples/pollution/example_valid_pollution.py
index 334e80e8c..74b87787b 100644
--- a/examples/pollution/example_valid_pollution.py
+++ b/examples/pollution/example_valid_pollution.py
@@ -13,8 +13,6 @@ of Stuttgart, www.iws.uni-stuttgart.de/lh2/
Pfaffenwaldring 61
70569 Stuttgart
-Created on Fri Aug 9 2019
-
"""
import numpy as np
diff --git a/src/bayesvalidrox/bayes_inference/bayes_model_comparison.py b/src/bayesvalidrox/bayes_inference/bayes_model_comparison.py
index b946281c5..828613556 100644
--- a/src/bayesvalidrox/bayes_inference/bayes_model_comparison.py
+++ b/src/bayesvalidrox/bayes_inference/bayes_model_comparison.py
@@ -1,10 +1,6 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
-"""
-Created on Sat Aug 24 16:04:06 2019
-@author: farid
-"""
import numpy as np
import os
from scipy import stats
diff --git a/src/bayesvalidrox/pylink/pylink.py b/src/bayesvalidrox/pylink/pylink.py
index 8b826c5ce..5084f1cf1 100644
--- a/src/bayesvalidrox/pylink/pylink.py
+++ b/src/bayesvalidrox/pylink/pylink.py
@@ -1,5 +1,9 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
+"""
+Calls to the model and evaluations
+"""
+
from dataclasses import dataclass
import os
diff --git a/src/bayesvalidrox/surrogate_models/engine.py b/src/bayesvalidrox/surrogate_models/engine.py
index 85865c219..57d92aca0 100644
--- a/src/bayesvalidrox/surrogate_models/engine.py
+++ b/src/bayesvalidrox/surrogate_models/engine.py
@@ -1,9 +1,7 @@
# -*- coding: utf-8 -*-
"""
-Created on Sat Dec 16 10:16:50 2023
-Engine to train the surrogate with
+Engine to train the surrogate
-@author: Rebecca Kohlhaas
"""
import copy
from copy import deepcopy, copy
diff --git a/src/bayesvalidrox/surrogate_models/exp_designs.py b/src/bayesvalidrox/surrogate_models/exp_designs.py
index 665ee4fc3..4d719654b 100644
--- a/src/bayesvalidrox/surrogate_models/exp_designs.py
+++ b/src/bayesvalidrox/surrogate_models/exp_designs.py
@@ -1,5 +1,8 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
+"""
+Experimental design with associated sampling methods
+"""
import numpy as np
import math
diff --git a/src/bayesvalidrox/surrogate_models/exploration.py b/src/bayesvalidrox/surrogate_models/exploration.py
index e18537207..6abb652f1 100644
--- a/src/bayesvalidrox/surrogate_models/exploration.py
+++ b/src/bayesvalidrox/surrogate_models/exploration.py
@@ -1,5 +1,8 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
+"""
+Exploration for sequential training of metamodels
+"""
import numpy as np
from scipy.spatial import distance
diff --git a/src/bayesvalidrox/surrogate_models/input_space.py b/src/bayesvalidrox/surrogate_models/input_space.py
index 3160ba2d0..4e010d66f 100644
--- a/src/bayesvalidrox/surrogate_models/input_space.py
+++ b/src/bayesvalidrox/surrogate_models/input_space.py
@@ -1,5 +1,8 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
+"""
+Input space built from set prior distributions
+"""
import numpy as np
import chaospy
diff --git a/src/bayesvalidrox/surrogate_models/inputs.py b/src/bayesvalidrox/surrogate_models/inputs.py
index 783e82b05..094e1066f 100644
--- a/src/bayesvalidrox/surrogate_models/inputs.py
+++ b/src/bayesvalidrox/surrogate_models/inputs.py
@@ -1,5 +1,8 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
+"""
+Inputs and related marginal distributions
+"""
class Input:
"""
diff --git a/src/bayesvalidrox/surrogate_models/surrogate_models.py b/src/bayesvalidrox/surrogate_models/surrogate_models.py
index af20e9814..a64a4dc31 100644
--- a/src/bayesvalidrox/surrogate_models/surrogate_models.py
+++ b/src/bayesvalidrox/surrogate_models/surrogate_models.py
@@ -1,5 +1,8 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
+"""
+Implementation of metamodel as either PC, aPC or GPE
+"""
import warnings
import numpy as np
diff --git a/tests/test_Discrepancy.py b/tests/test_Discrepancy.py
index 89ff73f10..c46e0a137 100644
--- a/tests/test_Discrepancy.py
+++ b/tests/test_Discrepancy.py
@@ -5,7 +5,6 @@ Tests are available for the following functions
Class Discrepancy:
get_sample
-@author: Rebecca Kohlhaas
"""
import sys
sys.path.append("src/")
diff --git a/tests/test_ExpDesign.py b/tests/test_ExpDesign.py
index d2e9aebe1..42f87663c 100644
--- a/tests/test_ExpDesign.py
+++ b/tests/test_ExpDesign.py
@@ -13,7 +13,6 @@ Class ExpDesigns:
pcm_sampler
Other function tests to be found in parent class 'InputSpace'
-@author: Rebecca Kohlhaas
"""
import sys
sys.path.append("src/")
diff --git a/tests/test_InputSpace.py b/tests/test_InputSpace.py
index f02ce3897..1b5a28fa3 100644
--- a/tests/test_InputSpace.py
+++ b/tests/test_InputSpace.py
@@ -8,7 +8,6 @@ Class InputSpace:
build_polytypes - x
transform - x
-@author: Rebecca Kohlhaas
"""
import sys
sys.path.append("src/")
diff --git a/tests/test_MetaModel.py b/tests/test_MetaModel.py
index a2fb876e2..b5095fa34 100644
--- a/tests/test_MetaModel.py
+++ b/tests/test_MetaModel.py
@@ -24,8 +24,6 @@ Class MetaModel:
generate_polynomials
_compute_pce_moments
-
-@author: Rebecca Kohlhaas
"""
import numpy as np
import sys
diff --git a/tests/test_engine.py b/tests/test_engine.py
index 36e582cf2..72dabd466 100644
--- a/tests/test_engine.py
+++ b/tests/test_engine.py
@@ -27,7 +27,6 @@ Engine:
_validError - x
_error_Mean_Std - x
-@author: Rebecca Kohlhaas
"""
import math
import numpy as np
diff --git a/tests/test_polyconst.py b/tests/test_polyconst.py
index 7b05429f9..f831cd5a1 100644
--- a/tests/test_polyconst.py
+++ b/tests/test_polyconst.py
@@ -6,7 +6,6 @@ Tests are available for the following functions:
glexindex
cross_truncate
-@author: Rebecca Kohlhaas
"""
import sys
sys.path.append("src/")
diff --git a/tests/test_pylink.py b/tests/test_pylink.py
index 870e3400b..47cc27081 100644
--- a/tests/test_pylink.py
+++ b/tests/test_pylink.py
@@ -16,7 +16,6 @@ PyLinkForwardModel:
OutputData:
constructor only
-@author: Rebecca Kohlhaas
"""
import sys
sys.path.append("src/")
--
GitLab