Deployed 69d9966 to v0.10.6 with MkDocs 1.5.3 and mike 1.1.2

latest/pipes/core/matcher/index.html

@@ -21,4 +21,4 @@
         <span class=n>term_matcher_config</span><span class=o>=</span><span class=p>{},</span>
     <span class=p>),</span>
 <span class=p>)</span>
-</code></pre></div> <ol> <li>Every key in the <code>terms</code> dictionary is mapped to a concept.</li> <li>The <code><a href="#edsnlp.pipes.core.matcher.factory.create_component">eds.matcher</a></code> pipeline expects a list of expressions, or a single expression.</li> <li>We can also define regular expression patterns.</li> </ol> <p>This snippet is complete, and should run as is.</p> <p>Patterns, be they <code>terms</code> or <code>regex</code>, are defined as dictionaries where keys become the label of the extracted entities. Dictionary values are either a single expression or a list of expressions that match the concept.</p> <h2 id=edsnlp.pipes.core.matcher.factory.create_component--parameters>Parameters</h2> <table> <thead> <tr> <th><b>PARAMETER</b></th> <th><b>DESCRIPTION</b></th> </tr> </thead> <tbody> <tr> <td><code>nlp</code></td> <td class=doc-param-details> <p>The pipeline object.</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><span title="edsnlp.core.PipelineProtocol">PipelineProtocol</span></code> </span> </p> </td> </tr> <tr> <td><code>name</code></td> <td class=doc-param-details> <p>The name of the component.</p> <p> </p> </td> </tr> <tr> <td><code>terms</code></td> <td class=doc-param-details> <p>A dictionary of terms.</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><span title="typing.Optional">Optional</span>[<span title="edsnlp.matchers.utils.Patterns">Patterns</span>]</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>None</code> </span> </p> </td> </tr> <tr> <td><code>regex</code></td> <td class=doc-param-details> <p>A dictionary of regular expressions.</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><span title="typing.Optional">Optional</span>[<span title="edsnlp.matchers.utils.Patterns">Patterns</span>]</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>None</code> </span> </p> </td> </tr> <tr> <td><code>attr</code></td> <td class=doc-param-details> <p>The default attribute to use for matching. Can be overridden using the <code>terms</code> and <code>regex</code> configurations.</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code>str</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>TEXT</code> </span> </p> </td> </tr> <tr> <td><code>ignore_excluded</code></td> <td class=doc-param-details> <p>Whether to skip excluded tokens (requires an upstream pipeline to mark excluded tokens).</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code>bool</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>False</code> </span> </p> </td> </tr> <tr> <td><code>ignore_space_tokens</code></td> <td class=doc-param-details> <p>Whether to skip space tokens during matching.</p> <p>You won't be able to match on newlines if this is enabled and the "spaces"/"newline" option of <code><a href="../normalizer/#edsnlp.pipes.core.normalizer.factory.create_component">eds.normalizer</a></code> is enabled (by default).</p> <p> <span class=doc-param-default> <b>DEFAULT:</b> <code>False</code> </span> </p> </td> </tr> <tr> <td><code>term_matcher</code></td> <td class=doc-param-details> <p>The matcher to use for matching phrases ? One of (exact, simstring)</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><span title="typing_extensions.Literal">Literal</span>[&#39;exact&#39;, &#39;simstring&#39;]</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>exact</code> </span> </p> </td> </tr> <tr> <td><code>term_matcher_config</code></td> <td class=doc-param-details> <p>Parameters of the matcher class</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>{}</code> </span> </p> </td> </tr> <tr> <td><code>span_setter</code></td> <td class=doc-param-details> <p>How to set the spans in the doc.</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><a class="autorefs autorefs-internal" title="edsnlp.pipes.base.SpanSetterArg" href="../../ner/#edsnlp.pipes.base.SpanSetterArg">SpanSetterArg</a></code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>{&#39;ents&#39;: True}</code> </span> </p> </td> </tr> </tbody> </table> <details class=authors-and-citation open> <summary>Authors and citation</summary> <p>The <code><a href="#edsnlp.pipes.core.matcher.factory.create_component">eds.matcher</a></code> pipeline was developed by AP-HP's Data Science team.</p> </details> </div> </div> <div class=footnote><hr><ol/></div> </article> </div> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href="../sentences/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Sentences" rel=prev> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> Sentences </div> </div> </a> <a href="../terminology/" class="md-footer__link md-footer__link--next" aria-label="Next: Terminology" rel=next> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Terminology </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> Made with <a href="https://squidfunk.github.io/mkdocs-material/" target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../../..", "features": ["navigation.tracking", "navigation.instant", "navigation.indexes", "navigation.prune", "navigation.top", "navigation.footer", "content.code.annotate", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.dfff1995.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script> <script src=../../../assets/javascripts/bundle.dff1b7c8.min.js></script> <script src=https://cdn.jsdelivr.net/npm/vega@5></script> <script src=https://cdn.jsdelivr.net/npm/vega-lite@5></script> <script src=https://cdn.jsdelivr.net/npm/vega-embed@6></script> <script src=../../../assets/termynal/termynal.js></script> </body> </html>
+</code></pre></div> <ol> <li>Every key in the <code>terms</code> dictionary is mapped to a concept.</li> <li>The <code><a href="#edsnlp.pipes.core.matcher.factory.create_component">eds.matcher</a></code> pipeline expects a list of expressions, or a single expression.</li> <li>We can also define regular expression patterns.</li> </ol> <p>This snippet is complete, and should run as is.</p> <p>Patterns, be they <code>terms</code> or <code>regex</code>, are defined as dictionaries where keys become the label of the extracted entities. Dictionary values are either a single expression or a list of expressions that match the concept.</p> <h2 id=edsnlp.pipes.core.matcher.factory.create_component--parameters>Parameters</h2> <table> <thead> <tr> <th><b>PARAMETER</b></th> <th><b>DESCRIPTION</b></th> </tr> </thead> <tbody> <tr> <td><code>nlp</code></td> <td class=doc-param-details> <p>The pipeline object.</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><span title="edsnlp.core.PipelineProtocol">PipelineProtocol</span></code> </span> </p> </td> </tr> <tr> <td><code>name</code></td> <td class=doc-param-details> <p>The name of the component.</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><span title="typing.Optional">Optional</span>[str]</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>&#39;eds.matcher&#39;</code> </span> </p> </td> </tr> <tr> <td><code>terms</code></td> <td class=doc-param-details> <p>A dictionary of terms.</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><span title="typing.Optional">Optional</span>[<span title="edsnlp.matchers.utils.Patterns">Patterns</span>]</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>None</code> </span> </p> </td> </tr> <tr> <td><code>regex</code></td> <td class=doc-param-details> <p>A dictionary of regular expressions.</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><span title="typing.Optional">Optional</span>[<span title="edsnlp.matchers.utils.Patterns">Patterns</span>]</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>None</code> </span> </p> </td> </tr> <tr> <td><code>attr</code></td> <td class=doc-param-details> <p>The default attribute to use for matching. Can be overridden using the <code>terms</code> and <code>regex</code> configurations.</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code>str</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>TEXT</code> </span> </p> </td> </tr> <tr> <td><code>ignore_excluded</code></td> <td class=doc-param-details> <p>Whether to skip excluded tokens (requires an upstream pipeline to mark excluded tokens).</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code>bool</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>False</code> </span> </p> </td> </tr> <tr> <td><code>ignore_space_tokens</code></td> <td class=doc-param-details> <p>Whether to skip space tokens during matching.</p> <p>You won't be able to match on newlines if this is enabled and the "spaces"/"newline" option of <code><a href="../normalizer/#edsnlp.pipes.core.normalizer.factory.create_component">eds.normalizer</a></code> is enabled (by default).</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code>bool</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>False</code> </span> </p> </td> </tr> <tr> <td><code>term_matcher</code></td> <td class=doc-param-details> <p>The matcher to use for matching phrases ? One of (exact, simstring)</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><span title="typing_extensions.Literal">Literal</span>[&#39;exact&#39;, &#39;simstring&#39;]</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>exact</code> </span> </p> </td> </tr> <tr> <td><code>term_matcher_config</code></td> <td class=doc-param-details> <p>Parameters of the matcher class</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>{}</code> </span> </p> </td> </tr> <tr> <td><code>span_setter</code></td> <td class=doc-param-details> <p>How to set the spans in the doc.</p> <p> <span class=doc-param-annotation> <b>TYPE:</b> <code><a class="autorefs autorefs-internal" title="edsnlp.pipes.base.SpanSetterArg" href="../../ner/#edsnlp.pipes.base.SpanSetterArg">SpanSetterArg</a></code> </span> <span class=doc-param-default> <b>DEFAULT:</b> <code>{&#39;ents&#39;: True}</code> </span> </p> </td> </tr> </tbody> </table> <details class=authors-and-citation open> <summary>Authors and citation</summary> <p>The <code><a href="#edsnlp.pipes.core.matcher.factory.create_component">eds.matcher</a></code> pipeline was developed by AP-HP's Data Science team.</p> </details> </div> </div> <div class=footnote><hr><ol/></div> </article> </div> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href="../sentences/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Sentences" rel=prev> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> Sentences </div> </div> </a> <a href="../terminology/" class="md-footer__link md-footer__link--next" aria-label="Next: Terminology" rel=next> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Terminology </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> Made with <a href="https://squidfunk.github.io/mkdocs-material/" target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../../..", "features": ["navigation.tracking", "navigation.instant", "navigation.indexes", "navigation.prune", "navigation.top", "navigation.footer", "content.code.annotate", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.dfff1995.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script> <script src=../../../assets/javascripts/bundle.dff1b7c8.min.js></script> <script src=https://cdn.jsdelivr.net/npm/vega@5></script> <script src=https://cdn.jsdelivr.net/npm/vega-lite@5></script> <script src=https://cdn.jsdelivr.net/npm/vega-embed@6></script> <script src=../../../assets/termynal/termynal.js></script> </body> </html>