hmm.html 63 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>Hidden Markov Models &#8212; State Space Models: A Modern Approach</title>
  7. <link href="../../_static/css/theme.css" rel="stylesheet">
  8. <link href="../../_static/css/index.ff1ffe594081f20da1ef19478df9384b.css" rel="stylesheet">
  9. <link rel="stylesheet"
  10. href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css">
  11. <link rel="preload" as="font" type="font/woff2" crossorigin
  12. href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
  13. <link rel="preload" as="font" type="font/woff2" crossorigin
  14. href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
  15. <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
  16. <link rel="stylesheet" type="text/css" href="../../_static/sphinx-book-theme.css?digest=c3fdc42140077d1ad13ad2f1588a4309" />
  17. <link rel="stylesheet" type="text/css" href="../../_static/togglebutton.css" />
  18. <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
  19. <link rel="stylesheet" type="text/css" href="../../_static/mystnb.css" />
  20. <link rel="stylesheet" type="text/css" href="../../_static/sphinx-thebe.css" />
  21. <link rel="stylesheet" type="text/css" href="../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
  22. <link rel="stylesheet" type="text/css" href="../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
  23. <link rel="preload" as="script" href="../../_static/js/index.be7d3bbb2ef33a8344ce.js">
  24. <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
  25. <script src="../../_static/jquery.js"></script>
  26. <script src="../../_static/underscore.js"></script>
  27. <script src="../../_static/doctools.js"></script>
  28. <script src="../../_static/clipboard.min.js"></script>
  29. <script src="../../_static/copybutton.js"></script>
  30. <script>let toggleHintShow = 'Click to show';</script>
  31. <script>let toggleHintHide = 'Click to hide';</script>
  32. <script>let toggleOpenOnPrint = 'true';</script>
  33. <script src="../../_static/togglebutton.js"></script>
  34. <script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
  35. <script src="../../_static/sphinx-book-theme.d59cb220de22ca1c485ebbdc042f0030.js"></script>
  36. <script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"
  37. const thebe_selector = ".thebe,.cell"
  38. const thebe_selector_input = "pre"
  39. const thebe_selector_output = ".output, .cell_output"
  40. </script>
  41. <script async="async" src="../../_static/sphinx-thebe.js"></script>
  42. <link rel="index" title="Index" href="../../genindex.html" />
  43. <link rel="search" title="Search" href="../../search.html" />
  44. <meta name="viewport" content="width=device-width, initial-scale=1" />
  45. <meta name="docsearch:language" content="None">
  46. <!-- Google Analytics -->
  47. </head>
  48. <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
  49. <div class="container-fluid" id="banner"></div>
  50. <div class="container-xl">
  51. <div class="row">
  52. <div class="col-12 col-md-3 bd-sidebar site-navigation show" id="site-navigation">
  53. <div class="navbar-brand-box">
  54. <a class="navbar-brand text-wrap" href="../../index.html">
  55. <h1 class="site-logo" id="site-title">State Space Models: A Modern Approach</h1>
  56. </a>
  57. </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get">
  58. <i class="icon fas fa-search"></i>
  59. <input type="search" class="form-control" name="q" id="search-input" placeholder="Search this book..." aria-label="Search this book..." autocomplete="off" >
  60. </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
  61. <div class="bd-toc-item active">
  62. <ul class="nav bd-sidenav">
  63. <li class="toctree-l1">
  64. <a class="reference internal" href="../../root.html">
  65. State Space Models: A Modern Approach
  66. </a>
  67. </li>
  68. </ul>
  69. <ul class="nav bd-sidenav">
  70. <li class="toctree-l1">
  71. <a class="reference internal" href="../scratch.html">
  72. Scratchpad
  73. </a>
  74. </li>
  75. <li class="toctree-l1 has-children">
  76. <a class="reference internal" href="../ssm/ssm_index.html">
  77. State Space Models
  78. </a>
  79. <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/>
  80. <label for="toctree-checkbox-1">
  81. <i class="fas fa-chevron-down">
  82. </i>
  83. </label>
  84. <ul>
  85. <li class="toctree-l2">
  86. <a class="reference internal" href="../ssm/ssm_intro.html">
  87. What are State Space Models?
  88. </a>
  89. </li>
  90. <li class="toctree-l2">
  91. <a class="reference internal" href="../ssm/hmm.html">
  92. Hidden Markov Models
  93. </a>
  94. </li>
  95. <li class="toctree-l2">
  96. <a class="reference internal" href="../ssm/lds.html">
  97. Linear Gaussian SSMs
  98. </a>
  99. </li>
  100. <li class="toctree-l2">
  101. <a class="reference internal" href="../ssm/nlds.html">
  102. Nonlinear Gaussian SSMs
  103. </a>
  104. </li>
  105. <li class="toctree-l2">
  106. <a class="reference internal" href="../ssm/inference.html">
  107. Inferential goals
  108. </a>
  109. </li>
  110. </ul>
  111. </li>
  112. <li class="toctree-l1 has-children">
  113. <a class="reference internal" href="hmm_index.html">
  114. Hidden Markov Models
  115. </a>
  116. <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/>
  117. <label for="toctree-checkbox-2">
  118. <i class="fas fa-chevron-down">
  119. </i>
  120. </label>
  121. <ul>
  122. <li class="toctree-l2">
  123. <a class="reference internal" href="hmm_filter.html">
  124. HMM filtering (forwards algorithm)
  125. </a>
  126. </li>
  127. <li class="toctree-l2">
  128. <a class="reference internal" href="hmm_smoother.html">
  129. HMM smoothing (forwards-backwards algorithm)
  130. </a>
  131. </li>
  132. <li class="toctree-l2">
  133. <a class="reference internal" href="hmm_viterbi.html">
  134. Viterbi algorithm
  135. </a>
  136. </li>
  137. <li class="toctree-l2">
  138. <a class="reference internal" href="hmm_parallel.html">
  139. Parallel HMM smoothing
  140. </a>
  141. </li>
  142. <li class="toctree-l2">
  143. <a class="reference internal" href="hmm_sampling.html">
  144. Forwards-filtering backwards-sampling algorithm
  145. </a>
  146. </li>
  147. </ul>
  148. </li>
  149. <li class="toctree-l1 has-children">
  150. <a class="reference internal" href="../lgssm/lgssm_index.html">
  151. Linear-Gaussian SSMs
  152. </a>
  153. <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/>
  154. <label for="toctree-checkbox-3">
  155. <i class="fas fa-chevron-down">
  156. </i>
  157. </label>
  158. <ul>
  159. <li class="toctree-l2">
  160. <a class="reference internal" href="../lgssm/kalman_filter.html">
  161. Kalman filtering
  162. </a>
  163. </li>
  164. <li class="toctree-l2">
  165. <a class="reference internal" href="../lgssm/kalman_smoother.html">
  166. Kalman (RTS) smoother
  167. </a>
  168. </li>
  169. <li class="toctree-l2">
  170. <a class="reference internal" href="../lgssm/kalman_parallel.html">
  171. Parallel Kalman Smoother
  172. </a>
  173. </li>
  174. <li class="toctree-l2">
  175. <a class="reference internal" href="../lgssm/kalman_sampling.html">
  176. Forwards-filtering backwards sampling
  177. </a>
  178. </li>
  179. </ul>
  180. </li>
  181. <li class="toctree-l1 has-children">
  182. <a class="reference internal" href="../extended/extended_index.html">
  183. Extended (linearized) methods
  184. </a>
  185. <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/>
  186. <label for="toctree-checkbox-4">
  187. <i class="fas fa-chevron-down">
  188. </i>
  189. </label>
  190. <ul>
  191. <li class="toctree-l2">
  192. <a class="reference internal" href="../extended/extended_filter.html">
  193. Extended Kalman filtering
  194. </a>
  195. </li>
  196. <li class="toctree-l2">
  197. <a class="reference internal" href="../extended/extended_smoother.html">
  198. Extended Kalman smoother
  199. </a>
  200. </li>
  201. <li class="toctree-l2">
  202. <a class="reference internal" href="../extended/extended_parallel.html">
  203. Parallel extended Kalman smoothing
  204. </a>
  205. </li>
  206. </ul>
  207. </li>
  208. <li class="toctree-l1 has-children">
  209. <a class="reference internal" href="../unscented/unscented_index.html">
  210. Unscented methods
  211. </a>
  212. <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/>
  213. <label for="toctree-checkbox-5">
  214. <i class="fas fa-chevron-down">
  215. </i>
  216. </label>
  217. <ul>
  218. <li class="toctree-l2">
  219. <a class="reference internal" href="../unscented/unscented_filter.html">
  220. Unscented filtering
  221. </a>
  222. </li>
  223. <li class="toctree-l2">
  224. <a class="reference internal" href="../unscented/unscented_smoother.html">
  225. Unscented smoothing
  226. </a>
  227. </li>
  228. </ul>
  229. </li>
  230. <li class="toctree-l1">
  231. <a class="reference internal" href="../quadrature/quadrature_index.html">
  232. Quadrature and cubature methods
  233. </a>
  234. </li>
  235. <li class="toctree-l1">
  236. <a class="reference internal" href="../postlin/postlin_index.html">
  237. Posterior linearization
  238. </a>
  239. </li>
  240. <li class="toctree-l1">
  241. <a class="reference internal" href="../adf/adf_index.html">
  242. Assumed Density Filtering
  243. </a>
  244. </li>
  245. <li class="toctree-l1">
  246. <a class="reference internal" href="../vi/vi_index.html">
  247. Variational inference
  248. </a>
  249. </li>
  250. <li class="toctree-l1">
  251. <a class="reference internal" href="../pf/pf_index.html">
  252. Particle filtering
  253. </a>
  254. </li>
  255. <li class="toctree-l1">
  256. <a class="reference internal" href="../smc/smc_index.html">
  257. Sequential Monte Carlo
  258. </a>
  259. </li>
  260. <li class="toctree-l1">
  261. <a class="reference internal" href="../learning/learning_index.html">
  262. Offline parameter estimation (learning)
  263. </a>
  264. </li>
  265. <li class="toctree-l1">
  266. <a class="reference internal" href="../tracking/tracking_index.html">
  267. Multi-target tracking
  268. </a>
  269. </li>
  270. <li class="toctree-l1">
  271. <a class="reference internal" href="../ensemble/ensemble_index.html">
  272. Data assimilation using Ensemble Kalman filter
  273. </a>
  274. </li>
  275. <li class="toctree-l1">
  276. <a class="reference internal" href="../bnp/bnp_index.html">
  277. Bayesian non-parametric SSMs
  278. </a>
  279. </li>
  280. <li class="toctree-l1">
  281. <a class="reference internal" href="../changepoint/changepoint_index.html">
  282. Changepoint detection
  283. </a>
  284. </li>
  285. <li class="toctree-l1">
  286. <a class="reference internal" href="../timeseries/timeseries_index.html">
  287. Timeseries forecasting
  288. </a>
  289. </li>
  290. <li class="toctree-l1">
  291. <a class="reference internal" href="../gp/gp_index.html">
  292. Markovian Gaussian processes
  293. </a>
  294. </li>
  295. <li class="toctree-l1">
  296. <a class="reference internal" href="../ode/ode_index.html">
  297. Differential equations and SSMs
  298. </a>
  299. </li>
  300. <li class="toctree-l1">
  301. <a class="reference internal" href="../control/control_index.html">
  302. Optimal control
  303. </a>
  304. </li>
  305. <li class="toctree-l1">
  306. <a class="reference internal" href="../../bib.html">
  307. Bibliography
  308. </a>
  309. </li>
  310. </ul>
  311. </div>
  312. </nav> <!-- To handle the deprecated key -->
  313. <div class="navbar_extra_footer">
  314. Powered by <a href="https://jupyterbook.org">Jupyter Book</a>
  315. </div>
  316. </div>
  317. <main class="col py-md-3 pl-md-4 bd-content overflow-auto" role="main">
  318. <div class="topbar container-xl fixed-top">
  319. <div class="topbar-contents row">
  320. <div class="col-12 col-md-3 bd-topbar-whitespace site-navigation show"></div>
  321. <div class="col pl-md-4 topbar-main">
  322. <button id="navbar-toggler" class="navbar-toggler ml-0" type="button" data-toggle="collapse"
  323. data-toggle="tooltip" data-placement="bottom" data-target=".site-navigation" aria-controls="navbar-menu"
  324. aria-expanded="true" aria-label="Toggle navigation" aria-controls="site-navigation"
  325. title="Toggle navigation" data-toggle="tooltip" data-placement="left">
  326. <i class="fas fa-bars"></i>
  327. <i class="fas fa-arrow-left"></i>
  328. <i class="fas fa-arrow-up"></i>
  329. </button>
  330. <div class="dropdown-buttons-trigger">
  331. <button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn" aria-label="Download this page"><i
  332. class="fas fa-download"></i></button>
  333. <div class="dropdown-buttons">
  334. <!-- ipynb file if we had a myst markdown file -->
  335. <!-- Download raw file -->
  336. <a class="dropdown-buttons" href="../../_sources/chapters/hmm/hmm.ipynb"><button type="button"
  337. class="btn btn-secondary topbarbtn" title="Download source file" data-toggle="tooltip"
  338. data-placement="left">.ipynb</button></a>
  339. <!-- Download PDF via print -->
  340. <button type="button" id="download-print" class="btn btn-secondary topbarbtn" title="Print to PDF"
  341. onclick="printPdf(this)" data-toggle="tooltip" data-placement="left">.pdf</button>
  342. </div>
  343. </div>
  344. <!-- Source interaction buttons -->
  345. <div class="dropdown-buttons-trigger">
  346. <button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn"
  347. aria-label="Connect with source repository"><i class="fab fa-github"></i></button>
  348. <div class="dropdown-buttons sourcebuttons">
  349. <a class="repository-button"
  350. href="https://github.com/probml/ssm-book"><button type="button" class="btn btn-secondary topbarbtn"
  351. data-toggle="tooltip" data-placement="left" title="Source repository"><i
  352. class="fab fa-github"></i>repository</button></a>
  353. <a class="issues-button"
  354. href="https://github.com/probml/ssm-book/issues/new?title=Issue%20on%20page%20%2Fchapters/hmm/hmm.html&body=Your%20issue%20content%20here."><button
  355. type="button" class="btn btn-secondary topbarbtn" data-toggle="tooltip" data-placement="left"
  356. title="Open an issue"><i class="fas fa-lightbulb"></i>open issue</button></a>
  357. </div>
  358. </div>
  359. <!-- Full screen (wrap in <a> to have style consistency -->
  360. <a class="full-screen-button"><button type="button" class="btn btn-secondary topbarbtn" data-toggle="tooltip"
  361. data-placement="bottom" onclick="toggleFullScreen()" aria-label="Fullscreen mode"
  362. title="Fullscreen mode"><i
  363. class="fas fa-expand"></i></button></a>
  364. <!-- Launch buttons -->
  365. <div class="dropdown-buttons-trigger">
  366. <button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn"
  367. aria-label="Launch interactive content"><i class="fas fa-rocket"></i></button>
  368. <div class="dropdown-buttons">
  369. <a class="binder-button" href="https://mybinder.org/v2/gh/probml/ssm-book/main?urlpath=tree/chapters/hmm/hmm.ipynb"><button type="button"
  370. class="btn btn-secondary topbarbtn" title="Launch Binder" data-toggle="tooltip"
  371. data-placement="left"><img class="binder-button-logo"
  372. src="../../_static/images/logo_binder.svg"
  373. alt="Interact on binder">Binder</button></a>
  374. <a class="colab-button" href="https://colab.research.google.com/github/probml/ssm-book/blob/main/chapters/hmm/hmm.ipynb"><button type="button" class="btn btn-secondary topbarbtn"
  375. title="Launch Colab" data-toggle="tooltip" data-placement="left"><img class="colab-button-logo"
  376. src="../../_static/images/logo_colab.png"
  377. alt="Interact on Colab">Colab</button></a>
  378. </div>
  379. </div>
  380. </div>
  381. <!-- Table of contents -->
  382. <div class="d-none d-md-block col-md-2 bd-toc show noprint">
  383. <div class="tocsection onthispage pt-5 pb-3">
  384. <i class="fas fa-list"></i> Contents
  385. </div>
  386. <nav id="bd-toc-nav" aria-label="Page">
  387. <ul class="visible nav section-nav flex-column">
  388. <li class="toc-h2 nav-item toc-entry">
  389. <a class="reference internal nav-link" href="#boilerplate">
  390. Boilerplate
  391. </a>
  392. </li>
  393. <li class="toc-h2 nav-item toc-entry">
  394. <a class="reference internal nav-link" href="#utility-code">
  395. Utility code
  396. </a>
  397. </li>
  398. <li class="toc-h2 nav-item toc-entry">
  399. <a class="reference internal nav-link" href="#example-casino-hmm">
  400. Example: Casino HMM
  401. </a>
  402. </li>
  403. <li class="toc-h2 nav-item toc-entry">
  404. <a class="reference internal nav-link" href="#sampling-from-the-joint">
  405. Sampling from the joint
  406. </a>
  407. <ul class="nav section-nav flex-column">
  408. <li class="toc-h3 nav-item toc-entry">
  409. <a class="reference internal nav-link" href="#numpy-version">
  410. Numpy version
  411. </a>
  412. </li>
  413. <li class="toc-h3 nav-item toc-entry">
  414. <a class="reference internal nav-link" href="#jax-version">
  415. JAX version
  416. </a>
  417. </li>
  418. <li class="toc-h3 nav-item toc-entry">
  419. <a class="reference internal nav-link" href="#check-correctness-by-computing-empirical-pairwise-statistics">
  420. Check correctness by computing empirical pairwise statistics
  421. </a>
  422. </li>
  423. </ul>
  424. </li>
  425. </ul>
  426. </nav>
  427. </div>
  428. </div>
  429. </div>
  430. <div id="main-content" class="row">
  431. <div class="col-12 col-md-9 pl-md-3 pr-md-0">
  432. <!-- Table of contents that is only displayed when printing the page -->
  433. <div id="jb-print-docs-body" class="onlyprint">
  434. <h1>Hidden Markov Models</h1>
  435. <!-- Table of contents -->
  436. <div id="print-main-content">
  437. <div id="jb-print-toc">
  438. <div>
  439. <h2> Contents </h2>
  440. </div>
  441. <nav aria-label="Page">
  442. <ul class="visible nav section-nav flex-column">
  443. <li class="toc-h2 nav-item toc-entry">
  444. <a class="reference internal nav-link" href="#boilerplate">
  445. Boilerplate
  446. </a>
  447. </li>
  448. <li class="toc-h2 nav-item toc-entry">
  449. <a class="reference internal nav-link" href="#utility-code">
  450. Utility code
  451. </a>
  452. </li>
  453. <li class="toc-h2 nav-item toc-entry">
  454. <a class="reference internal nav-link" href="#example-casino-hmm">
  455. Example: Casino HMM
  456. </a>
  457. </li>
  458. <li class="toc-h2 nav-item toc-entry">
  459. <a class="reference internal nav-link" href="#sampling-from-the-joint">
  460. Sampling from the joint
  461. </a>
  462. <ul class="nav section-nav flex-column">
  463. <li class="toc-h3 nav-item toc-entry">
  464. <a class="reference internal nav-link" href="#numpy-version">
  465. Numpy version
  466. </a>
  467. </li>
  468. <li class="toc-h3 nav-item toc-entry">
  469. <a class="reference internal nav-link" href="#jax-version">
  470. JAX version
  471. </a>
  472. </li>
  473. <li class="toc-h3 nav-item toc-entry">
  474. <a class="reference internal nav-link" href="#check-correctness-by-computing-empirical-pairwise-statistics">
  475. Check correctness by computing empirical pairwise statistics
  476. </a>
  477. </li>
  478. </ul>
  479. </li>
  480. </ul>
  481. </nav>
  482. </div>
  483. </div>
  484. </div>
  485. <div>
  486. <div class="tex2jax_ignore mathjax_ignore section" id="hidden-markov-models">
  487. <span id="sec-hmm-ex"></span><h1>Hidden Markov Models<a class="headerlink" href="#hidden-markov-models" title="Permalink to this headline">¶</a></h1>
  488. <p>In this section, we introduce Hidden Markov Models (HMMs).</p>
  489. <div class="section" id="boilerplate">
  490. <h2>Boilerplate<a class="headerlink" href="#boilerplate" title="Permalink to this headline">¶</a></h2>
  491. <div class="cell docutils container">
  492. <div class="cell_input docutils container">
  493. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install necessary libraries</span>
  494. <span class="k">try</span><span class="p">:</span>
  495. <span class="kn">import</span> <span class="nn">jax</span>
  496. <span class="k">except</span><span class="p">:</span>
  497. <span class="c1"># For cuda version, see https://github.com/google/jax#installation</span>
  498. <span class="o">%</span><span class="k">pip</span> install --upgrade &quot;jax[cpu]&quot;
  499. <span class="kn">import</span> <span class="nn">jax</span>
  500. <span class="k">try</span><span class="p">:</span>
  501. <span class="kn">import</span> <span class="nn">jsl</span>
  502. <span class="k">except</span><span class="p">:</span>
  503. <span class="o">%</span><span class="k">pip</span> install git+https://github.com/probml/jsl
  504. <span class="kn">import</span> <span class="nn">jsl</span>
  505. <span class="k">try</span><span class="p">:</span>
  506. <span class="kn">import</span> <span class="nn">rich</span>
  507. <span class="k">except</span><span class="p">:</span>
  508. <span class="o">%</span><span class="k">pip</span> install rich
  509. <span class="kn">import</span> <span class="nn">rich</span>
  510. </pre></div>
  511. </div>
  512. </div>
  513. </div>
  514. <div class="cell docutils container">
  515. <div class="cell_input docutils container">
  516. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Import standard libraries</span>
  517. <span class="kn">import</span> <span class="nn">abc</span>
  518. <span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span>
  519. <span class="kn">import</span> <span class="nn">functools</span>
  520. <span class="kn">import</span> <span class="nn">itertools</span>
  521. <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">NamedTuple</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">Tuple</span>
  522. <span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
  523. <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  524. <span class="kn">import</span> <span class="nn">jax</span>
  525. <span class="kn">import</span> <span class="nn">jax.numpy</span> <span class="k">as</span> <span class="nn">jnp</span>
  526. <span class="kn">from</span> <span class="nn">jax</span> <span class="kn">import</span> <span class="n">lax</span><span class="p">,</span> <span class="n">vmap</span><span class="p">,</span> <span class="n">jit</span><span class="p">,</span> <span class="n">grad</span>
  527. <span class="kn">from</span> <span class="nn">jax.scipy.special</span> <span class="kn">import</span> <span class="n">logit</span>
  528. <span class="kn">from</span> <span class="nn">jax.nn</span> <span class="kn">import</span> <span class="n">softmax</span>
  529. <span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="n">partial</span>
  530. <span class="kn">from</span> <span class="nn">jax.random</span> <span class="kn">import</span> <span class="n">PRNGKey</span><span class="p">,</span> <span class="n">split</span>
  531. <span class="kn">import</span> <span class="nn">inspect</span>
  532. <span class="kn">import</span> <span class="nn">inspect</span> <span class="k">as</span> <span class="nn">py_inspect</span>
  533. <span class="kn">from</span> <span class="nn">rich</span> <span class="kn">import</span> <span class="n">inspect</span> <span class="k">as</span> <span class="n">r_inspect</span>
  534. <span class="kn">from</span> <span class="nn">rich</span> <span class="kn">import</span> <span class="nb">print</span> <span class="k">as</span> <span class="n">r_print</span>
  535. <span class="k">def</span> <span class="nf">print_source</span><span class="p">(</span><span class="n">fname</span><span class="p">):</span>
  536. <span class="n">r_print</span><span class="p">(</span><span class="n">py_inspect</span><span class="o">.</span><span class="n">getsource</span><span class="p">(</span><span class="n">fname</span><span class="p">))</span>
  537. </pre></div>
  538. </div>
  539. </div>
  540. </div>
  541. </div>
  542. <div class="section" id="utility-code">
  543. <h2>Utility code<a class="headerlink" href="#utility-code" title="Permalink to this headline">¶</a></h2>
  544. <div class="cell docutils container">
  545. <div class="cell_input docutils container">
  546. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">normalize</span><span class="p">(</span><span class="n">u</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-15</span><span class="p">):</span>
  547. <span class="sd">&#39;&#39;&#39;</span>
  548. <span class="sd"> Normalizes the values within the axis in a way that they sum up to 1.</span>
  549. <span class="sd"> Parameters</span>
  550. <span class="sd"> ----------</span>
  551. <span class="sd"> u : array</span>
  552. <span class="sd"> axis : int</span>
  553. <span class="sd"> eps : float</span>
  554. <span class="sd"> Threshold for the alpha values</span>
  555. <span class="sd"> Returns</span>
  556. <span class="sd"> -------</span>
  557. <span class="sd"> * array</span>
  558. <span class="sd"> Normalized version of the given matrix</span>
  559. <span class="sd"> * array(seq_len, n_hidden) :</span>
  560. <span class="sd"> The values of the normalizer</span>
  561. <span class="sd"> &#39;&#39;&#39;</span>
  562. <span class="n">u</span> <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">u</span> <span class="o">==</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">jnp</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">u</span> <span class="o">&lt;</span> <span class="n">eps</span><span class="p">,</span> <span class="n">eps</span><span class="p">,</span> <span class="n">u</span><span class="p">))</span>
  563. <span class="n">c</span> <span class="o">=</span> <span class="n">u</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">axis</span><span class="o">=</span><span class="n">axis</span><span class="p">)</span>
  564. <span class="n">c</span> <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">c</span> <span class="o">==</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span>
  565. <span class="k">return</span> <span class="n">u</span> <span class="o">/</span> <span class="n">c</span><span class="p">,</span> <span class="n">c</span>
  566. </pre></div>
  567. </div>
  568. </div>
  569. </div>
  570. </div>
  571. <div class="section" id="example-casino-hmm">
  572. <span id="sec-casino-ex"></span><h2>Example: Casino HMM<a class="headerlink" href="#example-casino-hmm" title="Permalink to this headline">¶</a></h2>
  573. <p>We first create the “Ocassionally dishonest casino” model from <span id="id1">[<a class="reference internal" href="../../bib.html#id3" title="R. Durbin, S. Eddy, A. Krogh, and G. Mitchison. Biological Sequence Analysis: Probabilistic Models of Proteins and Nucleic Acids. Cambridge University Press, 1998.">DEKM98</a>]</span>.</p>
  574. <div class="figure align-default" id="casino-fig">
  575. <a class="reference internal image-reference" href="../../_images/casino.png"><img alt="../../_images/casino.png" src="../../_images/casino.png" style="width: 208.5px; height: 142.5px;" /></a>
  576. <p class="caption"><span class="caption-text">Illustration of the casino HMM.</span><a class="headerlink" href="#casino-fig" title="Permalink to this image">¶</a></p>
  577. </div>
  578. <p>There are 2 hidden states, each of which emit 6 possible observations.</p>
  579. <div class="cell docutils container">
  580. <div class="cell_input docutils container">
  581. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># state transition matrix</span>
  582. <span class="n">A</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span>
  583. <span class="p">[</span><span class="mf">0.95</span><span class="p">,</span> <span class="mf">0.05</span><span class="p">],</span>
  584. <span class="p">[</span><span class="mf">0.10</span><span class="p">,</span> <span class="mf">0.90</span><span class="p">]</span>
  585. <span class="p">])</span>
  586. <span class="c1"># observation matrix</span>
  587. <span class="n">B</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span>
  588. <span class="p">[</span><span class="mi">1</span><span class="o">/</span><span class="mi">6</span><span class="p">,</span> <span class="mi">1</span><span class="o">/</span><span class="mi">6</span><span class="p">,</span> <span class="mi">1</span><span class="o">/</span><span class="mi">6</span><span class="p">,</span> <span class="mi">1</span><span class="o">/</span><span class="mi">6</span><span class="p">,</span> <span class="mi">1</span><span class="o">/</span><span class="mi">6</span><span class="p">,</span> <span class="mi">1</span><span class="o">/</span><span class="mi">6</span><span class="p">],</span> <span class="c1"># fair die</span>
  589. <span class="p">[</span><span class="mi">1</span><span class="o">/</span><span class="mi">10</span><span class="p">,</span> <span class="mi">1</span><span class="o">/</span><span class="mi">10</span><span class="p">,</span> <span class="mi">1</span><span class="o">/</span><span class="mi">10</span><span class="p">,</span> <span class="mi">1</span><span class="o">/</span><span class="mi">10</span><span class="p">,</span> <span class="mi">1</span><span class="o">/</span><span class="mi">10</span><span class="p">,</span> <span class="mi">5</span><span class="o">/</span><span class="mi">10</span><span class="p">]</span> <span class="c1"># loaded die</span>
  590. <span class="p">])</span>
  591. <span class="n">pi</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">normalize</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">]))</span>
  592. <span class="n">pi</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">pi</span><span class="p">)</span>
  593. <span class="p">(</span><span class="n">nstates</span><span class="p">,</span> <span class="n">nobs</span><span class="p">)</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">shape</span><span class="p">(</span><span class="n">B</span><span class="p">)</span>
  594. </pre></div>
  595. </div>
  596. </div>
  597. <div class="cell_output docutils container">
  598. <div class="output stderr highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>WARNING:absl:No GPU/TPU found, falling back to CPU. (Set TF_CPP_MIN_LOG_LEVEL=0 and rerun for more info.)
  599. </pre></div>
  600. </div>
  601. </div>
  602. </div>
  603. <p>Let’s make a little data structure to store all the parameters.
  604. We use NamedTuple rather than dataclass, since we assume these are immutable.
  605. (Also, standard python dataclass does not work well with JAX, which requires parameters to be
  606. pytrees, as discussed in <a class="reference external" href="https://github.com/google/jax/issues/2371">https://github.com/google/jax/issues/2371</a>).</p>
  607. <div class="cell docutils container">
  608. <div class="cell_input docutils container">
  609. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">Array</span> <span class="o">=</span> <span class="n">Union</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">,</span> <span class="n">jnp</span><span class="o">.</span><span class="n">array</span><span class="p">]</span>
  610. <span class="k">class</span> <span class="nc">HMM</span><span class="p">(</span><span class="n">NamedTuple</span><span class="p">):</span>
  611. <span class="n">trans_mat</span><span class="p">:</span> <span class="n">Array</span> <span class="c1"># A : (n_states, n_states)</span>
  612. <span class="n">obs_mat</span><span class="p">:</span> <span class="n">Array</span> <span class="c1"># B : (n_states, n_obs)</span>
  613. <span class="n">init_dist</span><span class="p">:</span> <span class="n">Array</span> <span class="c1"># pi : (n_states)</span>
  614. <span class="n">params_np</span> <span class="o">=</span> <span class="n">HMM</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">B</span><span class="p">,</span> <span class="n">pi</span><span class="p">)</span>
  615. <span class="nb">print</span><span class="p">(</span><span class="n">params_np</span><span class="p">)</span>
  616. <span class="nb">print</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">params_np</span><span class="o">.</span><span class="n">trans_mat</span><span class="p">))</span>
  617. <span class="n">params</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">tree_map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">jnp</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">x</span><span class="p">),</span> <span class="n">params_np</span><span class="p">)</span>
  618. <span class="nb">print</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
  619. <span class="nb">print</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">trans_mat</span><span class="p">))</span>
  620. </pre></div>
  621. </div>
  622. </div>
  623. <div class="cell_output docutils container">
  624. <div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>HMM(trans_mat=array([[0.95, 0.05],
  625. [0.1 , 0.9 ]]), obs_mat=array([[0.16666667, 0.16666667, 0.16666667, 0.16666667, 0.16666667,
  626. 0.16666667],
  627. [0.1 , 0.1 , 0.1 , 0.1 , 0.1 ,
  628. 0.5 ]]), init_dist=array([0.5, 0.5], dtype=float32))
  629. &lt;class &#39;numpy.ndarray&#39;&gt;
  630. HMM(trans_mat=DeviceArray([[0.95, 0.05],
  631. [0.1 , 0.9 ]], dtype=float32), obs_mat=DeviceArray([[0.16666667, 0.16666667, 0.16666667, 0.16666667, 0.16666667,
  632. 0.16666667],
  633. [0.1 , 0.1 , 0.1 , 0.1 , 0.1 ,
  634. 0.5 ]], dtype=float32), init_dist=DeviceArray([0.5, 0.5], dtype=float32))
  635. &lt;class &#39;jaxlib.xla_extension.DeviceArray&#39;&gt;
  636. </pre></div>
  637. </div>
  638. </div>
  639. </div>
  640. </div>
  641. <div class="section" id="sampling-from-the-joint">
  642. <h2>Sampling from the joint<a class="headerlink" href="#sampling-from-the-joint" title="Permalink to this headline">¶</a></h2>
  643. <p>Let’s write code to sample from this model.</p>
  644. <div class="section" id="numpy-version">
  645. <h3>Numpy version<a class="headerlink" href="#numpy-version" title="Permalink to this headline">¶</a></h3>
  646. <p>First we code it in numpy using a for loop.</p>
  647. <div class="cell docutils container">
  648. <div class="cell_input docutils container">
  649. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">hmm_sample_np</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">seq_len</span><span class="p">,</span> <span class="n">random_state</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
  650. <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="n">random_state</span><span class="p">)</span>
  651. <span class="n">trans_mat</span><span class="p">,</span> <span class="n">obs_mat</span><span class="p">,</span> <span class="n">init_dist</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">trans_mat</span><span class="p">,</span> <span class="n">params</span><span class="o">.</span><span class="n">obs_mat</span><span class="p">,</span> <span class="n">params</span><span class="o">.</span><span class="n">init_dist</span>
  652. <span class="n">n_states</span><span class="p">,</span> <span class="n">n_obs</span> <span class="o">=</span> <span class="n">obs_mat</span><span class="o">.</span><span class="n">shape</span>
  653. <span class="n">state_seq</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">seq_len</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">int</span><span class="p">)</span>
  654. <span class="n">obs_seq</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">seq_len</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">int</span><span class="p">)</span>
  655. <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">seq_len</span><span class="p">):</span>
  656. <span class="k">if</span> <span class="n">t</span><span class="o">==</span><span class="mi">0</span><span class="p">:</span>
  657. <span class="n">zt</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">n_states</span><span class="p">,</span> <span class="n">p</span><span class="o">=</span><span class="n">init_dist</span><span class="p">)</span>
  658. <span class="k">else</span><span class="p">:</span>
  659. <span class="n">zt</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">n_states</span><span class="p">,</span> <span class="n">p</span><span class="o">=</span><span class="n">trans_mat</span><span class="p">[</span><span class="n">zt</span><span class="p">])</span>
  660. <span class="n">yt</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">n_obs</span><span class="p">,</span> <span class="n">p</span><span class="o">=</span><span class="n">obs_mat</span><span class="p">[</span><span class="n">zt</span><span class="p">])</span>
  661. <span class="n">state_seq</span><span class="p">[</span><span class="n">t</span><span class="p">]</span> <span class="o">=</span> <span class="n">zt</span>
  662. <span class="n">obs_seq</span><span class="p">[</span><span class="n">t</span><span class="p">]</span> <span class="o">=</span> <span class="n">yt</span>
  663. <span class="k">return</span> <span class="n">state_seq</span><span class="p">,</span> <span class="n">obs_seq</span>
  664. </pre></div>
  665. </div>
  666. </div>
  667. </div>
  668. <div class="cell docutils container">
  669. <div class="cell_input docutils container">
  670. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">seq_len</span> <span class="o">=</span> <span class="mi">100</span>
  671. <span class="n">state_seq</span><span class="p">,</span> <span class="n">obs_seq</span> <span class="o">=</span> <span class="n">hmm_sample_np</span><span class="p">(</span><span class="n">params_np</span><span class="p">,</span> <span class="n">seq_len</span><span class="p">,</span> <span class="n">random_state</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
  672. <span class="nb">print</span><span class="p">(</span><span class="n">state_seq</span><span class="p">)</span>
  673. <span class="nb">print</span><span class="p">(</span><span class="n">obs_seq</span><span class="p">)</span>
  674. </pre></div>
  675. </div>
  676. </div>
  677. <div class="cell_output docutils container">
  678. <div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>[0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 0 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0
  679. 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
  680. 0 0 0 0 0 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0]
  681. [4 1 0 2 3 4 5 4 3 1 5 4 5 0 5 2 5 3 5 4 5 5 4 2 1 4 1 0 0 4 2 2 3 3 3 0 4
  682. 0 2 4 3 2 5 5 3 5 3 1 3 3 3 2 3 5 5 0 4 4 5 0 0 1 3 5 1 5 0 1 2 4 0 0 0 4
  683. 0 5 1 4 3 5 4 5 0 2 3 5 2 4 1 2 1 0 4 3 5 0 4 5 1 5]
  684. </pre></div>
  685. </div>
  686. </div>
  687. </div>
  688. </div>
  689. <div class="section" id="jax-version">
  690. <h3>JAX version<a class="headerlink" href="#jax-version" title="Permalink to this headline">¶</a></h3>
  691. <p>Now let’s write a JAX version using jax.lax.scan (for the inter-dependent states) and vmap (for the observations).
  692. This is harder to read than the numpy version, but faster.</p>
  693. <div class="cell docutils container">
  694. <div class="cell_input docutils container">
  695. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1">#@partial(jit, static_argnums=(1,))</span>
  696. <span class="k">def</span> <span class="nf">markov_chain_sample</span><span class="p">(</span><span class="n">rng_key</span><span class="p">,</span> <span class="n">init_dist</span><span class="p">,</span> <span class="n">trans_mat</span><span class="p">,</span> <span class="n">seq_len</span><span class="p">):</span>
  697. <span class="n">n_states</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">init_dist</span><span class="p">)</span>
  698. <span class="k">def</span> <span class="nf">draw_state</span><span class="p">(</span><span class="n">prev_state</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
  699. <span class="n">state</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">n_states</span><span class="p">,</span> <span class="n">p</span><span class="o">=</span><span class="n">trans_mat</span><span class="p">[</span><span class="n">prev_state</span><span class="p">])</span>
  700. <span class="k">return</span> <span class="n">state</span><span class="p">,</span> <span class="n">state</span>
  701. <span class="n">rng_key</span><span class="p">,</span> <span class="n">rng_state</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">rng_key</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
  702. <span class="n">keys</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">rng_state</span><span class="p">,</span> <span class="n">seq_len</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
  703. <span class="n">initial_state</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">rng_key</span><span class="p">,</span> <span class="n">n_states</span><span class="p">,</span> <span class="n">p</span><span class="o">=</span><span class="n">init_dist</span><span class="p">)</span>
  704. <span class="n">final_state</span><span class="p">,</span> <span class="n">states</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">lax</span><span class="o">.</span><span class="n">scan</span><span class="p">(</span><span class="n">draw_state</span><span class="p">,</span> <span class="n">initial_state</span><span class="p">,</span> <span class="n">keys</span><span class="p">)</span>
  705. <span class="n">state_seq</span> <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">jnp</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="n">initial_state</span><span class="p">]),</span> <span class="n">states</span><span class="p">)</span>
  706. <span class="k">return</span> <span class="n">state_seq</span>
  707. </pre></div>
  708. </div>
  709. </div>
  710. </div>
  711. <div class="cell docutils container">
  712. <div class="cell_input docutils container">
  713. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1">#@partial(jit, static_argnums=(1,))</span>
  714. <span class="k">def</span> <span class="nf">hmm_sample</span><span class="p">(</span><span class="n">rng_key</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="n">seq_len</span><span class="p">):</span>
  715. <span class="n">trans_mat</span><span class="p">,</span> <span class="n">obs_mat</span><span class="p">,</span> <span class="n">init_dist</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">trans_mat</span><span class="p">,</span> <span class="n">params</span><span class="o">.</span><span class="n">obs_mat</span><span class="p">,</span> <span class="n">params</span><span class="o">.</span><span class="n">init_dist</span>
  716. <span class="n">n_states</span><span class="p">,</span> <span class="n">n_obs</span> <span class="o">=</span> <span class="n">obs_mat</span><span class="o">.</span><span class="n">shape</span>
  717. <span class="n">rng_key</span><span class="p">,</span> <span class="n">rng_obs</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">rng_key</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
  718. <span class="n">state_seq</span> <span class="o">=</span> <span class="n">markov_chain_sample</span><span class="p">(</span><span class="n">rng_key</span><span class="p">,</span> <span class="n">init_dist</span><span class="p">,</span> <span class="n">trans_mat</span><span class="p">,</span> <span class="n">seq_len</span><span class="p">)</span>
  719. <span class="k">def</span> <span class="nf">draw_obs</span><span class="p">(</span><span class="n">z</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
  720. <span class="n">obs</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">n_obs</span><span class="p">,</span> <span class="n">p</span><span class="o">=</span><span class="n">obs_mat</span><span class="p">[</span><span class="n">z</span><span class="p">])</span>
  721. <span class="k">return</span> <span class="n">obs</span>
  722. <span class="n">keys</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">rng_obs</span><span class="p">,</span> <span class="n">seq_len</span><span class="p">)</span>
  723. <span class="n">obs_seq</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">vmap</span><span class="p">(</span><span class="n">draw_obs</span><span class="p">,</span> <span class="n">in_axes</span><span class="o">=</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">))(</span><span class="n">state_seq</span><span class="p">,</span> <span class="n">keys</span><span class="p">)</span>
  724. <span class="k">return</span> <span class="n">state_seq</span><span class="p">,</span> <span class="n">obs_seq</span>
  725. </pre></div>
  726. </div>
  727. </div>
  728. </div>
  729. <div class="cell docutils container">
  730. <div class="cell_input docutils container">
  731. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1">#@partial(jit, static_argnums=(1,))</span>
  732. <span class="k">def</span> <span class="nf">hmm_sample2</span><span class="p">(</span><span class="n">rng_key</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="n">seq_len</span><span class="p">):</span>
  733. <span class="n">trans_mat</span><span class="p">,</span> <span class="n">obs_mat</span><span class="p">,</span> <span class="n">init_dist</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">trans_mat</span><span class="p">,</span> <span class="n">params</span><span class="o">.</span><span class="n">obs_mat</span><span class="p">,</span> <span class="n">params</span><span class="o">.</span><span class="n">init_dist</span>
  734. <span class="n">n_states</span><span class="p">,</span> <span class="n">n_obs</span> <span class="o">=</span> <span class="n">obs_mat</span><span class="o">.</span><span class="n">shape</span>
  735. <span class="k">def</span> <span class="nf">draw_state</span><span class="p">(</span><span class="n">prev_state</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
  736. <span class="n">state</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">n_states</span><span class="p">,</span> <span class="n">p</span><span class="o">=</span><span class="n">trans_mat</span><span class="p">[</span><span class="n">prev_state</span><span class="p">])</span>
  737. <span class="k">return</span> <span class="n">state</span><span class="p">,</span> <span class="n">state</span>
  738. <span class="n">rng_key</span><span class="p">,</span> <span class="n">rng_state</span><span class="p">,</span> <span class="n">rng_obs</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">rng_key</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
  739. <span class="n">keys</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">rng_state</span><span class="p">,</span> <span class="n">seq_len</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
  740. <span class="n">initial_state</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">rng_key</span><span class="p">,</span> <span class="n">n_states</span><span class="p">,</span> <span class="n">p</span><span class="o">=</span><span class="n">init_dist</span><span class="p">)</span>
  741. <span class="n">final_state</span><span class="p">,</span> <span class="n">states</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">lax</span><span class="o">.</span><span class="n">scan</span><span class="p">(</span><span class="n">draw_state</span><span class="p">,</span> <span class="n">initial_state</span><span class="p">,</span> <span class="n">keys</span><span class="p">)</span>
  742. <span class="n">state_seq</span> <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">jnp</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="n">initial_state</span><span class="p">]),</span> <span class="n">states</span><span class="p">)</span>
  743. <span class="k">def</span> <span class="nf">draw_obs</span><span class="p">(</span><span class="n">z</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
  744. <span class="n">obs</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">n_obs</span><span class="p">,</span> <span class="n">p</span><span class="o">=</span><span class="n">obs_mat</span><span class="p">[</span><span class="n">z</span><span class="p">])</span>
  745. <span class="k">return</span> <span class="n">obs</span>
  746. <span class="n">keys</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">rng_obs</span><span class="p">,</span> <span class="n">seq_len</span><span class="p">)</span>
  747. <span class="n">obs_seq</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">vmap</span><span class="p">(</span><span class="n">draw_obs</span><span class="p">,</span> <span class="n">in_axes</span><span class="o">=</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">))(</span><span class="n">state_seq</span><span class="p">,</span> <span class="n">keys</span><span class="p">)</span>
  748. <span class="k">return</span> <span class="n">state_seq</span><span class="p">,</span> <span class="n">obs_seq</span>
  749. </pre></div>
  750. </div>
  751. </div>
  752. </div>
  753. <div class="cell docutils container">
  754. <div class="cell_input docutils container">
  755. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">key</span> <span class="o">=</span> <span class="n">PRNGKey</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
  756. <span class="n">seq_len</span> <span class="o">=</span> <span class="mi">100</span>
  757. <span class="n">state_seq</span><span class="p">,</span> <span class="n">obs_seq</span> <span class="o">=</span> <span class="n">hmm_sample</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="n">seq_len</span><span class="p">)</span>
  758. <span class="nb">print</span><span class="p">(</span><span class="n">state_seq</span><span class="p">)</span>
  759. <span class="nb">print</span><span class="p">(</span><span class="n">obs_seq</span><span class="p">)</span>
  760. </pre></div>
  761. </div>
  762. </div>
  763. <div class="cell_output docutils container">
  764. <div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>[1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0
  765. 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1
  766. 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0]
  767. [5 5 2 2 0 0 0 1 3 3 2 2 5 1 5 1 0 2 2 4 2 5 1 5 5 0 0 4 2 4 3 2 3 4 1 0 5
  768. 2 2 2 1 4 3 2 2 2 4 1 0 3 5 2 5 1 4 2 5 2 5 0 5 4 4 4 2 2 0 4 5 2 2 0 1 5
  769. 1 3 4 5 1 5 0 5 1 5 1 2 4 5 3 4 5 4 0 4 0 2 4 5 3 3]
  770. </pre></div>
  771. </div>
  772. </div>
  773. </div>
  774. </div>
  775. <div class="section" id="check-correctness-by-computing-empirical-pairwise-statistics">
  776. <h3>Check correctness by computing empirical pairwise statistics<a class="headerlink" href="#check-correctness-by-computing-empirical-pairwise-statistics" title="Permalink to this headline">¶</a></h3>
  777. <p>We will compute the number of i-&gt;j transitions, and check that it is close to the true
  778. A[i,j] transition probabilites.</p>
  779. <div class="cell docutils container">
  780. <div class="cell_input docutils container">
  781. <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">collections</span>
  782. <span class="k">def</span> <span class="nf">compute_counts</span><span class="p">(</span><span class="n">state_seq</span><span class="p">,</span> <span class="n">nstates</span><span class="p">):</span>
  783. <span class="n">wseq</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">state_seq</span><span class="p">)</span>
  784. <span class="n">word_pairs</span> <span class="o">=</span> <span class="p">[</span><span class="n">pair</span> <span class="k">for</span> <span class="n">pair</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">wseq</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">wseq</span><span class="p">[</span><span class="mi">1</span><span class="p">:])]</span>
  785. <span class="n">counter_pairs</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">Counter</span><span class="p">(</span><span class="n">word_pairs</span><span class="p">)</span>
  786. <span class="n">counts</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="n">nstates</span><span class="p">,</span> <span class="n">nstates</span><span class="p">))</span>
  787. <span class="k">for</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="p">)</span> <span class="ow">in</span> <span class="n">counter_pairs</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
  788. <span class="n">counts</span><span class="p">[</span><span class="n">k</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">k</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span> <span class="o">=</span> <span class="n">v</span>
  789. <span class="k">return</span> <span class="n">counts</span>
  790. <span class="k">def</span> <span class="nf">normalize_counts</span><span class="p">(</span><span class="n">counts</span><span class="p">):</span>
  791. <span class="n">ncounts</span> <span class="o">=</span> <span class="n">vmap</span><span class="p">(</span><span class="k">lambda</span> <span class="n">v</span><span class="p">:</span> <span class="n">normalize</span><span class="p">(</span><span class="n">v</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="n">in_axes</span><span class="o">=</span><span class="mi">0</span><span class="p">)(</span><span class="n">counts</span><span class="p">)</span>
  792. <span class="k">return</span> <span class="n">ncounts</span>
  793. <span class="n">init_dist</span> <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">])</span>
  794. <span class="n">trans_mat</span> <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mf">0.7</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">]])</span>
  795. <span class="n">rng_key</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">PRNGKey</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
  796. <span class="n">seq_len</span> <span class="o">=</span> <span class="mi">500</span>
  797. <span class="n">state_seq</span> <span class="o">=</span> <span class="n">markov_chain_sample</span><span class="p">(</span><span class="n">rng_key</span><span class="p">,</span> <span class="n">init_dist</span><span class="p">,</span> <span class="n">trans_mat</span><span class="p">,</span> <span class="n">seq_len</span><span class="p">)</span>
  798. <span class="nb">print</span><span class="p">(</span><span class="n">state_seq</span><span class="p">)</span>
  799. <span class="n">counts</span> <span class="o">=</span> <span class="n">compute_counts</span><span class="p">(</span><span class="n">state_seq</span><span class="p">,</span> <span class="n">nstates</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
  800. <span class="nb">print</span><span class="p">(</span><span class="n">counts</span><span class="p">)</span>
  801. <span class="n">trans_mat_empirical</span> <span class="o">=</span> <span class="n">normalize_counts</span><span class="p">(</span><span class="n">counts</span><span class="p">)</span>
  802. <span class="nb">print</span><span class="p">(</span><span class="n">trans_mat_empirical</span><span class="p">)</span>
  803. <span class="k">assert</span> <span class="n">jnp</span><span class="o">.</span><span class="n">allclose</span><span class="p">(</span><span class="n">trans_mat</span><span class="p">,</span> <span class="n">trans_mat_empirical</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="mf">1e-1</span><span class="p">)</span>
  804. </pre></div>
  805. </div>
  806. </div>
  807. <div class="cell_output docutils container">
  808. <div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>[0 0 1 1 1 1 0 0 1 1 1 0 1 0 0 1 1 1 1 0 1 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 1
  809. 1 0 0 0 0 1 0 1 0 0 0 0 1 0 0 1 1 0 1 1 0 1 1 0 1 1 1 0 0 1 1 0 1 0 0 1 0
  810. 1 0 0 0 0 0 0 0 0 0 0 1 1 1 1 0 0 0 1 1 1 0 1 0 0 0 0 1 0 0 0 0 1 1 0 0 0
  811. 0 0 1 1 1 1 1 1 0 0 0 1 1 0 0 0 0 0 1 0 0 0 1 0 1 1 0 1 1 0 0 0 0 0 0 1 0
  812. 0 0 0 1 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 1 1 1 1 0 1 1 0 0 0 0 0 1 0 0 0 0
  813. 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 1 0 0 0 1 1 1 0 0 0 1 1 0 0 0
  814. 0 0 0 1 1 1 0 0 0 0 1 0 0 1 1 1 0 1 1 1 1 1 0 1 1 0 0 0 1 1 0 1 0 0 1 0 0
  815. 0 0 0 1 0 0 0 1 0 1 0 0 0 0 1 0 0 1 0 0 0 1 1 0 0 0 0 0 0 0 1 0 0 1 1 1 1
  816. 1 1 0 0 0 0 0 1 1 0 0 0 0 0 0 1 0 0 1 0 0 0 0 0 0 1 0 0 0 0 1 0 1 0 0 0 1
  817. 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 0 1 0 0 1 1 0 1 0 0 0
  818. 0 0 0 0 0 0 0 1 0 0 1 1 1 1 0 0 1 1 0 0 0 0 1 1 0 1 1 0 0 0 0 0 0 0 0 1 0
  819. 1 0 1 0 1 0 0 0 0 1 0 0 0 0 0 0 0 0 1 0 1 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0
  820. 0 0 0 0 1 0 0 1 1 0 1 1 0 0 0 0 0 0 0 0 0 0 1 0 1 0 0 0 1 1 0 0 1 1 0 0 1
  821. 1 0 0 0 0 0 0 0 1 0 0 1 1 0 0 0 0 1 1]
  822. [[244. 93.]
  823. [ 92. 70.]]
  824. [[0.7240356 0.27596438]
  825. [0.56790125 0.43209878]]
  826. </pre></div>
  827. </div>
  828. </div>
  829. </div>
  830. </div>
  831. </div>
  832. </div>
  833. <script type="text/x-thebe-config">
  834. {
  835. requestKernel: true,
  836. binderOptions: {
  837. repo: "binder-examples/jupyter-stacks-datascience",
  838. ref: "master",
  839. },
  840. codeMirrorConfig: {
  841. theme: "abcdef",
  842. mode: "python"
  843. },
  844. kernelOptions: {
  845. kernelName: "python3",
  846. path: "./chapters/hmm"
  847. },
  848. predefinedOutput: true
  849. }
  850. </script>
  851. <script>kernelName = 'python3'</script>
  852. </div>
  853. <!-- Previous / next buttons -->
  854. <div class='prev-next-area'>
  855. </div>
  856. </div>
  857. </div>
  858. <footer class="footer">
  859. <p>
  860. By Kevin Murphy, Scott Linderman, et al.<br/>
  861. &copy; Copyright 2021.<br/>
  862. </p>
  863. </footer>
  864. </main>
  865. </div>
  866. </div>
  867. <script src="../../_static/js/index.be7d3bbb2ef33a8344ce.js"></script>
  868. </body>
  869. </html>