Skip to content
Snippets Groups Projects
Commit 4ac4fb84 authored by Hu Zhao's avatar Hu Zhao
Browse files

docs: create documentation for sampler module

parent 00abef1b
Branches
No related tags found
No related merge requests found
Sampler
=======
This module hosts functionality for sampling methods.
Currently implemented classes are:
* :class:`.LHS`:
* :class:`.MetroplisHastings`:
* :class:`.Saltelli`:
.. toctree::
:maxdepth: 1
:hidden:
:caption: Sampler
Latin Hypercube <latin>
Metropolis Hastings <metropolis_hastings>
Saltelli <saltelli>
\ No newline at end of file
Latin Hypercube Sampling
------------------------
LHS Class
^^^^^^^^^
The :class:`.LHS` class is imported by::
from psimpy.sampler.latin import LHS
Methods
*******
.. autoclass:: psimpy.sampler.latin.LHS
:members: sample
\ No newline at end of file
Metropolis Hastings Sampling
----------------------------
MetropolisHastings Class
^^^^^^^^^^^^^^^^^^^^^^^^
The :class:`.MetropolisHastings` class is imported by::
from psimpy.sampler.metropolis_hastings import MetropolisHastings
Methods
*******
.. autoclass:: psimpy.sampler.metropolis_hastings.MetropolisHastings
:members: sample
\ No newline at end of file
Saltelli Sampling
-----------------
Saltelli Class
^^^^^^^^^^^^^^
The :class:`.Saltelli` class is imported by::
from psimpy.sampler.saltelli import Saltelli
Methods
*******
.. autoclass:: psimpy.sampler.saltelli.Saltelli
:members: sample
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment