Deployed 97ffb3a with MkDocs version: 1.6.1

404.html

@@ -19,7 +19,7 @@
 
 
       <link rel="icon" href="/presidio/assets/ms_icon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
 
 
 

ahds_integration/index.html

@@ -25,7 +25,7 @@
 
 
       <link rel="icon" href="../assets/ms_icon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
 
 
 

analyzer/adding_recognizers/index.html

@@ -25,7 +25,7 @@
 
 
       <link rel="icon" href="../../assets/ms_icon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
 
 
 

analyzer/analyzer_engine_provider/index.html

@@ -25,7 +25,7 @@
 
 
       <link rel="icon" href="../../assets/ms_icon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
 
 
 

analyzer/customizing_nlp_models/index.html

@@ -25,7 +25,7 @@
 
 
       <link rel="icon" href="../../assets/ms_icon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
 
 
 

analyzer/decision_process/index.html

@@ -25,7 +25,7 @@
 
 
       <link rel="icon" href="../../assets/ms_icon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
 
 
 
@@ -4649,7 +4649,7 @@ <h2 id="examples">Examples</h2>
 </code></pre></div>
 <h2 id="writing-custom-decision-process-for-a-recognizer">Writing custom decision process for a recognizer</h2>
 <p>When creating new PII recognizers, it is possible to add information about the recognizer's decision process. This information will be traced or returned to the user, depending on the configuration.</p>
-<p>For example, the <a href="https://github.com/microsoft/presidio/blob/main/presidio-analyzer/presidio_analyzer/predefined_recognizers/spacy_recognizer.py">spacy_recognizer.py</a> implements a custom trace as follows:</p>
+<p>For example, the <a href="https://github.com/microsoft/presidio/blob/main/presidio-analyzer/presidio_analyzer/predefined_recognizers/nlp_engine_recognizers/spacy_recognizer.py">spacy_recognizer.py</a> implements a custom trace as follows:</p>
 <div class="highlight"><pre><span></span><code><span class="n">SPACY_DEFAULT_EXPLANATION</span> <span class="o">=</span> <span class="s2">&quot;Identified as </span><span class="si">{}</span><span class="s2"> by Spacy&#39;s Named Entity Recognition&quot;</span>
 
 <span class="k">def</span><span class="w"> </span><span class="nf">build_spacy_explanation</span><span class="p">(</span><span class="n">recognizer_name</span><span class="p">,</span> <span class="n">original_score</span><span class="p">,</span> <span class="n">entity</span><span class="p">):</span>

analyzer/developing_recognizers/index.html

@@ -25,7 +25,7 @@
 
 
       <link rel="icon" href="../../assets/ms_icon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
 
 
 

analyzer/index.html

@@ -25,7 +25,7 @@
 
 
       <link rel="icon" href="../assets/ms_icon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
 
 
 

analyzer/languages/index.html

@@ -25,7 +25,7 @@
 
 
       <link rel="icon" href="../../assets/ms_icon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
 
 
 

analyzer/nlp_engines/gpu_usage/index.html

@@ -25,7 +25,7 @@
 
 
       <link rel="icon" href="../../../assets/ms_icon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
 
 
 
@@ -1796,6 +1796,17 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#environment-variable-override" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Environment Variable Override
+      
+    </span>
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#prerequisites" class="md-nav__link">
     <span class="md-ellipsis">
@@ -4529,6 +4540,17 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#environment-variable-override" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Environment Variable Override
+      
+    </span>
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#prerequisites" class="md-nav__link">
     <span class="md-ellipsis">
@@ -4673,6 +4695,25 @@
 
 <h1 id="gpu-acceleration">GPU Acceleration</h1>
 <p>Presidio supports GPU acceleration for NLP models, which can significantly improve performance when processing large volumes of text. GPU is automatically detected and used when available—no code changes required.</p>
+<h2 id="environment-variable-override">Environment Variable Override</h2>
+<p>You can explicitly control device selection using the <code>PRESIDIO_DEVICE</code> environment variable. Any valid PyTorch device string is accepted:</p>
+<div class="highlight"><pre><span></span><code><span class="c1"># Force CPU usage</span>
+<span class="nb">export</span><span class="w"> </span><span class="nv">PRESIDIO_DEVICE</span><span class="o">=</span>cpu
+
+<span class="c1"># Force GPU usage</span>
+<span class="nb">export</span><span class="w"> </span><span class="nv">PRESIDIO_DEVICE</span><span class="o">=</span>cuda
+
+<span class="c1"># Use a specific GPU</span>
+<span class="nb">export</span><span class="w"> </span><span class="nv">PRESIDIO_DEVICE</span><span class="o">=</span>cuda:0
+<span class="nb">export</span><span class="w"> </span><span class="nv">PRESIDIO_DEVICE</span><span class="o">=</span>cuda:1
+
+<span class="c1"># Or when running Docker containers</span>
+docker<span class="w"> </span>run<span class="w"> </span>-e<span class="w"> </span><span class="nv">PRESIDIO_DEVICE</span><span class="o">=</span>cuda<span class="w"> </span>mcr.microsoft.com/presidio-analyzer:latest
+</code></pre></div>
+<div class="admonition note">
+<p class="admonition-title">Priority</p>
+<p>When <code>PRESIDIO_DEVICE</code> is set, it takes priority over automatic detection. If not set (or empty), Presidio will auto-detect available hardware.</p>
+</div>
 <h2 id="prerequisites">Prerequisites</h2>
 <h3 id="hardware-requirements">Hardware Requirements</h3>
 <table>