mirror of
https://github.com/saymrwulf/prophet.git
synced 2026-11-17 08:40:56 +00:00
Style: Adding a method docstring (#1627)
Adding a docstring to the `stan_init()` method of `additional_topics.ipynb` notebook
This commit is contained in:
parent
75ec9dffb1
commit
c7c63ff568
1 changed files with 18 additions and 3 deletions
|
|
@ -55,6 +55,21 @@
|
||||||
],
|
],
|
||||||
"source": [
|
"source": [
|
||||||
"def stan_init(m):\n",
|
"def stan_init(m):\n",
|
||||||
|
" \"\"\"Retrieving parameters from a trained model.\n",
|
||||||
|
" \n",
|
||||||
|
" Retrieved parameters from a trained model \n",
|
||||||
|
" of the Prophet() Class,are used to initialise \n",
|
||||||
|
" parameters for a new model. This can help \n",
|
||||||
|
" speed up training, especially if new data\n",
|
||||||
|
" follows the same trend as the historical data.\n",
|
||||||
|
" \n",
|
||||||
|
" @Param\n",
|
||||||
|
" m: A trained model of the Prophet() Class\n",
|
||||||
|
" \n",
|
||||||
|
" @Return\n",
|
||||||
|
" res: A Dictionary containing retrieved parameters of m\n",
|
||||||
|
" \n",
|
||||||
|
" \"\"\"\n",
|
||||||
" res = {}\n",
|
" res = {}\n",
|
||||||
" for pname in ['k', 'm', 'sigma_obs']:\n",
|
" for pname in ['k', 'm', 'sigma_obs']:\n",
|
||||||
" res[pname] = m.params[pname][0][0]\n",
|
" res[pname] = m.params[pname][0][0]\n",
|
||||||
|
|
@ -84,9 +99,9 @@
|
||||||
],
|
],
|
||||||
"metadata": {
|
"metadata": {
|
||||||
"kernelspec": {
|
"kernelspec": {
|
||||||
"display_name": "Python (fbprophet)",
|
"display_name": "Python 3",
|
||||||
"language": "python",
|
"language": "python",
|
||||||
"name": "fbprophet"
|
"name": "python3"
|
||||||
},
|
},
|
||||||
"language_info": {
|
"language_info": {
|
||||||
"codemirror_mode": {
|
"codemirror_mode": {
|
||||||
|
|
@ -98,7 +113,7 @@
|
||||||
"name": "python",
|
"name": "python",
|
||||||
"nbconvert_exporter": "python",
|
"nbconvert_exporter": "python",
|
||||||
"pygments_lexer": "ipython3",
|
"pygments_lexer": "ipython3",
|
||||||
"version": "3.7.0"
|
"version": "3.8.5"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"nbformat": 4,
|
"nbformat": 4,
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue