{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# Profiling the Compiler\n", "\n", "This notebook describes new features added in version 0.53 to help users measure time spent in the compiler." ] }, { "cell_type": "code", "execution_count": 1, "metadata": {}, "outputs": [], "source": [ "from numba.core import config\n", "# This is needed for recording LLVM pass timings used \n", "# later in this notebook.\n", "config.LLVM_PASS_TIMINGS = 1" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Tracking Compilation Events" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "In Numba 0.53, a simple [event API](https://numba.readthedocs.io/en/0.53.0/developer/event_api.html) is implemented to allow users to track specific compilation events. This section will describe how it can be used to record compilation events within a region of code." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "We will measure the following function." ] }, { "cell_type": "code", "execution_count": 2, "metadata": {}, "outputs": [], "source": [ "import numpy as np\n", "import numba\n", "assert numba.version_info.short >= (0, 53)\n", "from numba import njit" ] }, { "cell_type": "code", "execution_count": 3, "metadata": {}, "outputs": [], "source": [ "# The function to record\n", "@njit\n", "def foo(x):\n", " out = [4, 5, 6, 7]\n", " out.sort()\n", " return np.linalg.svd(x), out" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "To record a specific event for later processing, users can use [`install_recorder()`](https://numba.readthedocs.io/en/0.53.0/developer/event_api.html#numba.core.event.install_recorder)" ] }, { "cell_type": "code", "execution_count": 4, "metadata": {}, "outputs": [], "source": [ "from numba.core.event import install_recorder\n", "\n", "# Record all compilation events\n", "with install_recorder(\"numba:compile\") as rec:\n", " foo(np.ones((2, 2)))" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The above stores the recorded `numba:compile` events as a `list` into `rec.buffer`. Each item is a 2-tuple of `(timestamp, Event)`." ] }, { "cell_type": "code", "execution_count": 5, "metadata": {}, "outputs": [ { "data": { "text/plain": [ "[(1616078243.82092, Event(numba:compile, EventStatus.START, data: dict)),\n", " (1616078243.910625, Event(numba:compile, EventStatus.START, data: dict)),\n", " (1616078243.939735, Event(numba:compile, EventStatus.START, data: dict))]" ] }, "execution_count": 5, "metadata": {}, "output_type": "execute_result" } ], "source": [ "rec.buffer[:3]" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The following prepares the data for plotting:" ] }, { "cell_type": "code", "execution_count": 6, "metadata": {}, "outputs": [], "source": [ "def organize_events(rec):\n", " \"\"\"Combine START and END events.\n", " \"\"\"\n", " events = []\n", " temp = {}\n", " \n", " for ts, ev in rec.buffer:\n", " ed = ev.data\n", " k = ed['dispatcher'], ed['args']\n", " # If it's the start event\n", " if ev.is_start:\n", " # record the dispatcher name, type signature and start time\n", " temp[k] = ev, ts\n", " # Else, it's the end event\n", " else:\n", " # save 4-tuple of (start_event, end_event, start_time, end_time)\n", " ev_start, tt = temp[k]\n", " events.append((ev_start, ev, tt, ts))\n", " return events\n", "\n", "def group_data(events):\n", " \"\"\"Group the event timings into a simple column format in a dict.\n", " \n", " Returns a dict with 3 keys: \"start_times\", \"end_times\", and \"events\".\n", " \"\"\"\n", " names = []\n", " start_times = []\n", " end_times = []\n", " for i, (s, e, ts, te) in enumerate(events):\n", " names.append(f\"{s.data['dispatcher'].py_func.__name__}{s.data['args']}-[{i}]\")\n", " start_times.append(ts) \n", " end_times.append(te)\n", "\n", " # Rebase timestamp to the first compilation event\n", " base = np.min(start_times)\n", " start_times -= base\n", " end_times -= base\n", "\n", " source = {\n", " \"start_times\": start_times,\n", " \"end_times\": end_times,\n", " \"events\": names,\n", " }\n", " return source\n", "\n", "source = group_data(organize_events(rec))" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "We will use bokeh to render the compilation events." ] }, { "cell_type": "code", "execution_count": 7, "metadata": {}, "outputs": [ { "data": { "text/html": [ "\n", "
" ] }, "metadata": {}, "output_type": "display_data" }, { "data": { "application/javascript": [ "\n", "(function(root) {\n", " function now() {\n", " return new Date();\n", " }\n", "\n", " var force = true;\n", "\n", " if (typeof root._bokeh_onload_callbacks === \"undefined\" || force === true) {\n", " root._bokeh_onload_callbacks = [];\n", " root._bokeh_is_loading = undefined;\n", " }\n", "\n", " var JS_MIME_TYPE = 'application/javascript';\n", " var HTML_MIME_TYPE = 'text/html';\n", " var EXEC_MIME_TYPE = 'application/vnd.bokehjs_exec.v0+json';\n", " var CLASS_NAME = 'output_bokeh rendered_html';\n", "\n", " /**\n", " * Render data to the DOM node\n", " */\n", " function render(props, node) {\n", " var script = document.createElement(\"script\");\n", " node.appendChild(script);\n", " }\n", "\n", " /**\n", " * Handle when an output is cleared or removed\n", " */\n", " function handleClearOutput(event, handle) {\n", " var cell = handle.cell;\n", "\n", " var id = cell.output_area._bokeh_element_id;\n", " var server_id = cell.output_area._bokeh_server_id;\n", " // Clean up Bokeh references\n", " if (id != null && id in Bokeh.index) {\n", " Bokeh.index[id].model.document.clear();\n", " delete Bokeh.index[id];\n", " }\n", "\n", " if (server_id !== undefined) {\n", " // Clean up Bokeh references\n", " var cmd = \"from bokeh.io.state import curstate; print(curstate().uuid_to_server['\" + server_id + \"'].get_sessions()[0].document.roots[0]._id)\";\n", " cell.notebook.kernel.execute(cmd, {\n", " iopub: {\n", " output: function(msg) {\n", " var id = msg.content.text.trim();\n", " if (id in Bokeh.index) {\n", " Bokeh.index[id].model.document.clear();\n", " delete Bokeh.index[id];\n", " }\n", " }\n", " }\n", " });\n", " // Destroy server and session\n", " var cmd = \"import bokeh.io.notebook as ion; ion.destroy_server('\" + server_id + \"')\";\n", " cell.notebook.kernel.execute(cmd);\n", " }\n", " }\n", "\n", " /**\n", " * Handle when a new output is added\n", " */\n", " function handleAddOutput(event, handle) {\n", " var output_area = handle.output_area;\n", " var output = handle.output;\n", "\n", " // limit handleAddOutput to display_data with EXEC_MIME_TYPE content only\n", " if ((output.output_type != \"display_data\") || (!Object.prototype.hasOwnProperty.call(output.data, EXEC_MIME_TYPE))) {\n", " return\n", " }\n", "\n", " var toinsert = output_area.element.find(\".\" + CLASS_NAME.split(' ')[0]);\n", "\n", " if (output.metadata[EXEC_MIME_TYPE][\"id\"] !== undefined) {\n", " toinsert[toinsert.length - 1].firstChild.textContent = output.data[JS_MIME_TYPE];\n", " // store reference to embed id on output_area\n", " output_area._bokeh_element_id = output.metadata[EXEC_MIME_TYPE][\"id\"];\n", " }\n", " if (output.metadata[EXEC_MIME_TYPE][\"server_id\"] !== undefined) {\n", " var bk_div = document.createElement(\"div\");\n", " bk_div.innerHTML = output.data[HTML_MIME_TYPE];\n", " var script_attrs = bk_div.children[0].attributes;\n", " for (var i = 0; i < script_attrs.length; i++) {\n", " toinsert[toinsert.length - 1].firstChild.setAttribute(script_attrs[i].name, script_attrs[i].value);\n", " toinsert[toinsert.length - 1].firstChild.textContent = bk_div.children[0].textContent\n", " }\n", " // store reference to server id on output_area\n", " output_area._bokeh_server_id = output.metadata[EXEC_MIME_TYPE][\"server_id\"];\n", " }\n", " }\n", "\n", " function register_renderer(events, OutputArea) {\n", "\n", " function append_mime(data, metadata, element) {\n", " // create a DOM node to render to\n", " var toinsert = this.create_output_subarea(\n", " metadata,\n", " CLASS_NAME,\n", " EXEC_MIME_TYPE\n", " );\n", " this.keyboard_manager.register_events(toinsert);\n", " // Render to node\n", " var props = {data: data, metadata: metadata[EXEC_MIME_TYPE]};\n", " render(props, toinsert[toinsert.length - 1]);\n", " element.append(toinsert);\n", " return toinsert\n", " }\n", "\n", " /* Handle when an output is cleared or removed */\n", " events.on('clear_output.CodeCell', handleClearOutput);\n", " events.on('delete.Cell', handleClearOutput);\n", "\n", " /* Handle when a new output is added */\n", " events.on('output_added.OutputArea', handleAddOutput);\n", "\n", " /**\n", " * Register the mime type and append_mime function with output_area\n", " */\n", " OutputArea.prototype.register_mime_type(EXEC_MIME_TYPE, append_mime, {\n", " /* Is output safe? */\n", " safe: true,\n", " /* Index of renderer in `output_area.display_order` */\n", " index: 0\n", " });\n", " }\n", "\n", " // register the mime type if in Jupyter Notebook environment and previously unregistered\n", " if (root.Jupyter !== undefined) {\n", " var events = require('base/js/events');\n", " var OutputArea = require('notebook/js/outputarea').OutputArea;\n", "\n", " if (OutputArea.prototype.mime_types().indexOf(EXEC_MIME_TYPE) == -1) {\n", " register_renderer(events, OutputArea);\n", " }\n", " }\n", "\n", " \n", " if (typeof (root._bokeh_timeout) === \"undefined\" || force === true) {\n", " root._bokeh_timeout = Date.now() + 5000;\n", " root._bokeh_failed_load = false;\n", " }\n", "\n", " var NB_LOAD_WARNING = {'data': {'text/html':\n", " \"\\n\"+\n", " \"BokehJS does not appear to have successfully loaded. If loading BokehJS from CDN, this \\n\"+\n", " \"may be due to a slow or bad network connection. Possible fixes:\\n\"+\n", " \"
\\n\"+\n", " \"\\n\"+\n",
" \"from bokeh.resources import INLINE\\n\"+\n",
" \"output_notebook(resources=INLINE)\\n\"+\n",
" \"
\\n\"+\n",
" \"