Spaces:
Running
Running
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> | |
| <meta charset="utf-8"> | |
| <meta name="generator" content="quarto-1.8.27"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> | |
| <meta name="author" content="Iliya Zhechev, Rado Ralev"> | |
| <meta name="dcterms.date" content="2026-03-25"> | |
| <meta name="description" content="How the langcache-customer-data-eval repo helps measure cache hit rate, precision, and threshold tradeoffs on your own query data."> | |
| <title>Evaluating Langcache on Your Data – AI Research @Redis</title> | |
| <style> | |
| code{white-space: pre-wrap;} | |
| span.smallcaps{font-variant: small-caps;} | |
| div.columns{display: flex; gap: min(4vw, 1.5em);} | |
| div.column{flex: auto; overflow-x: auto;} | |
| div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;} | |
| ul.task-list{list-style: none;} | |
| ul.task-list li input[type="checkbox"] { | |
| width: 0.8em; | |
| margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */ | |
| vertical-align: middle; | |
| } | |
| </style> | |
| <script src="../site_libs/quarto-nav/quarto-nav.js"></script> | |
| <script src="../site_libs/quarto-nav/headroom.min.js"></script> | |
| <script src="../site_libs/clipboard/clipboard.min.js"></script> | |
| <script src="../site_libs/quarto-search/autocomplete.umd.js"></script> | |
| <script src="../site_libs/quarto-search/fuse.min.js"></script> | |
| <script src="../site_libs/quarto-search/quarto-search.js"></script> | |
| <meta name="quarto:offset" content="../"> | |
| <script src="../site_libs/quarto-html/quarto.js" type="module"></script> | |
| <script src="../site_libs/quarto-html/tabsets/tabsets.js" type="module"></script> | |
| <script src="../site_libs/quarto-html/axe/axe-check.js" type="module"></script> | |
| <script src="../site_libs/quarto-html/popper.min.js"></script> | |
| <script src="../site_libs/quarto-html/tippy.umd.min.js"></script> | |
| <script src="../site_libs/quarto-html/anchor.min.js"></script> | |
| <link href="../site_libs/quarto-html/tippy.css" rel="stylesheet"> | |
| <link href="../site_libs/quarto-html/quarto-syntax-highlighting-ed96de9b727972fe78a7b5d16c58bf87.css" rel="stylesheet" id="quarto-text-highlighting-styles"> | |
| <script src="../site_libs/bootstrap/bootstrap.min.js"></script> | |
| <link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet"> | |
| <link href="../site_libs/bootstrap/bootstrap-a8976c3e89df70b272bdfba3d2fda974.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light"> | |
| <script id="quarto-search-options" type="application/json">{ | |
| "location": "navbar", | |
| "copy-button": false, | |
| "collapse-after": 3, | |
| "panel-placement": "end", | |
| "type": "overlay", | |
| "limit": 50, | |
| "keyboard-shortcut": [ | |
| "f", | |
| "/", | |
| "s" | |
| ], | |
| "show-item-context": false, | |
| "language": { | |
| "search-no-results-text": "No results", | |
| "search-matching-documents-text": "matching documents", | |
| "search-copy-link-title": "Copy link to search", | |
| "search-hide-matches-text": "Hide additional matches", | |
| "search-more-match-text": "more match in this document", | |
| "search-more-matches-text": "more matches in this document", | |
| "search-clear-button-title": "Clear", | |
| "search-text-placeholder": "", | |
| "search-detached-cancel-button-title": "Cancel", | |
| "search-submit-button-title": "Submit", | |
| "search-label": "Search" | |
| } | |
| }</script> | |
| <script defer="" src="https://cloud.umami.is/script.js" data-website-id="6c45a91a-0956-45db-8248-dadff3c2d36d"></script> | |
| </head> | |
| <body class="nav-fixed quarto-light"> | |
| <div id="quarto-search-results"></div> | |
| <header id="quarto-header" class="headroom fixed-top"> | |
| <nav class="navbar navbar-expand-lg " data-bs-theme="dark"> | |
| <div class="navbar-container container-fluid"> | |
| <div class="navbar-brand-container mx-auto"> | |
| <a href="../index.html" class="navbar-brand navbar-brand-logo"> | |
| <img src="../assets/redis-logo.svg" alt="Redis" class="navbar-logo light-content"> | |
| <img src="../assets/redis-logo.svg" alt="Redis" class="navbar-logo dark-content"> | |
| </a> | |
| <a class="navbar-brand" href="../index.html"> | |
| <span class="navbar-title">AI Research <span class="citation" data-cites="Redis">@Redis</span></span> | |
| </a> | |
| </div> | |
| <div id="quarto-search" class="" title="Search"></div> | |
| <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarCollapse" aria-controls="navbarCollapse" role="menu" aria-expanded="false" aria-label="Toggle navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }"> | |
| <span class="navbar-toggler-icon"></span> | |
| </button> | |
| <div class="collapse navbar-collapse" id="navbarCollapse"> | |
| <ul class="navbar-nav navbar-nav-scroll me-auto"> | |
| <li class="nav-item"> | |
| <a class="nav-link" href="../index.html"> | |
| <span class="menu-text">Home</span></a> | |
| </li> | |
| <li class="nav-item"> | |
| <a class="nav-link" href="../about.html"> | |
| <span class="menu-text">About</span></a> | |
| </li> | |
| </ul> | |
| </div> <!-- /navcollapse --> | |
| <div class="quarto-navbar-tools"> | |
| </div> | |
| </div> <!-- /container-fluid --> | |
| </nav> | |
| </header> | |
| <!-- content --> | |
| <div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar"> | |
| <!-- sidebar --> | |
| <!-- margin-sidebar --> | |
| <div id="quarto-margin-sidebar" class="sidebar margin-sidebar"> | |
| <nav id="TOC" role="doc-toc" class="toc-active"> | |
| <h2 id="toc-title">On this page</h2> | |
| <ul> | |
| <li><a href="#what-the-repo-does" id="toc-what-the-repo-does" class="nav-link active" data-scroll-target="#what-the-repo-does">What the repo does</a></li> | |
| <li><a href="#two-ways-to-evaluate" id="toc-two-ways-to-evaluate" class="nav-link" data-scroll-target="#two-ways-to-evaluate">Two ways to evaluate</a> | |
| <ul class="collapse"> | |
| <li><a href="#fast-cache-hit-ratio-analysis" id="toc-fast-cache-hit-ratio-analysis" class="nav-link" data-scroll-target="#fast-cache-hit-ratio-analysis">1. Fast cache-hit-ratio analysis</a></li> | |
| <li><a href="#full-evaluation-with-quality-metrics" id="toc-full-evaluation-with-quality-metrics" class="nav-link" data-scroll-target="#full-evaluation-with-quality-metrics">2. Full evaluation with quality metrics</a></li> | |
| </ul></li> | |
| <li><a href="#what-you-provide" id="toc-what-you-provide" class="nav-link" data-scroll-target="#what-you-provide">What you provide</a></li> | |
| <li><a href="#what-you-get-back" id="toc-what-you-get-back" class="nav-link" data-scroll-target="#what-you-get-back">What you get back</a></li> | |
| <li><a href="#why-this-is-useful-for-langcache" id="toc-why-this-is-useful-for-langcache" class="nav-link" data-scroll-target="#why-this-is-useful-for-langcache">Why this is useful for LangCache</a></li> | |
| <li><a href="#practical-workflow" id="toc-practical-workflow" class="nav-link" data-scroll-target="#practical-workflow">Practical workflow</a></li> | |
| <li><a href="#repo" id="toc-repo" class="nav-link" data-scroll-target="#repo">Repo</a></li> | |
| </ul> | |
| </nav> | |
| </div> | |
| <!-- main --> | |
| <main class="content" id="quarto-document-content"> | |
| <header id="title-block-header" class="quarto-title-block default"> | |
| <div class="quarto-title"> | |
| <h1 class="title">Evaluating Langcache on Your Data</h1> | |
| <div class="quarto-categories"> | |
| <div class="quarto-category">langcache</div> | |
| <div class="quarto-category">evaluation</div> | |
| <div class="quarto-category">semantic-caching</div> | |
| <div class="quarto-category">embeddings</div> | |
| </div> | |
| </div> | |
| <div> | |
| <div class="description"> | |
| How the langcache-customer-data-eval repo helps measure cache hit rate, precision, and threshold tradeoffs on your own query data. | |
| </div> | |
| </div> | |
| <div class="quarto-title-meta"> | |
| <div> | |
| <div class="quarto-title-meta-heading">Author</div> | |
| <div class="quarto-title-meta-contents"> | |
| <p>Iliya Zhechev, Rado Ralev </p> | |
| </div> | |
| </div> | |
| <div> | |
| <div class="quarto-title-meta-heading">Published</div> | |
| <div class="quarto-title-meta-contents"> | |
| <p class="date">March 25, 2026</p> | |
| </div> | |
| </div> | |
| </div> | |
| </header> | |
| <p>Semantic caching only helps if it works on your own traffic. A threshold that looks good on a toy dataset can be far too aggressive on real user queries, or too conservative to save meaningful latency and cost.</p> | |
| <p>The <a href="https://github.com/redislabsdev/langcache-customer-data-eval"><code>langcache-customer-data-eval</code></a> repo is designed to answer that question on customer data. It runs an offline evaluation pipeline over your queries and cache candidates, then produces the metrics and plots you need to decide whether LangCache is a good fit and where the operating threshold should be set.</p> | |
| <section id="what-the-repo-does" class="level2"> | |
| <h2 class="anchored" data-anchor-id="what-the-repo-does">What the repo does</h2> | |
| <p>At a high level, the pipeline:</p> | |
| <ul> | |
| <li>embeds queries and cache candidates</li> | |
| <li>finds the nearest cache match for each query</li> | |
| <li>sweeps similarity thresholds across the score range</li> | |
| <li>computes metrics at each threshold</li> | |
| <li>writes CSV outputs and threshold plots for analysis</li> | |
| </ul> | |
| <p>That gives you a concrete view of the tradeoff between cache aggressiveness and answer quality, rather than relying on a single anecdotal threshold.</p> | |
| </section> | |
| <section id="two-ways-to-evaluate" class="level2"> | |
| <h2 class="anchored" data-anchor-id="two-ways-to-evaluate">Two ways to evaluate</h2> | |
| <p>The repo supports two modes.</p> | |
| <section id="fast-cache-hit-ratio-analysis" class="level3"> | |
| <h3 class="anchored" data-anchor-id="fast-cache-hit-ratio-analysis">1. Fast cache-hit-ratio analysis</h3> | |
| <p>In the default mode, the pipeline focuses on cache hit ratio. This is useful when you want a quick first pass on a dataset and mainly care about how often a cache would fire at different thresholds.</p> | |
| <p>This mode is helpful for questions like:</p> | |
| <ul> | |
| <li>Do my queries cluster tightly enough for semantic caching to help?</li> | |
| <li>How sensitive is cache hit ratio to the threshold?</li> | |
| <li>Is there an obvious operating region worth testing online?</li> | |
| </ul> | |
| </section> | |
| <section id="full-evaluation-with-quality-metrics" class="level3"> | |
| <h3 class="anchored" data-anchor-id="full-evaluation-with-quality-metrics">2. Full evaluation with quality metrics</h3> | |
| <p>The fuller mode adds an LLM-as-a-judge stage on top of the nearest-match retrieval step. That produces proxy labels for whether a retrieved cache match is actually acceptable, which makes it possible to compute metrics such as precision, recall, and F-scores across a threshold sweep.</p> | |
| <p>This is the more useful mode when the real question is not just “how often would the cache hit?” but “how often would it hit correctly?”</p> | |
| </section> | |
| </section> | |
| <section id="what-you-provide" class="level2"> | |
| <h2 class="anchored" data-anchor-id="what-you-provide">What you provide</h2> | |
| <p>The pipeline is built around two simple inputs:</p> | |
| <ul> | |
| <li>a query log CSV</li> | |
| <li>a cache/reference CSV</li> | |
| </ul> | |
| <p>Both need a common text column. The query file represents the traffic you want to evaluate. The cache file represents the candidate responses or utterances that LangCache would try to reuse.</p> | |
| <p>The tooling supports both local paths and <code>s3://</code> paths, which makes it practical to run on small local samples or larger offline datasets stored in object storage.</p> | |
| </section> | |
| <section id="what-you-get-back" class="level2"> | |
| <h2 class="anchored" data-anchor-id="what-you-get-back">What you get back</h2> | |
| <p>The main outputs are the artifacts you need to choose a threshold responsibly:</p> | |
| <ul> | |
| <li>match files showing the best candidate per query</li> | |
| <li>threshold sweep CSVs</li> | |
| <li>cache-hit-rate plots</li> | |
| <li>in full mode, precision/recall/F-score outputs and comparison plots</li> | |
| </ul> | |
| <p>That makes the repo useful for several evaluation loops:</p> | |
| <ul> | |
| <li>comparing embedding models</li> | |
| <li>comparing Redis-backed matching against in-memory matching</li> | |
| <li>testing how much quality drops as cache hit rate increases</li> | |
| <li>deciding what threshold should move to online experimentation</li> | |
| </ul> | |
| </section> | |
| <section id="why-this-is-useful-for-langcache" class="level2"> | |
| <h2 class="anchored" data-anchor-id="why-this-is-useful-for-langcache">Why this is useful for LangCache</h2> | |
| <p>LangCache is most valuable when it improves latency and cost without introducing too many wrong cache reuses. The hard part is that every dataset has different duplication patterns, phrasing variation, and ambiguity.</p> | |
| <p>This repo helps turn that into a measurable offline exercise. Instead of asking whether semantic caching works in general, you can ask:</p> | |
| <ul> | |
| <li>what cache hit ratio is possible on my data?</li> | |
| <li>what precision do I get at that hit rate?</li> | |
| <li>how does the threshold behave on real traffic?</li> | |
| <li>which model or serving setup gives the best tradeoff?</li> | |
| </ul> | |
| <p>That is exactly the kind of analysis needed before enabling LangCache broadly in production.</p> | |
| </section> | |
| <section id="practical-workflow" class="level2"> | |
| <h2 class="anchored" data-anchor-id="practical-workflow">Practical workflow</h2> | |
| <p>A typical workflow looks like this:</p> | |
| <ol type="1"> | |
| <li>Export a representative set of queries.</li> | |
| <li>Build or sample the cache candidate set.</li> | |
| <li>Run the evaluation pipeline offline.</li> | |
| <li>Inspect the threshold sweep outputs and plots.</li> | |
| <li>Choose a small set of candidate thresholds.</li> | |
| <li>Validate those thresholds in a controlled online setting.</li> | |
| </ol> | |
| <p>The repo is therefore less about one benchmark number and more about giving teams a repeatable method for deciding whether semantic caching is viable on their own workload.</p> | |
| </section> | |
| <section id="repo" class="level2"> | |
| <h2 class="anchored" data-anchor-id="repo">Repo</h2> | |
| <ul> | |
| <li>GitHub: <code>https://github.com/redislabsdev/langcache-customer-data-eval</code></li> | |
| </ul> | |
| </section> | |
| </main> <!-- /main --> | |
| <script> | |
| (function () { | |
| try { | |
| var inIframe = window.top !== window.self; | |
| if (!inIframe) return; | |
| function ensureNoopener(a) { | |
| var rel = (a.getAttribute("rel") || "").trim(); | |
| if (!rel) { | |
| a.setAttribute("rel", "noopener"); | |
| return; | |
| } | |
| if (!rel.split(/\s+/).includes("noopener")) { | |
| a.setAttribute("rel", (rel + " noopener").trim()); | |
| } | |
| } | |
| function isInternalLink(href) { | |
| if (!href) return false; | |
| if (href.startsWith("#")) return false; | |
| if (href.startsWith("mailto:")) return false; | |
| if (href.startsWith("javascript:")) return false; | |
| if (href.startsWith("/")) return true; | |
| if (href.startsWith("http://") || href.startsWith("https://")) { | |
| try { | |
| var u = new URL(href, window.location.href); | |
| return u.origin === window.location.origin; | |
| } catch (e) { | |
| return false; | |
| } | |
| } | |
| // relative | |
| return true; | |
| } | |
| function retargetInternalLinks() { | |
| var links = document.querySelectorAll("a[href]"); | |
| for (var i = 0; i < links.length; i++) { | |
| var a = links[i]; | |
| var href = a.getAttribute("href"); | |
| if (!isInternalLink(href)) continue; | |
| a.setAttribute("target", "_top"); | |
| ensureNoopener(a); | |
| } | |
| } | |
| function insertShareableLinkNotice() { | |
| var main = document.querySelector("main.content"); | |
| if (!main) return; | |
| if (document.getElementById("hf-embed-notice")) return; | |
| var wrap = document.createElement("div"); | |
| wrap.id = "hf-embed-notice"; | |
| wrap.style.cssText = | |
| "border:1px solid #e5e7eb;border-radius:10px;padding:10px 12px;" + | |
| "background:#f9fafb;color:#111827;margin:0 0 16px 0;font-size:0.95rem;"; | |
| var a = document.createElement("a"); | |
| a.href = window.location.href; | |
| a.target = "_top"; | |
| a.rel = "noopener"; | |
| a.textContent = "Open this page directly"; | |
| a.style.cssText = "font-weight:600;text-decoration:underline;"; | |
| wrap.appendChild( | |
| document.createTextNode( | |
| "You are viewing this site embedded in the Hugging Face Space page. " + | |
| "The address bar won\u2019t change as you navigate. " | |
| ) | |
| ); | |
| wrap.appendChild(a); | |
| wrap.appendChild(document.createTextNode(" for a shareable URL.")); | |
| main.insertBefore(wrap, main.firstChild); | |
| } | |
| retargetInternalLinks(); | |
| insertShareableLinkNotice(); | |
| window.addEventListener("DOMContentLoaded", function () { | |
| retargetInternalLinks(); | |
| insertShareableLinkNotice(); | |
| }); | |
| } catch (e) { | |
| // no-op | |
| } | |
| })(); | |
| </script> | |
| <script id="quarto-html-after-body" type="application/javascript"> | |
| window.document.addEventListener("DOMContentLoaded", function (event) { | |
| const icon = ""; | |
| const anchorJS = new window.AnchorJS(); | |
| anchorJS.options = { | |
| placement: 'right', | |
| icon: icon | |
| }; | |
| anchorJS.add('.anchored'); | |
| const isCodeAnnotation = (el) => { | |
| for (const clz of el.classList) { | |
| if (clz.startsWith('code-annotation-')) { | |
| return true; | |
| } | |
| } | |
| return false; | |
| } | |
| const onCopySuccess = function(e) { | |
| // button target | |
| const button = e.trigger; | |
| // don't keep focus | |
| button.blur(); | |
| // flash "checked" | |
| button.classList.add('code-copy-button-checked'); | |
| var currentTitle = button.getAttribute("title"); | |
| button.setAttribute("title", "Copied!"); | |
| let tooltip; | |
| if (window.bootstrap) { | |
| button.setAttribute("data-bs-toggle", "tooltip"); | |
| button.setAttribute("data-bs-placement", "left"); | |
| button.setAttribute("data-bs-title", "Copied!"); | |
| tooltip = new bootstrap.Tooltip(button, | |
| { trigger: "manual", | |
| customClass: "code-copy-button-tooltip", | |
| offset: [0, -8]}); | |
| tooltip.show(); | |
| } | |
| setTimeout(function() { | |
| if (tooltip) { | |
| tooltip.hide(); | |
| button.removeAttribute("data-bs-title"); | |
| button.removeAttribute("data-bs-toggle"); | |
| button.removeAttribute("data-bs-placement"); | |
| } | |
| button.setAttribute("title", currentTitle); | |
| button.classList.remove('code-copy-button-checked'); | |
| }, 1000); | |
| // clear code selection | |
| e.clearSelection(); | |
| } | |
| const getTextToCopy = function(trigger) { | |
| const outerScaffold = trigger.parentElement.cloneNode(true); | |
| const codeEl = outerScaffold.querySelector('code'); | |
| for (const childEl of codeEl.children) { | |
| if (isCodeAnnotation(childEl)) { | |
| childEl.remove(); | |
| } | |
| } | |
| return codeEl.innerText; | |
| } | |
| const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', { | |
| text: getTextToCopy | |
| }); | |
| clipboard.on('success', onCopySuccess); | |
| if (window.document.getElementById('quarto-embedded-source-code-modal')) { | |
| const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', { | |
| text: getTextToCopy, | |
| container: window.document.getElementById('quarto-embedded-source-code-modal') | |
| }); | |
| clipboardModal.on('success', onCopySuccess); | |
| } | |
| var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//); | |
| var mailtoRegex = new RegExp(/^mailto:/); | |
| var filterRegex = new RegExp("https:\/\/redis-ai-research-redis\.static\.hf\.space"); | |
| var isInternal = (href) => { | |
| return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href); | |
| } | |
| // Inspect non-navigation links and adorn them if external | |
| var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)'); | |
| for (var i=0; i<links.length; i++) { | |
| const link = links[i]; | |
| if (!isInternal(link.href)) { | |
| // undo the damage that might have been done by quarto-nav.js in the case of | |
| // links that we want to consider external | |
| if (link.dataset.originalHref !== undefined) { | |
| link.href = link.dataset.originalHref; | |
| } | |
| } | |
| } | |
| function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) { | |
| const config = { | |
| allowHTML: true, | |
| maxWidth: 500, | |
| delay: 100, | |
| arrow: false, | |
| appendTo: function(el) { | |
| return el.parentElement; | |
| }, | |
| interactive: true, | |
| interactiveBorder: 10, | |
| theme: 'quarto', | |
| placement: 'bottom-start', | |
| }; | |
| if (contentFn) { | |
| config.content = contentFn; | |
| } | |
| if (onTriggerFn) { | |
| config.onTrigger = onTriggerFn; | |
| } | |
| if (onUntriggerFn) { | |
| config.onUntrigger = onUntriggerFn; | |
| } | |
| window.tippy(el, config); | |
| } | |
| const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]'); | |
| for (var i=0; i<noterefs.length; i++) { | |
| const ref = noterefs[i]; | |
| tippyHover(ref, function() { | |
| // use id or data attribute instead here | |
| let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href'); | |
| try { href = new URL(href).hash; } catch {} | |
| const id = href.replace(/^#\/?/, ""); | |
| const note = window.document.getElementById(id); | |
| if (note) { | |
| return note.innerHTML; | |
| } else { | |
| return ""; | |
| } | |
| }); | |
| } | |
| const xrefs = window.document.querySelectorAll('a.quarto-xref'); | |
| const processXRef = (id, note) => { | |
| // Strip column container classes | |
| const stripColumnClz = (el) => { | |
| el.classList.remove("page-full", "page-columns"); | |
| if (el.children) { | |
| for (const child of el.children) { | |
| stripColumnClz(child); | |
| } | |
| } | |
| } | |
| stripColumnClz(note) | |
| if (id === null || id.startsWith('sec-')) { | |
| // Special case sections, only their first couple elements | |
| const container = document.createElement("div"); | |
| if (note.children && note.children.length > 2) { | |
| container.appendChild(note.children[0].cloneNode(true)); | |
| for (let i = 1; i < note.children.length; i++) { | |
| const child = note.children[i]; | |
| if (child.tagName === "P" && child.innerText === "") { | |
| continue; | |
| } else { | |
| container.appendChild(child.cloneNode(true)); | |
| break; | |
| } | |
| } | |
| if (window.Quarto?.typesetMath) { | |
| window.Quarto.typesetMath(container); | |
| } | |
| return container.innerHTML | |
| } else { | |
| if (window.Quarto?.typesetMath) { | |
| window.Quarto.typesetMath(note); | |
| } | |
| return note.innerHTML; | |
| } | |
| } else { | |
| // Remove any anchor links if they are present | |
| const anchorLink = note.querySelector('a.anchorjs-link'); | |
| if (anchorLink) { | |
| anchorLink.remove(); | |
| } | |
| if (window.Quarto?.typesetMath) { | |
| window.Quarto.typesetMath(note); | |
| } | |
| if (note.classList.contains("callout")) { | |
| return note.outerHTML; | |
| } else { | |
| return note.innerHTML; | |
| } | |
| } | |
| } | |
| for (var i=0; i<xrefs.length; i++) { | |
| const xref = xrefs[i]; | |
| tippyHover(xref, undefined, function(instance) { | |
| instance.disable(); | |
| let url = xref.getAttribute('href'); | |
| let hash = undefined; | |
| if (url.startsWith('#')) { | |
| hash = url; | |
| } else { | |
| try { hash = new URL(url).hash; } catch {} | |
| } | |
| if (hash) { | |
| const id = hash.replace(/^#\/?/, ""); | |
| const note = window.document.getElementById(id); | |
| if (note !== null) { | |
| try { | |
| const html = processXRef(id, note.cloneNode(true)); | |
| instance.setContent(html); | |
| } finally { | |
| instance.enable(); | |
| instance.show(); | |
| } | |
| } else { | |
| // See if we can fetch this | |
| fetch(url.split('#')[0]) | |
| .then(res => res.text()) | |
| .then(html => { | |
| const parser = new DOMParser(); | |
| const htmlDoc = parser.parseFromString(html, "text/html"); | |
| const note = htmlDoc.getElementById(id); | |
| if (note !== null) { | |
| const html = processXRef(id, note); | |
| instance.setContent(html); | |
| } | |
| }).finally(() => { | |
| instance.enable(); | |
| instance.show(); | |
| }); | |
| } | |
| } else { | |
| // See if we can fetch a full url (with no hash to target) | |
| // This is a special case and we should probably do some content thinning / targeting | |
| fetch(url) | |
| .then(res => res.text()) | |
| .then(html => { | |
| const parser = new DOMParser(); | |
| const htmlDoc = parser.parseFromString(html, "text/html"); | |
| const note = htmlDoc.querySelector('main.content'); | |
| if (note !== null) { | |
| // This should only happen for chapter cross references | |
| // (since there is no id in the URL) | |
| // remove the first header | |
| if (note.children.length > 0 && note.children[0].tagName === "HEADER") { | |
| note.children[0].remove(); | |
| } | |
| const html = processXRef(null, note); | |
| instance.setContent(html); | |
| } | |
| }).finally(() => { | |
| instance.enable(); | |
| instance.show(); | |
| }); | |
| } | |
| }, function(instance) { | |
| }); | |
| } | |
| let selectedAnnoteEl; | |
| const selectorForAnnotation = ( cell, annotation) => { | |
| let cellAttr = 'data-code-cell="' + cell + '"'; | |
| let lineAttr = 'data-code-annotation="' + annotation + '"'; | |
| const selector = 'span[' + cellAttr + '][' + lineAttr + ']'; | |
| return selector; | |
| } | |
| const selectCodeLines = (annoteEl) => { | |
| const doc = window.document; | |
| const targetCell = annoteEl.getAttribute("data-target-cell"); | |
| const targetAnnotation = annoteEl.getAttribute("data-target-annotation"); | |
| const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation)); | |
| const lines = annoteSpan.getAttribute("data-code-lines").split(","); | |
| const lineIds = lines.map((line) => { | |
| return targetCell + "-" + line; | |
| }) | |
| let top = null; | |
| let height = null; | |
| let parent = null; | |
| if (lineIds.length > 0) { | |
| //compute the position of the single el (top and bottom and make a div) | |
| const el = window.document.getElementById(lineIds[0]); | |
| top = el.offsetTop; | |
| height = el.offsetHeight; | |
| parent = el.parentElement.parentElement; | |
| if (lineIds.length > 1) { | |
| const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]); | |
| const bottom = lastEl.offsetTop + lastEl.offsetHeight; | |
| height = bottom - top; | |
| } | |
| if (top !== null && height !== null && parent !== null) { | |
| // cook up a div (if necessary) and position it | |
| let div = window.document.getElementById("code-annotation-line-highlight"); | |
| if (div === null) { | |
| div = window.document.createElement("div"); | |
| div.setAttribute("id", "code-annotation-line-highlight"); | |
| div.style.position = 'absolute'; | |
| parent.appendChild(div); | |
| } | |
| div.style.top = top - 2 + "px"; | |
| div.style.height = height + 4 + "px"; | |
| div.style.left = 0; | |
| let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter"); | |
| if (gutterDiv === null) { | |
| gutterDiv = window.document.createElement("div"); | |
| gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter"); | |
| gutterDiv.style.position = 'absolute'; | |
| const codeCell = window.document.getElementById(targetCell); | |
| const gutter = codeCell.querySelector('.code-annotation-gutter'); | |
| gutter.appendChild(gutterDiv); | |
| } | |
| gutterDiv.style.top = top - 2 + "px"; | |
| gutterDiv.style.height = height + 4 + "px"; | |
| } | |
| selectedAnnoteEl = annoteEl; | |
| } | |
| }; | |
| const unselectCodeLines = () => { | |
| const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"]; | |
| elementsIds.forEach((elId) => { | |
| const div = window.document.getElementById(elId); | |
| if (div) { | |
| div.remove(); | |
| } | |
| }); | |
| selectedAnnoteEl = undefined; | |
| }; | |
| // Handle positioning of the toggle | |
| window.addEventListener( | |
| "resize", | |
| throttle(() => { | |
| elRect = undefined; | |
| if (selectedAnnoteEl) { | |
| selectCodeLines(selectedAnnoteEl); | |
| } | |
| }, 10) | |
| ); | |
| function throttle(fn, ms) { | |
| let throttle = false; | |
| let timer; | |
| return (...args) => { | |
| if(!throttle) { // first call gets through | |
| fn.apply(this, args); | |
| throttle = true; | |
| } else { // all the others get throttled | |
| if(timer) clearTimeout(timer); // cancel #2 | |
| timer = setTimeout(() => { | |
| fn.apply(this, args); | |
| timer = throttle = false; | |
| }, ms); | |
| } | |
| }; | |
| } | |
| // Attach click handler to the DT | |
| const annoteDls = window.document.querySelectorAll('dt[data-target-cell]'); | |
| for (const annoteDlNode of annoteDls) { | |
| annoteDlNode.addEventListener('click', (event) => { | |
| const clickedEl = event.target; | |
| if (clickedEl !== selectedAnnoteEl) { | |
| unselectCodeLines(); | |
| const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active'); | |
| if (activeEl) { | |
| activeEl.classList.remove('code-annotation-active'); | |
| } | |
| selectCodeLines(clickedEl); | |
| clickedEl.classList.add('code-annotation-active'); | |
| } else { | |
| // Unselect the line | |
| unselectCodeLines(); | |
| clickedEl.classList.remove('code-annotation-active'); | |
| } | |
| }); | |
| } | |
| const findCites = (el) => { | |
| const parentEl = el.parentElement; | |
| if (parentEl) { | |
| const cites = parentEl.dataset.cites; | |
| if (cites) { | |
| return { | |
| el, | |
| cites: cites.split(' ') | |
| }; | |
| } else { | |
| return findCites(el.parentElement) | |
| } | |
| } else { | |
| return undefined; | |
| } | |
| }; | |
| var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]'); | |
| for (var i=0; i<bibliorefs.length; i++) { | |
| const ref = bibliorefs[i]; | |
| const citeInfo = findCites(ref); | |
| if (citeInfo) { | |
| tippyHover(citeInfo.el, function() { | |
| var popup = window.document.createElement('div'); | |
| citeInfo.cites.forEach(function(cite) { | |
| var citeDiv = window.document.createElement('div'); | |
| citeDiv.classList.add('hanging-indent'); | |
| citeDiv.classList.add('csl-entry'); | |
| var biblioDiv = window.document.getElementById('ref-' + cite); | |
| if (biblioDiv) { | |
| citeDiv.innerHTML = biblioDiv.innerHTML; | |
| } | |
| popup.appendChild(citeDiv); | |
| }); | |
| return popup.innerHTML; | |
| }); | |
| } | |
| } | |
| }); | |
| </script> | |
| </div> <!-- /content --> | |
| <footer class="footer"> | |
| <div class="nav-footer"> | |
| <div class="nav-footer-left"> | |
| <p>Discover this project on Hugging Face Spaces: https://huggingface.co/spaces/redis/ai-research-redis</p> | |
| </div> | |
| <div class="nav-footer-center"> | |
| | |
| </div> | |
| <div class="nav-footer-right"> | |
| | |
| </div> | |
| </div> | |
| </footer> | |
| </body></html> |