Skip to content

Commit f475ca3

Browse files
github-actions[bot]github-actions[bot]
committed
deploy: a600a87 
1 parent e96408b commit f475ca3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+99
-57
lines changed

‎404.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616

1717
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css" integrity="sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM" crossorigin="anonymous"><link rel="stylesheet" href="/python-sdk/assets/css/styles.611a7811.css">
18-
<script src="/python-sdk/assets/js/runtime~main.2f59570f.js" defer="defer"></script>
18+
<script src="/python-sdk/assets/js/runtime~main.ff472a40.js" defer="defer"></script>
1919
<script src="/python-sdk/assets/js/main.1a8709fa.js" defer="defer"></script>
2020
</head>
2121
<body class="navigation-with-keyboard">

‎api-reference-docs/genindex.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,10 +149,10 @@ <h2 id="C">C</h2>
149149
</li>
150150
<li><a href="models.html#groundlight.ExperimentalApi.create_bounding_box_detector">create_bounding_box_detector() (groundlight.ExperimentalApi method)</a>
151151
</li>
152-
</ul></td>
153-
<td style="width: 33%; vertical-align: top;"><ul>
154152
<li><a href="models.html#groundlight.ExperimentalApi.create_counting_detector">create_counting_detector() (groundlight.ExperimentalApi method)</a>
155153
</li>
154+
</ul></td>
155+
<td style="width: 33%; vertical-align: top;"><ul>
156156
<li><a href="models.html#groundlight.Groundlight.create_detector">create_detector() (groundlight.Groundlight method)</a>
157157
</li>
158158
<li><a href="models.html#groundlight.ExperimentalApi.create_detector_group">create_detector_group() (groundlight.ExperimentalApi method)</a>
@@ -164,6 +164,8 @@ <h2 id="C">C</h2>
164164
<li><a href="models.html#groundlight.ExperimentalApi.create_roi">create_roi() (groundlight.ExperimentalApi method)</a>
165165
</li>
166166
<li><a href="models.html#groundlight.ExperimentalApi.create_rule">create_rule() (groundlight.ExperimentalApi method)</a>
167+
</li>
168+
<li><a href="models.html#groundlight.ExperimentalApi.create_text_recognition_detector">create_text_recognition_detector() (groundlight.ExperimentalApi method)</a>
167169
</li>
168170
<li><a href="models.html#model.Detector.created_at">created_at (model.Detector attribute)</a>
169171

‎api-reference-docs/models.html‎

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@
8181
<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.create_note"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.create_note()</span></code></a></li>
8282
<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.create_roi"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.create_roi()</span></code></a></li>
8383
<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.create_rule"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.create_rule()</span></code></a></li>
84+
<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.create_text_recognition_detector"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.create_text_recognition_detector()</span></code></a></li>
8485
<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.delete_all_rules"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.delete_all_rules()</span></code></a></li>
8586
<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.delete_rule"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.delete_rule()</span></code></a></li>
8687
<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.download_mlbinary"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.download_mlbinary()</span></code></a></li>
@@ -1306,7 +1307,8 @@ <h1>SDK Client<a class="headerlink" href="#sdk-client" title="Link to this headi
13061307
<span class="c1"># Use the detector to find people in an image</span>
13071308
<span class="n">image_query</span> <span class="o">=</span> <span class="n">gl</span><span class="o">.</span><span class="n">ask_ml</span><span class="p">(</span><span class="n">detector</span><span class="p">,</span> <span class="s2">&quot;path/to/image.jpg&quot;</span><span class="p">)</span>
13081309
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Confidence: </span><span class="si">{</span><span class="n">image_query</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">confidence</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
1309-
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Bounding boxes: </span><span class="si">{</span><span class="n">image_query</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">rois</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
1310+
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Label: </span><span class="si">{</span><span class="n">image_query</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">label</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
1311+
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Bounding boxes: </span><span class="si">{</span><span class="n">image_query</span><span class="o">.</span><span class="n">rois</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
13101312
</pre></div>
13111313
</div>
13121314
<dl class="field-list simple">
@@ -1625,6 +1627,44 @@ <h1>SDK Client<a class="headerlink" href="#sdk-client" title="Link to this headi
16251627
</dl>
16261628
</dd></dl>
16271629

1630+
<dl class="py method">
1631+
<dt class="sig sig-object py" id="groundlight.ExperimentalApi.create_text_recognition_detector">
1632+
<span class="sig-name descname"><span class="pre">create_text_recognition_detector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">confidence_threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">patience_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pipeline_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#model.Detector" title="model.Detector"><span class="pre">Detector</span></a></span></span><a class="headerlink" href="#groundlight.ExperimentalApi.create_text_recognition_detector" title="Link to this definition"></a></dt>
1633+
<dd><p>Creates a text recognition detector that can read specified spans of text from images.</p>
1634+
<p><strong>Example usage</strong>:</p>
1635+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">gl</span> <span class="o">=</span> <span class="n">ExperimentalApi</span><span class="p">()</span>
1636+
1637+
<span class="c1"># Create a text recognition detector</span>
1638+
<span class="n">detector</span> <span class="o">=</span> <span class="n">gl</span><span class="o">.</span><span class="n">create_text_recognition_detector</span><span class="p">(</span>
1639+
<span class="n">name</span><span class="o">=</span><span class="s2">&quot;date_and_time_detector&quot;</span><span class="p">,</span>
1640+
<span class="n">query</span><span class="o">=</span><span class="s2">&quot;Read the date and time from the bottom left corner of the image.&quot;</span><span class="p">,</span>
1641+
<span class="p">)</span>
1642+
</pre></div>
1643+
</div>
1644+
<dl class="field-list simple">
1645+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
1646+
<dd class="field-odd"><ul class="simple">
1647+
<li><p><strong>name</strong> (<em>str</em>) – A short, descriptive name for the detector.</p></li>
1648+
<li><p><strong>query</strong> (<em>str</em>) – A question about the object to detect in the image.</p></li>
1649+
<li><p><strong>group_name</strong> (<em>str</em><em> | </em><em>None</em>) – Optional name of a group to organize related detectors together.</p></li>
1650+
<li><p><strong>confidence_threshold</strong> (<em>float</em><em> | </em><em>None</em>) – A value that sets the minimum confidence level required for the ML model’s
1651+
predictions. If confidence is below this threshold, the query may be sent for human review.</p></li>
1652+
<li><p><strong>patience_time</strong> (<em>float</em><em> | </em><em>None</em>) – The maximum time in seconds that Groundlight will attempt to generate a
1653+
confident prediction before falling back to human review. Defaults to 30 seconds.</p></li>
1654+
<li><p><strong>pipeline_config</strong> (<em>str</em><em> | </em><em>None</em>) – Advanced usage only. Configuration string needed to instantiate a specific
1655+
prediction pipeline for this detector.</p></li>
1656+
<li><p><strong>metadata</strong> (<em>dict</em><em> | </em><em>str</em><em> | </em><em>None</em>) – A dictionary or JSON string containing custom key/value pairs to associate with</p></li>
1657+
</ul>
1658+
</dd>
1659+
<dt class="field-even">Returns<span class="colon">:</span></dt>
1660+
<dd class="field-even"><p>The created Detector object</p>
1661+
</dd>
1662+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
1663+
<dd class="field-odd"><p><a class="reference internal" href="#model.Detector" title="model.Detector"><em>Detector</em></a></p>
1664+
</dd>
1665+
</dl>
1666+
</dd></dl>
1667+
16281668
<dl class="py method">
16291669
<dt class="sig sig-object py" id="groundlight.ExperimentalApi.delete_all_rules">
16301670
<span class="sig-name descname"><span class="pre">delete_all_rules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">detector</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#model.Detector" title="model.Detector"><span class="pre">Detector</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#groundlight.ExperimentalApi.delete_all_rules" title="Link to this definition"></a></dt>

‎api-reference-docs/objects.inv‎

15 Bytes
Binary file not shown.

‎api-reference-docs/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)