Skip to content

docs(notebooks): add google colab badge and install cell to model construction notebook #406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
conorheins merged 5 commits into from
May 26, 2026
Merged

docs(notebooks): add google colab badge and install cell to model construction notebook #406

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c16e526
Add google colab badge and install cell to model construction notebook
Arun-Niranjan May 25, 2026
e7cfd15
install vanilla pymdp as colab already ships with JAX
Arun-Niranjan May 25, 2026
0e342f0
Clear outputs
Arun-Niranjan May 25, 2026
f9b07f4
Generate outputs
Arun-Niranjan May 25, 2026
8e21022
run precommit to sanitise notebook
Arun-Niranjan May 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 60 additions & 35 deletions examples/api/model_construction_tutorial.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/infer-actively/pymdp/blob/main/examples/api/model_construction_tutorial.ipynb)"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down Expand Up @@ -29,7 +36,18 @@
},
{
"cell_type": "code",
"execution_count": 2,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"import sys\n",
"if \"google.colab\" in sys.modules:\n",
" %pip install \"inferactively-pymdp\" -q"
Comment on lines +43 to +45

@Arun-Niranjan Arun-Niranjan May 25, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

logic:

  • we only run this install if we are in a colab space
  • we can install the vanilla dependencies, as colab ships with JAX and CUDA support already there. (in fact if you try %pip install "inferactively-pymdp[gpu]" -q you get an error)

]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -44,7 +62,7 @@
},
{
"cell_type": "code",
"execution_count": 3,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -83,7 +101,7 @@
},
{
"cell_type": "code",
"execution_count": 4,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -122,7 +140,7 @@
},
{
"cell_type": "code",
"execution_count": 5,
"execution_count": 1,
"metadata": {},
"outputs": [
{
Expand All @@ -133,6 +151,14 @@
"Goal position: center_left\n",
"Action chosen: move_right\n"
]
},
{
"name": "stderr",
"output_type": "stream",
"text": [
"/tmp/ipykernel_1062531/1053406980.py:4: UserWarning: A JAX array is being set as static! This can result in unexpected behavior and is usually a mistake to do.\n",
" agent = Agent(**model, gamma=gamma)\n"
]
}
],
"source": [
Expand Down Expand Up @@ -168,7 +194,7 @@
},
{
"cell_type": "code",
"execution_count": 6,
"execution_count": 2,
"metadata": {},
"outputs": [
{
Expand All @@ -185,6 +211,14 @@
"Agent 1's action chosen: move_left\n",
"Agent 2's action chosen: move_left\n"
]
},
{
"name": "stderr",
"output_type": "stream",
"text": [
"/tmp/ipykernel_1062531/1678643109.py:5: UserWarning: A JAX array is being set as static! This can result in unexpected behavior and is usually a mistake to do.\n",
" agent = Agent(**model, batch_size=batch_size, gamma=gamma)\n"
]
}
],
"source": [
Expand Down Expand Up @@ -227,7 +261,7 @@
},
{
"cell_type": "code",
"execution_count": 7,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -294,7 +328,7 @@
},
{
"cell_type": "code",
"execution_count": 8,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -404,9 +438,18 @@
},
{
"cell_type": "code",
"execution_count": 9,
"execution_count": 3,
"metadata": {},
"outputs": [],
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"/tmp/ipykernel_1062531/53738707.py:3: UserWarning: A JAX array is being set as static! This can result in unexpected behavior and is usually a mistake to do.\n",
" agent = Agent(**model, learn_A=False, learn_B=False, gamma=gamma, sampling_mode=\"full\")\n"
]
}
],
"source": [
"gamma = 1.0\n",
"\n",
Expand All @@ -422,7 +465,7 @@
},
{
"cell_type": "code",
"execution_count": 10,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -440,7 +483,7 @@
},
{
"cell_type": "code",
"execution_count": 11,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -458,7 +501,7 @@
},
{
"cell_type": "code",
"execution_count": 12,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -469,7 +512,7 @@
},
{
"cell_type": "code",
"execution_count": 13,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -478,7 +521,7 @@
},
{
"cell_type": "code",
"execution_count": 14,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -498,7 +541,7 @@
},
{
"cell_type": "code",
"execution_count": 15,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -519,33 +562,15 @@
},
{
"cell_type": "code",
"execution_count": 16,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"info, last = rollout(agent, env, num_timesteps=10, rng_key=jr.PRNGKey(0), env_params=env_params)"
]
}
],
"metadata": {
"kernelspec": {
"display_name": ".venv311",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.12"
}
},
"metadata": {},
"nbformat": 4,
"nbformat_minor": 2
}
Loading