Add changes for ea0a07d

centre-for-humanities-computing · Oct 30, 2024 · 5192067 · 5192067
1 parent 04599a3
commit 5192067
Show file tree

Hide file tree

Showing 58 changed files with 511 additions and 390 deletions.
diff --git a/_images/51f23a1f5014ae0972b7430a4c140f161eecc64cd828c6e6257d148e8e8f4c8c.png b/_images/51f23a1f5014ae0972b7430a4c140f161eecc64cd828c6e6257d148e8e8f4c8c.png
diff --git a/_images/6de44b863d2dd514bd086640d08355a4189a17cc58cb59f121ea289421279beb.png b/_images/6de44b863d2dd514bd086640d08355a4189a17cc58cb59f121ea289421279beb.png
diff --git a/_images/78de1a22bf6c37db0d61a35ba47d7006a8d19d8339156c272349623866088bc7.png b/_images/78de1a22bf6c37db0d61a35ba47d7006a8d19d8339156c272349623866088bc7.png
diff --git a/_images/dbd6eff77ac28793a8cbadbf078e0bbad2aca7dc8864ed3912b87cef0e8fea12.png b/_images/dbd6eff77ac28793a8cbadbf078e0bbad2aca7dc8864ed3912b87cef0e8fea12.png
diff --git a/_images/e69542200cf74ae7c346dd5ba000012455e710442902e48c4ba1ee73ade08d7b.png b/_images/e69542200cf74ae7c346dd5ba000012455e710442902e48c4ba1ee73ade08d7b.png
diff --git a/_images/ec0b2f720af347cdae0780e8188bd50cd1e2d14fa73869fe8f1c2c77667d8906.png b/_images/ec0b2f720af347cdae0780e8188bd50cd1e2d14fa73869fe8f1c2c77667d8906.png
diff --git a/_images/social_previews/summary_adv_tutorials_643fea50.png b/_images/social_previews/summary_adv_tutorials_643fea50.png
diff --git a/_images/social_previews/summary_api_dacy.datasets_7cb45284.png b/_images/social_previews/summary_api_dacy.datasets_7cb45284.png
diff --git a/_images/social_previews/summary_api_dacy.download_6d649a87.png b/_images/social_previews/summary_api_dacy.download_6d649a87.png
diff --git a/_images/social_previews/summary_api_dacy.score_43b73619.png b/_images/social_previews/summary_api_dacy.score_43b73619.png
diff --git a/_images/social_previews/summary_faq_ea11e2b5.png b/_images/social_previews/summary_faq_ea11e2b5.png
diff --git a/_images/social_previews/summary_index_a775e628.png b/_images/social_previews/summary_index_a775e628.png
diff --git a/_images/social_previews/summary_installation_1133ca9c.png b/_images/social_previews/summary_installation_1133ca9c.png
diff --git a/_images/social_previews/summary_news_f6b0378d.png b/_images/social_previews/summary_news_f6b0378d.png
diff --git a/_images/social_previews/summary_performance.general_cec2ba51.png b/_images/social_previews/summary_performance.general_cec2ba51.png
diff --git a/_images/social_previews/summary_performance.robustness_d3e5807c.png b/_images/social_previews/summary_performance.robustness_d3e5807c.png
diff --git a/_images/social_previews/summary_performance_e9d5d2ac.png b/_images/social_previews/summary_performance_e9d5d2ac.png
diff --git a/_images/social_previews/summary_performance_ner_2249ba84.png b/_images/social_previews/summary_performance_ner_2249ba84.png
diff --git a/_images/social_previews/summary_tutorials_a82565a5.png b/_images/social_previews/summary_tutorials_a82565a5.png
diff --git a/_images/social_previews/summary_tutorials_basic_c5d7123c.png b/_images/social_previews/summary_tutorials_basic_c5d7123c.png
diff --git a/_images/social_previews/summary_tutorials_hate-speech_304bb440.png b/_images/social_previews/summary_tutorials_hate-speech_304bb440.png
diff --git a/_images/social_previews/summary_tutorials_robustness_4a438c7e.png b/_images/social_previews/summary_tutorials_robustness_4a438c7e.png
diff --git a/_images/social_previews/summary_tutorials_sentiment_865fbf96.png b/_images/social_previews/summary_tutorials_sentiment_865fbf96.png
diff --git a/_images/social_previews/summary_tutorials_textdescriptives_046f899f.png b/_images/social_previews/summary_tutorials_textdescriptives_046f899f.png
diff --git a/_modules/dacy/datasets/dane.html b/_modules/dacy/datasets/dane.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=fad236701ea90a88636c2a8c73b44ae642ed2a53" />
     <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/sphinx-design.5ea377869091fd0449014c60fc090103.min.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
 

diff --git a/_modules/dacy/datasets/names.html b/_modules/dacy/datasets/names.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=fad236701ea90a88636c2a8c73b44ae642ed2a53" />
     <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/sphinx-design.5ea377869091fd0449014c60fc090103.min.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
 

diff --git a/_modules/dacy/download.html b/_modules/dacy/download.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=fad236701ea90a88636c2a8c73b44ae642ed2a53" />
     <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
-    <link rel="stylesheet" type="text/css" href="../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
+    <link rel="stylesheet" type="text/css" href="../../_static/sphinx-design.5ea377869091fd0449014c60fc090103.min.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
 
@@ -320,12 +320,12 @@ <h1>Source code for dacy.download</h1><div class="highlight"><pre>
         <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlretrieve</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">filename</span><span class="o">=</span><span class="n">output_path</span><span class="p">,</span> <span class="n">reporthook</span><span class="o">=</span><span class="n">t</span><span class="o">.</span><span class="n">update_to</span><span class="p">)</span>
 
 
-<div class="viewcode-block" id="install"><a class="viewcode-back" href="../../api/dacy.download.html#dacy.download.install">[docs]</a><span class="k">def</span> <span class="nf">install</span><span class="p">(</span><span class="n">package</span><span class="p">):</span>  <span class="c1"># noqa</span>
+<div class="viewcode-block" id="install"><a class="viewcode-back" href="../../api/dacy.download.html#dacy.download.install">[docs]</a><span class="k">def</span> <span class="nf">install</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">url</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
     <span class="kn">import</span> <span class="nn">subprocess</span>
     <span class="kn">import</span> <span class="nn">sys</span>
 
     <span class="n">subprocess</span><span class="o">.</span><span class="n">check_call</span><span class="p">(</span>
-        <span class="p">[</span><span class="n">sys</span><span class="o">.</span><span class="n">executable</span><span class="p">,</span> <span class="s2">&quot;-m&quot;</span><span class="p">,</span> <span class="s2">&quot;pip&quot;</span><span class="p">,</span> <span class="s2">&quot;install&quot;</span><span class="p">,</span> <span class="n">package</span><span class="p">,</span> <span class="s2">&quot;--no-deps&quot;</span><span class="p">],</span>
+        <span class="p">[</span><span class="n">sys</span><span class="o">.</span><span class="n">executable</span><span class="p">,</span> <span class="s2">&quot;-m&quot;</span><span class="p">,</span> <span class="s2">&quot;pip&quot;</span><span class="p">,</span> <span class="s2">&quot;install&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">package</span><span class="si">}</span><span class="s2"> @ </span><span class="si">{</span><span class="n">url</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="s2">&quot;--no-deps&quot;</span><span class="p">],</span>
     <span class="p">)</span></div>
 
 
@@ -361,7 +361,9 @@ <h1>Source code for dacy.download</h1><div class="highlight"><pre>
     <span class="n">mdl</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;-&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>  <span class="c1"># type: ignore</span>
     <span class="k">if</span> <span class="n">mdl</span> <span class="ow">in</span> <span class="n">get_installed_models</span><span class="p">()</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">force</span> <span class="ow">and</span> <span class="n">version</span><span class="p">(</span><span class="n">mdl</span><span class="p">)</span> <span class="o">==</span> <span class="n">mdl_version</span><span class="p">:</span>
         <span class="k">return</span> <span class="n">mdl</span>
-    <span class="n">install</span><span class="p">(</span><span class="n">models_url</span><span class="p">[</span><span class="n">model</span><span class="p">])</span>
+
+    <span class="n">package</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;-&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+    <span class="n">install</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="n">models_url</span><span class="p">[</span><span class="n">model</span><span class="p">])</span>
     <span class="k">return</span> <span class="n">mdl</span></div>
 </pre></div>
         </article>

diff --git a/_modules/dacy/load.html b/_modules/dacy/load.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=fad236701ea90a88636c2a8c73b44ae642ed2a53" />
     <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
-    <link rel="stylesheet" type="text/css" href="../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
+    <link rel="stylesheet" type="text/css" href="../../_static/sphinx-design.5ea377869091fd0449014c60fc090103.min.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
 

diff --git a/_modules/dacy/score/input_length.html b/_modules/dacy/score/input_length.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=fad236701ea90a88636c2a8c73b44ae642ed2a53" />
     <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/sphinx-design.5ea377869091fd0449014c60fc090103.min.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
 

diff --git a/_modules/dacy/score/score.html b/_modules/dacy/score/score.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=fad236701ea90a88636c2a8c73b44ae642ed2a53" />
     <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/sphinx-design.5ea377869091fd0449014c60fc090103.min.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
 

diff --git a/_modules/index.html b/_modules/index.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=fad236701ea90a88636c2a8c73b44ae642ed2a53" />
     <link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
     <link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
-    <link rel="stylesheet" type="text/css" href="../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.5ea377869091fd0449014c60fc090103.min.css" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
 

diff --git a/_sphinx_design_static/design-tabs.js b/_sphinx_design_static/design-tabs.js
@@ -1,27 +1,101 @@
-var sd_labels_by_text = {};
+// @ts-check
 
+// Extra JS capability for selected tabs to be synced
+// The selection is stored in local storage so that it persists across page loads.
+
+/**
+ * @type {Record<string, HTMLElement[]>}
+ */
+let sd_id_to_elements = {};
+const storageKeyPrefix = "sphinx-design-tab-id-";
+
+/**
+ * Create a key for a tab element.
+ * @param {HTMLElement} el - The tab element.
+ * @returns {[string, string, string] | null} - The key.
+ *
+ */
+function create_key(el) {
+  let syncId = el.getAttribute("data-sync-id");
+  let syncGroup = el.getAttribute("data-sync-group");
+  if (!syncId || !syncGroup) return null;
+  return [syncGroup, syncId, syncGroup + "--" + syncId];
+}
+
+/**
+ * Initialize the tab selection.
+ *
+ */
 function ready() {
-  const li = document.getElementsByClassName("sd-tab-label");
-  for (const label of li) {
-    syncId = label.getAttribute("data-sync-id");
-    if (syncId) {
-      label.onclick = onLabelClick;
-      if (!sd_labels_by_text[syncId]) {
-        sd_labels_by_text[syncId] = [];
+  // Find all tabs with sync data
+
+  /** @type {string[]} */
+  let groups = [];
+
+  document.querySelectorAll(".sd-tab-label").forEach((label) => {
+    if (label instanceof HTMLElement) {
+      let data = create_key(label);
+      if (data) {
+        let [group, id, key] = data;
+
+        // add click event listener
+        // @ts-ignore
+        label.onclick = onSDLabelClick;
+
+        // store map of key to elements
+        if (!sd_id_to_elements[key]) {
+          sd_id_to_elements[key] = [];
+        }
+        sd_id_to_elements[key].push(label);
+
+        if (groups.indexOf(group) === -1) {
+          groups.push(group);
+          // Check if a specific tab has been selected via URL parameter
+          const tabParam = new URLSearchParams(window.location.search).get(
+            group
+          );
+          if (tabParam) {
+            console.log(
+              "sphinx-design: Selecting tab id for group '" +
+                group +
+                "' from URL parameter: " +
+                tabParam
+            );
+            window.sessionStorage.setItem(storageKeyPrefix + group, tabParam);
+          }
+        }
+
+        // Check is a specific tab has been selected previously
+        let previousId = window.sessionStorage.getItem(
+          storageKeyPrefix + group
+        );
+        if (previousId === id) {
+          // console.log(
+          //   "sphinx-design: Selecting tab from session storage: " + id
+          // );
+          // @ts-ignore
+          label.previousElementSibling.checked = true;
+        }
       }
-      sd_labels_by_text[syncId].push(label);
     }
-  }
+  });
 }
 
-function onLabelClick() {
-  // Activate other inputs with the same sync id.
-  syncId = this.getAttribute("data-sync-id");
-  for (label of sd_labels_by_text[syncId]) {
+/**
+ *  Activate other tabs with the same sync id.
+ *
+ * @this {HTMLElement} - The element that was clicked.
+ */
+function onSDLabelClick() {
+  let data = create_key(this);
+  if (!data) return;
+  let [group, id, key] = data;
+  for (const label of sd_id_to_elements[key]) {
     if (label === this) continue;
+    // @ts-ignore
     label.previousElementSibling.checked = true;
   }
-  window.localStorage.setItem("sphinx-design-last-tab", syncId);
+  window.sessionStorage.setItem(storageKeyPrefix + group, id);
 }
 
 document.addEventListener("DOMContentLoaded", ready, false);
diff --git a/....1e8bd061cd6da7fc9cf755528e8ffc24.min.css → ....5ea377869091fd0449014c60fc090103.min.css b/....1e8bd061cd6da7fc9cf755528e8ffc24.min.css → ....5ea377869091fd0449014c60fc090103.min.css
diff --git a/_static/design-tabs.js b/_static/design-tabs.js
@@ -1,27 +1,101 @@
-var sd_labels_by_text = {};
+// @ts-check
 
+// Extra JS capability for selected tabs to be synced
+// The selection is stored in local storage so that it persists across page loads.
+
+/**
+ * @type {Record<string, HTMLElement[]>}
+ */
+let sd_id_to_elements = {};
+const storageKeyPrefix = "sphinx-design-tab-id-";
+
+/**
+ * Create a key for a tab element.
+ * @param {HTMLElement} el - The tab element.
+ * @returns {[string, string, string] | null} - The key.
+ *
+ */
+function create_key(el) {
+  let syncId = el.getAttribute("data-sync-id");
+  let syncGroup = el.getAttribute("data-sync-group");
+  if (!syncId || !syncGroup) return null;
+  return [syncGroup, syncId, syncGroup + "--" + syncId];
+}
+
+/**
+ * Initialize the tab selection.
+ *
+ */
 function ready() {
-  const li = document.getElementsByClassName("sd-tab-label");
-  for (const label of li) {
-    syncId = label.getAttribute("data-sync-id");
-    if (syncId) {
-      label.onclick = onLabelClick;
-      if (!sd_labels_by_text[syncId]) {
-        sd_labels_by_text[syncId] = [];
+  // Find all tabs with sync data
+
+  /** @type {string[]} */
+  let groups = [];
+
+  document.querySelectorAll(".sd-tab-label").forEach((label) => {
+    if (label instanceof HTMLElement) {
+      let data = create_key(label);
+      if (data) {
+        let [group, id, key] = data;
+
+        // add click event listener
+        // @ts-ignore
+        label.onclick = onSDLabelClick;
+
+        // store map of key to elements
+        if (!sd_id_to_elements[key]) {
+          sd_id_to_elements[key] = [];
+        }
+        sd_id_to_elements[key].push(label);
+
+        if (groups.indexOf(group) === -1) {
+          groups.push(group);
+          // Check if a specific tab has been selected via URL parameter
+          const tabParam = new URLSearchParams(window.location.search).get(
+            group
+          );
+          if (tabParam) {
+            console.log(
+              "sphinx-design: Selecting tab id for group '" +
+                group +
+                "' from URL parameter: " +
+                tabParam
+            );
+            window.sessionStorage.setItem(storageKeyPrefix + group, tabParam);
+          }
+        }
+
+        // Check is a specific tab has been selected previously
+        let previousId = window.sessionStorage.getItem(
+          storageKeyPrefix + group
+        );
+        if (previousId === id) {
+          // console.log(
+          //   "sphinx-design: Selecting tab from session storage: " + id
+          // );
+          // @ts-ignore
+          label.previousElementSibling.checked = true;
+        }
       }
-      sd_labels_by_text[syncId].push(label);
     }
-  }
+  });
 }
 
-function onLabelClick() {
-  // Activate other inputs with the same sync id.
-  syncId = this.getAttribute("data-sync-id");
-  for (label of sd_labels_by_text[syncId]) {
+/**
+ *  Activate other tabs with the same sync id.
+ *
+ * @this {HTMLElement} - The element that was clicked.
+ */
+function onSDLabelClick() {
+  let data = create_key(this);
+  if (!data) return;
+  let [group, id, key] = data;
+  for (const label of sd_id_to_elements[key]) {
     if (label === this) continue;
+    // @ts-ignore
     label.previousElementSibling.checked = true;
   }
-  window.localStorage.setItem("sphinx-design-last-tab", syncId);
+  window.sessionStorage.setItem(storageKeyPrefix + group, id);
 }
 
 document.addEventListener("DOMContentLoaded", ready, false);