Skip to content

Commit

Permalink
Fix image in doc (#3455)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidbrochart authored and ColCarroll committed Apr 25, 2019
1 parent 35813f7 commit a7f62a0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/source/notebooks/SMC2_gaussians.ipynb
Expand Up @@ -53,7 +53,7 @@
"\n",
"The previous paragraph is summarized in the next figure, the first subplot show 5 samples (orange dots) at some particular stage. The second subplots show how this samples are reweighted according to the their posterior density (blue Gaussian curve). The third subplot shows the result of running a certain number of Metropolis steps, starting from the _selected/reweighting_ samples in the second subplots, notice how the two samples with the lower posterior density (smaller circles) are discarded and not used to seed Markov chains.\n",
"\n",
"<img src=\"https://github.com/pymc-devs/pymc3/raw/master/docs/source/notebooks/smc.png\" alt=\"SMC stages\"> \n",
"![SMC stages](https://github.com/pymc-devs/pymc3/raw/master/docs/source/notebooks/smc.png)\n",
"\n",
"So far we have that the SMC sampler is just a bunch of parallel Markov chains, not very impressive, right? Well not that fast. SMC proceed by moving _sequentially_ trough a series of stages, starting from a simple to sample distribution until it get to the posterior distribution. All this intermediate distribution (or _tempered posterior distributions_) are controlled by _tempering_ parameter called $\\beta$. SMC takes this idea from other _tempering_ methods originated from a branch of physics known as _statistical mechanics_. The idea is as follow the number of accessible states a _real physical_ system can reach is controlled by the temperature, if the temperature is the lowest possible ($0$ Kelvin) the system is trapped in a single state, on the contrary if the temperature is $\\infty$ all states are equally accessible! In the _statistical mechanics_ literature $\\beta$ is know as the inverse temperature, the higher the more constrained the system is. Going back to the Bayesian statistics context a _natural_ analogy to these physical systems is given by the following formula:\n",
"\n",
Expand Down

2 comments on commit a7f62a0

@rpgoldman
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davidbrochart @ColCarroll
When I look at this page at https://docs.pymc.io/notebooks/SMC2_gaussians.html the figure is missing. But when I open the .ipynb file from the PyMC3 source, I do see it.

This image from Safari shows where the figure should be, but is not:

image

I have tried the URL in both Google Chrome and Safari on MacOS. Is there any chance that the Markdown translator is refusing to fetch an image from github.com when it's building for docs.pymc.io?

When I look at the source of the HTML file above, I don't see the string smc.png in it anywhere, and I'm afraid I don't know enough about how the pages are generated to diagnose this any further.

Secondary Suggestion: if markdown will support the ALT text attribute, maybe you should restore it, so that if the figure inclusion fails, we'll get a visible "hole" in the display. I was wondering what "the figure below" referred to...

@ColCarroll
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oooh, it is not in the docs because we rebuild the docs only when we release (no one has written the code to have "master" docs and "stable" docs). We should cut a new release pretty soon (~1-2 weeks).

Please sign in to comment.