Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jeguzzi committed Oct 29, 2024
1 parent 8660830 commit b698e81
Show file tree
Hide file tree
Showing 6 changed files with 102 additions and 86 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
project = 'navground'
copyright = '2023, Jérôme Guzzi, IDSIA'
author = 'Jérôme Guzzi, IDSIA'
release = '0.1.0'
release = '0.2.0'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
34 changes: 17 additions & 17 deletions docs/tutorials/Enviromental states and estimations.ipynb

Large diffs are not rendered by default.

90 changes: 45 additions & 45 deletions docs/tutorials/display.ipynb

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/tutorials/running_an_experiment.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
{
"data": {
"text/plain": [
"2.00086"
"2.042582"
]
},
"execution_count": 3,
Expand Down Expand Up @@ -166,7 +166,7 @@
{
"data": {
"text/plain": [
"PosixPath('experiment_2317153905871209610_2024-09-02_14-34-15/data.h5')"
"PosixPath('experiment_11604671950228722770_2024-10-29_15-20-49/data.h5')"
]
},
"execution_count": 4,
Expand Down Expand Up @@ -268,7 +268,7 @@
{
"data": {
"text/plain": [
"2.000860958"
"2.042582583"
]
},
"execution_count": 7,
Expand Down Expand Up @@ -409,7 +409,7 @@
{
"data": {
"text/plain": [
"0.973980166"
"1.005063833"
]
},
"execution_count": 12,
Expand Down Expand Up @@ -1026,7 +1026,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "23ffdb15a66c4613be2c916730e0ef68",
"model_id": "4005bed8e7dd46ebaa96b311a5197f5b",
"version_major": 2,
"version_minor": 0
},
Expand All @@ -1041,7 +1041,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
"Performed 20 runs in 7.477172 seconds over 4 processes \n"
"Performed 20 runs in 7.157424 seconds over 4 processes \n"
]
}
],
Expand Down Expand Up @@ -1078,7 +1078,7 @@
{
"data": {
"text/plain": [
"PosixPath('experiment_2317153905871209610_2024-09-02_14-34-19/data.h5')"
"PosixPath('experiment_11604671950228722770_2024-10-29_15-20-54/data.h5')"
]
},
"execution_count": 31,
Expand Down Expand Up @@ -1263,7 +1263,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.5"
"version": "3.12.7"
}
},
"nbformat": 4,
Expand Down
18 changes: 9 additions & 9 deletions docs/tutorials/running_an_experiment_no_hdf5.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
{
"data": {
"text/plain": [
"datetime.timedelta(seconds=1, microseconds=948885)"
"datetime.timedelta(seconds=2, microseconds=62148)"
]
},
"execution_count": 3,
Expand Down Expand Up @@ -147,8 +147,8 @@
{
"data": {
"text/plain": [
"{0: <navground.sim._navground_sim.ExperimentalRun at 0x102b324b0>,\n",
" 1: <navground.sim._navground_sim.ExperimentalRun at 0x10bb4af30>}"
"{0: <navground.sim._navground_sim.ExperimentalRun at 0x1048b31d0>,\n",
" 1: <navground.sim._navground_sim.ExperimentalRun at 0x1083298b0>}"
]
},
"execution_count": 4,
Expand Down Expand Up @@ -565,7 +565,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
"Performed 500 runs in 4.576514 seconds\n"
"Performed 500 runs in 4.784625 seconds\n"
]
}
],
Expand Down Expand Up @@ -660,7 +660,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "a59af2a3ff664edcb33b079e2f679e27",
"model_id": "6edea811dabb40e7a008a6d08d990697",
"version_major": 2,
"version_minor": 0
},
Expand All @@ -675,7 +675,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
"Performed 5000 runs in 12.604729 seconds over 4 threads \n"
"Performed 5000 runs in 13.878364 seconds over 4 threads \n"
]
}
],
Expand Down Expand Up @@ -713,7 +713,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "2d114bfaeb2c4d15b8961471db7e20d5",
"model_id": "0536e9a637594335b2c2907d8a1ef549",
"version_major": 2,
"version_minor": 0
},
Expand All @@ -728,7 +728,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
"Performed 5000 runs in 14.469892 seconds over 4 processes \n"
"Performed 5000 runs in 13.948182 seconds over 4 processes \n"
]
}
],
Expand Down Expand Up @@ -781,7 +781,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.5"
"version": "3.12.7"
}
},
"nbformat": 4,
Expand Down
28 changes: 22 additions & 6 deletions docs/tutorials/tour.ipynb

Large diffs are not rendered by default.

0 comments on commit b698e81

Please sign in to comment.