From 1f2844ac721f0aebfe24b5e2f8e967a64aa6313d Mon Sep 17 00:00:00 2001 From: Bryan Paget <8212170+bryanpaget@users.noreply.github.com> Date: Tue, 12 Dec 2023 14:27:26 +0000 Subject: [PATCH] feat(rerun): remove description from viewer --- .../en/1-Experiments/Notebooks/ReRun_EN.ipynb | 300 +++++++++++++----- 1 file changed, 229 insertions(+), 71 deletions(-) diff --git a/docs/en/1-Experiments/Notebooks/ReRun_EN.ipynb b/docs/en/1-Experiments/Notebooks/ReRun_EN.ipynb index 375169b71..57f201205 100644 --- a/docs/en/1-Experiments/Notebooks/ReRun_EN.ipynb +++ b/docs/en/1-Experiments/Notebooks/ReRun_EN.ipynb @@ -39,7 +39,7 @@ }, { "cell_type": "code", - "execution_count": null, + "execution_count": 17, "id": "d9f41c51-e09f-4a37-b5e6-3ff4766001ea", "metadata": { "tags": [] @@ -72,10 +72,67 @@ }, { "cell_type": "code", - "execution_count": null, + "execution_count": 18, "id": "e9918233", "metadata": {}, - "outputs": [], + "outputs": [ + { + "name": "stderr", + "output_type": "stream", + "text": [ + "[2023-12-12T14:22:40Z WARN re_sdk::log_sink] Dropping data in MemorySink\n", + "[2023-12-12T14:22:40Z WARN re_sdk::log_sink] Dropping data in MemorySink\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "
\n", + "

Timed out waiting for https://app.rerun.io/commit/61e3de1 to load.

\n", + "

Consider using rr.start_web_viewer_server()

\n", + " \n", + " \n", + " " + ], + "text/plain": [ + "" + ] + }, + "execution_count": 18, + "metadata": {}, + "output_type": "execute_result" + } + ], "source": [ "import rerun as rr\n", "\n", @@ -93,10 +150,59 @@ }, { "cell_type": "code", - "execution_count": null, + "execution_count": 19, "id": "a7127bbc", "metadata": {}, - "outputs": [], + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "
\n", + "

Timed out waiting for https://app.rerun.io/commit/61e3de1 to load.

\n", + "

Consider using rr.start_web_viewer_server()

\n", + " \n", + " \n", + " " + ], + "text/plain": [ + "" + ] + }, + "execution_count": 19, + "metadata": {}, + "output_type": "execute_result" + } + ], "source": [ "import rerun as rr\n", "import numpy as np\n", @@ -162,10 +268,67 @@ }, { "cell_type": "code", - "execution_count": null, + "execution_count": 24, "id": "e9bd9a87", "metadata": {}, - "outputs": [], + "outputs": [ + { + "name": "stderr", + "output_type": "stream", + "text": [ + "[2023-12-12T14:26:49Z WARN re_sdk::log_sink] Dropping data in MemorySink\n", + "[2023-12-12T14:26:49Z WARN re_sdk::log_sink] Dropping data in MemorySink\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "
\n", + "

Timed out waiting for https://app.rerun.io/commit/61e3de1 to load.

\n", + "

Consider using rr.start_web_viewer_server()

\n", + " \n", + " \n", + " " + ], + "text/plain": [ + "" + ] + }, + "execution_count": 24, + "metadata": {}, + "output_type": "execute_result" + } + ], "source": [ "from __future__ import annotations\n", "\n", @@ -177,42 +340,8 @@ "import rerun as rr # pip install rerun-sdk\n", "from rerun.utilities import bounce_lerp, build_color_spiral\n", "\n", - "DESCRIPTION = \"\"\"\n", - "# DNA\n", - "This is a minimal example that logs synthetic 3D data in the shape of a double helix. The underlying data is generated\n", - "using numpy and visualized using Rerun.\n", - "\n", - "## How it was made\n", - "The full source code for this example is available\n", - "[on GitHub](https://github.com/rerun-io/rerun/blob/latest/examples/python/dna/main.py).\n", - "\n", - "### Colored 3D points\n", - "The colored 3D points were added to the scene by logging the\n", - "[rr.Points3D archetype](https://www.rerun.io/docs/reference/types/archetypes/points3d) to the\n", - "[helix/structure/left](recording://helix/structure/left) and [helix/structure/right](recording://helix/structure/right)\n", - "entities.\n", - "\n", - "### 3D line strips\n", - "The 3D line strips connecting the 3D point pairs are logged as an\n", - "[rr.LineStrips3D archetype](https://www.rerun.io/docs/reference/types/archetypes/line_strips3d) to the\n", - "[helix/structure/scaffolding entity](recording://helix/structure/scaffolding).\n", - "\n", - "### Rotation\n", - "The whole structure is rotated over time by logging a\n", - "[rr.Transform3D archetype](https://www.rerun.io/docs/reference/types/archetypes/transform3d) to the\n", - "[helix/structure entity](recording://helix/structure.Transform3D) that changes over time. This transform determines the rotation of\n", - "the [structure entity](recording://helix/structure) relative to the [helix](recording://helix) entity. Since all other\n", - "entities are children of [helix/structure](recording://helix/structure) they will also rotate based on this transform.\n", - "\n", - "You can visualize this rotation by selecting the two entities on the left-hand side and activating `Show transform` in\n", - "the Blueprint settings on the right-hand side. You will see one static frame (i.e., the frame of\n", - "[helix](recording://helix)) and the rotating frame (i.e., the frame of [structure](recording://helix/structure)).\n", - "\"\"\".strip()\n", - "\n", "rec = rr.memory_recording()\n", "\n", - "rr.log(\"description\", rr.TextDocument(DESCRIPTION, media_type=rr.MediaType.MARKDOWN), timeless=True)\n", - "\n", "rr.set_time_seconds(\"stable_time\", 0)\n", "\n", "NUM_POINTS = 100\n", @@ -278,10 +407,67 @@ }, { "cell_type": "code", - "execution_count": null, + "execution_count": 23, "id": "de21e1f2", "metadata": {}, - "outputs": [], + "outputs": [ + { + "name": "stderr", + "output_type": "stream", + "text": [ + "[2023-12-12T14:25:55Z WARN re_sdk::log_sink] Dropping data in MemorySink\n", + "[2023-12-12T14:25:55Z WARN re_sdk::log_sink] Dropping data in MemorySink\n" + ] + }, + { + "data": { + "text/html": [ + "\n", + "
\n", + "

Timed out waiting for https://app.rerun.io/commit/61e3de1 to load.

\n", + "

Consider using rr.start_web_viewer_server()

\n", + " \n", + " \n", + " " + ], + "text/plain": [ + "" + ] + }, + "execution_count": 23, + "metadata": {}, + "output_type": "execute_result" + } + ], "source": [ "from __future__ import annotations\n", "\n", @@ -292,32 +478,6 @@ "import numpy as np\n", "import rerun as rr # pip install rerun-sdk\n", "\n", - "DESCRIPTION = \"\"\"\n", - "# Plots\n", - "This example shows various plot types that you can create using Rerun. Common usecases for such plots would be logging\n", - "losses or metrics over time, histograms, or general function plots.\n", - "\n", - "## How it was made\n", - "The full source code for this example is available [on GitHub](https://github.com/rerun-io/rerun/blob/latest/examples/python/plots/main.py).\n", - "\n", - "### Bar charts\n", - "The [bar chart](recording://bar_chart) is created by logging the [rr.BarChart archetype](https://www.rerun.io/docs/reference/types/archetypes/bar_chart).\n", - "\n", - "### Time series\n", - "All other plots are created using the\n", - "[rr.TimeSeriesScalar archetype](https://www.rerun.io/docs/reference/types/archetypes/bar_chart)\n", - "with different settings. Each plot is created by logging scalars at different time steps (i.e., the x-axis).\n", - "\n", - "For the [parabola](recording://curves/parabola) the radius and color is changed over time.\n", - "\n", - "[sin](recording://trig/sin) and [cos](recording://trig/cos) are logged with the same parent entity (i.e.,\n", - "`trig/{cos,sin}`) which will put them in the same view by default.\n", - "\n", - "For the [classification samples](recording://classification/samples) `rr.TimeSeriesScalar(..., scatter=True)` is used to\n", - "create separate points that do not connect over time. Note, that in the other plots the logged scalars are connected\n", - "over time by lines.\n", - "\"\"\".strip()\n", - "\n", "rec = rr.memory_recording()\n", "\n", "def clamp(n, smallest, largest): # type: ignore[no-untyped-def]\n", @@ -391,8 +551,6 @@ " rr.log(\"classification/samples\", rr.TimeSeriesScalar(g_of_t, color=color, scattered=True, radius=radius))\n", "\n", "\n", - "\n", - "rr.log(\"description\", rr.TextDocument(DESCRIPTION, media_type=rr.MediaType.MARKDOWN), timeless=True)\n", "log_bar_chart()\n", "log_parabola()\n", "log_trig()\n",