GPy/doc/_build/html/GPy.inference.mcmc.html
2015-07-19 14:30:27 -07:00

221 lines
No EOL
13 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>GPy.inference.mcmc package &mdash; GPy documentation</title>
<link rel="stylesheet" href="_static//default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="GPy documentation" href="index.html" />
<link rel="up" title="GPy.inference package" href="GPy.inference.html" />
<link rel="next" title="GPy.inference.optimization package" href="GPy.inference.optimization.html" />
<link rel="prev" title="GPy.inference.latent_function_inference package" href="GPy.inference.latent_function_inference.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="GPy.inference.optimization.html" title="GPy.inference.optimization package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="GPy.inference.latent_function_inference.html" title="GPy.inference.latent_function_inference package"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">GPy documentation</a> &raquo;</li>
<li class="nav-item nav-item-1"><a href="GPy.html" >GPy package</a> &raquo;</li>
<li class="nav-item nav-item-2"><a href="GPy.inference.html" accesskey="U">GPy.inference package</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="gpy-inference-mcmc-package">
<h1>GPy.inference.mcmc package<a class="headerlink" href="#gpy-inference-mcmc-package" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-GPy.inference.mcmc.hmc">
<span id="gpy-inference-mcmc-hmc-module"></span><h2>GPy.inference.mcmc.hmc module<a class="headerlink" href="#module-GPy.inference.mcmc.hmc" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="GPy.inference.mcmc.hmc.HMC">
<em class="property">class </em><code class="descclassname">GPy.inference.mcmc.hmc.</code><code class="descname">HMC</code><span class="sig-paren">(</span><em>model</em>, <em>M=None</em>, <em>stepsize=0.1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GPy/inference/mcmc/hmc.html#HMC"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GPy.inference.mcmc.hmc.HMC" title="Permalink to this definition"></a></dt>
<dd><p>An implementation of Hybrid Monte Carlo (HMC) for GPy models</p>
<p>Initialize an object for HMC sampling. Note that the status of the model (model parameters) will be changed during sampling.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>model</strong> (<em>GPy.core.Model</em>) &#8211; the GPy model that will be sampled</li>
<li><strong>M</strong> (<em>numpy.ndarray</em>) &#8211; the mass matrix (an identity matrix by default)</li>
<li><strong>stepsize</strong> (<em>float</em>) &#8211; the step size for HMC sampling</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="GPy.inference.mcmc.hmc.HMC.sample">
<code class="descname">sample</code><span class="sig-paren">(</span><em>num_samples=1000</em>, <em>hmc_iters=20</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GPy/inference/mcmc/hmc.html#HMC.sample"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GPy.inference.mcmc.hmc.HMC.sample" title="Permalink to this definition"></a></dt>
<dd><p>Sample the (unfixed) model parameters.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>num_samples</strong> (<em>int</em>) &#8211; the number of samples to draw (1000 by default)</li>
<li><strong>hmc_iters</strong> (<em>int</em>) &#8211; the number of leap-frog iterations (20 by default)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the list of parameters samples with the size N x P (N - the number of samples, P - the number of parameters to sample)</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">numpy.ndarray</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="GPy.inference.mcmc.hmc.HMC_shortcut">
<em class="property">class </em><code class="descclassname">GPy.inference.mcmc.hmc.</code><code class="descname">HMC_shortcut</code><span class="sig-paren">(</span><em>model, M=None, stepsize_range=[1e-06, 0.1], groupsize=5, Hstd_th=[1e-05, 3.0]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GPy/inference/mcmc/hmc.html#HMC_shortcut"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GPy.inference.mcmc.hmc.HMC_shortcut" title="Permalink to this definition"></a></dt>
<dd><dl class="method">
<dt id="GPy.inference.mcmc.hmc.HMC_shortcut.sample">
<code class="descname">sample</code><span class="sig-paren">(</span><em>m_iters=1000</em>, <em>hmc_iters=20</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GPy/inference/mcmc/hmc.html#HMC_shortcut.sample"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GPy.inference.mcmc.hmc.HMC_shortcut.sample" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-GPy.inference.mcmc.samplers">
<span id="gpy-inference-mcmc-samplers-module"></span><h2>GPy.inference.mcmc.samplers module<a class="headerlink" href="#module-GPy.inference.mcmc.samplers" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="GPy.inference.mcmc.samplers.Metropolis_Hastings">
<em class="property">class </em><code class="descclassname">GPy.inference.mcmc.samplers.</code><code class="descname">Metropolis_Hastings</code><span class="sig-paren">(</span><em>model</em>, <em>cov=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GPy/inference/mcmc/samplers.html#Metropolis_Hastings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GPy.inference.mcmc.samplers.Metropolis_Hastings" title="Permalink to this definition"></a></dt>
<dd><dl class="method">
<dt id="GPy.inference.mcmc.samplers.Metropolis_Hastings.new_chain">
<code class="descname">new_chain</code><span class="sig-paren">(</span><em>start=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GPy/inference/mcmc/samplers.html#Metropolis_Hastings.new_chain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GPy.inference.mcmc.samplers.Metropolis_Hastings.new_chain" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="GPy.inference.mcmc.samplers.Metropolis_Hastings.predict">
<code class="descname">predict</code><span class="sig-paren">(</span><em>function</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GPy/inference/mcmc/samplers.html#Metropolis_Hastings.predict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GPy.inference.mcmc.samplers.Metropolis_Hastings.predict" title="Permalink to this definition"></a></dt>
<dd><p>Make a prediction for the function, to which we will pass the additional arguments</p>
</dd></dl>
<dl class="method">
<dt id="GPy.inference.mcmc.samplers.Metropolis_Hastings.sample">
<code class="descname">sample</code><span class="sig-paren">(</span><em>Ntotal</em>, <em>Nburn</em>, <em>Nthin</em>, <em>tune=True</em>, <em>tune_throughout=False</em>, <em>tune_interval=400</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GPy/inference/mcmc/samplers.html#Metropolis_Hastings.sample"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GPy.inference.mcmc.samplers.Metropolis_Hastings.sample" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-GPy.inference.mcmc">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-GPy.inference.mcmc" title="Permalink to this headline"></a></h2>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">GPy.inference.mcmc package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-GPy.inference.mcmc.hmc">GPy.inference.mcmc.hmc module</a></li>
<li><a class="reference internal" href="#module-GPy.inference.mcmc.samplers">GPy.inference.mcmc.samplers module</a></li>
<li><a class="reference internal" href="#module-GPy.inference.mcmc">Module contents</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="GPy.inference.latent_function_inference.html"
title="previous chapter">GPy.inference.latent_function_inference package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="GPy.inference.optimization.html"
title="next chapter">GPy.inference.optimization package</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/GPy.inference.mcmc.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="GPy.inference.optimization.html" title="GPy.inference.optimization package"
>next</a> |</li>
<li class="right" >
<a href="GPy.inference.latent_function_inference.html" title="GPy.inference.latent_function_inference package"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">GPy documentation</a> &raquo;</li>
<li class="nav-item nav-item-1"><a href="GPy.html" >GPy package</a> &raquo;</li>
<li class="nav-item nav-item-2"><a href="GPy.inference.html" >GPy.inference package</a> &raquo;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
&copy; Copyright 2013, Author.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
</div>
</body>
</html>