Skip to content

Commit

Permalink
Adding required docstring for ExperimentalDesign and LatinHypercube
Browse files Browse the repository at this point in the history
  • Loading branch information
kallewesterling committed Feb 14, 2024
1 parent fcf955f commit 44e34df
Showing 1 changed file with 30 additions and 18 deletions.
48 changes: 30 additions & 18 deletions autoemulate/experimental_design.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,22 @@


class ExperimentalDesign(ABC):
def __init__(self, bounds_list):
"""Initializes a Sampler object.
"""
Abstract class for experimental design.
Parameters
----------
bounds_list : list
List tuples with two numeric values.
Each tuple corresponds to the lower and
upper bounds of a parameter.
"""
This class is used to sample points from the parameter space
to be used in the training of the emulator.
Attributes
----------
bounds_list : list
List tuples with two numeric values.
Each tuple corresponds to the lower and
upper bounds of a parameter.
"""

def __init__(self, bounds_list):
"""Initializes a Sampler object."""
pass

@abstractmethod
Expand All @@ -41,16 +47,22 @@ def get_n_parameters(self):


class LatinHypercube(ExperimentalDesign):
def __init__(self, bounds_list):
"""Initializes a LatinHypercube object.
"""
LatinHypercube class for experimental design.
Parameters
----------
bounds_list : list
List tuples with two numeric values.
Each tuple corresponds to the lower and
upper bounds of a parameter.
"""
This class is used to sample points from the parameter space
to be used in the training of the emulator.
Attributes
----------
bounds_list : list
List tuples with two numeric values.
Each tuple corresponds to the lower and
upper bounds of a parameter.
"""

def __init__(self, bounds_list):
"""Initializes a LatinHypercube object."""
self.sampler = mogp_emulator.LatinHypercubeDesign(bounds_list)

def sample(self, n: int):
Expand Down

0 comments on commit 44e34df

Please sign in to comment.