Skip to content

Commit

Permalink
Deployed 1ebc7d7 to master with MkDocs 1.6.1 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@percevalw
percevalw committed Nov 15, 2024
1 parent add6205 commit 3f0bfea
Show file tree
Hide file tree
Showing 101 changed files with 100 additions and 101 deletions.
1 change: 0 additions & 1 deletion master/assets/overrides/partials/comments.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{% if page.url.split("/")[0] in ["concepts", "tutorials", "pipes", "tokenizers", "data", "utilities"] %}
<h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
<script src="https://giscus.app/client.js"
data-repo="aphp/edsnlp"
data-repo-id="R_kgDOG97JnA"
Expand Down
2 changes: 1 addition & 1 deletion master/concepts/inference/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@

<span class="c1"># Accumulate in chunks of fragments, in the case of parquet datasets</span>
<span class="n">lengths</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n"><html><head></head><body><a class="discrete-link" href="#edsnlp.core.stream.Stream.map_batches">map_batches</a></body></html></span><span class="p">(</span><span class="nb">len</span><span class="p">,</span> <span class="n">batch_size</span><span class="o">=</span><span class="s2">"fragments"</span><span class="p">)</span>
</code></pre></div> <p>Note that these batch functions are only available under specific conditions:</p> <ul> <li>either <code>backend="simple"</code> or <code>deterministic=True</code> (default) if <code>backend="multiprocessing"</code>, otherwise elements might be processed out of order</li> <li>if every op before was elementwise (e.g. <code>map()</code>, <code>map_gpu()</code>, <code>map_pipeline()</code> and no generator function), or <code>sentinel_mode</code> was explicitly set to <code>"split"</code> in <code>map_batches()</code>, otherwise the sentinel are dropped by default when the user requires batching.</li> </ul> <div class="footnote"><hr/><ol></ol></div> <h2 id="__comments">Comments</h2> <script async="" crossorigin="anonymous" data-category="Announcements" data-category-id="DIC_kwDOG97JnM4CkS1h" data-emit-metadata="0" data-input-position="bottom" data-lang="en" data-mapping="title" data-reactions-enabled="1" data-repo="aphp/edsnlp" data-repo-id="R_kgDOG97JnA" data-strict="0" data-theme="https://aphp.github.io/edsnlp/master/assets/stylesheets/giscus_light.css" loading="lazy" src="https://giscus.app/client.js">
</code></pre></div> <p>Note that these batch functions are only available under specific conditions:</p> <ul> <li>either <code>backend="simple"</code> or <code>deterministic=True</code> (default) if <code>backend="multiprocessing"</code>, otherwise elements might be processed out of order</li> <li>if every op before was elementwise (e.g. <code>map()</code>, <code>map_gpu()</code>, <code>map_pipeline()</code> and no generator function), or <code>sentinel_mode</code> was explicitly set to <code>"split"</code> in <code>map_batches()</code>, otherwise the sentinel are dropped by default when the user requires batching.</li> </ul> <div class="footnote"><hr/><ol></ol></div> <script async="" crossorigin="anonymous" data-category="Announcements" data-category-id="DIC_kwDOG97JnM4CkS1h" data-emit-metadata="0" data-input-position="bottom" data-lang="en" data-mapping="title" data-reactions-enabled="1" data-repo="aphp/edsnlp" data-repo-id="R_kgDOG97JnA" data-strict="0" data-theme="https://aphp.github.io/edsnlp/master/assets/stylesheets/giscus_light.css" loading="lazy" src="https://giscus.app/client.js">
</script> <script>
var giscus = document.querySelector("script[src*=giscus]")

Expand Down
2 changes: 1 addition & 1 deletion master/concepts/pipeline/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<span class="n">description</span><span class="o">=</span><span class="s2">"A short description of your package"</span><span class="p">,</span>
<span class="p">),</span>
<span class="p">)</span>
</code></pre></div> <p>This will create a wheel file in the root_dir/dist folder, which you can share and install with pip.</p> <div class="footnote"><hr/><ol></ol></div> <h2 id="__comments">Comments</h2> <script async="" crossorigin="anonymous" data-category="Announcements" data-category-id="DIC_kwDOG97JnM4CkS1h" data-emit-metadata="0" data-input-position="bottom" data-lang="en" data-mapping="title" data-reactions-enabled="1" data-repo="aphp/edsnlp" data-repo-id="R_kgDOG97JnA" data-strict="0" data-theme="https://aphp.github.io/edsnlp/master/assets/stylesheets/giscus_light.css" loading="lazy" src="https://giscus.app/client.js">
</code></pre></div> <p>This will create a wheel file in the root_dir/dist folder, which you can share and install with pip.</p> <div class="footnote"><hr/><ol></ol></div> <script async="" crossorigin="anonymous" data-category="Announcements" data-category-id="DIC_kwDOG97JnM4CkS1h" data-emit-metadata="0" data-input-position="bottom" data-lang="en" data-mapping="title" data-reactions-enabled="1" data-repo="aphp/edsnlp" data-repo-id="R_kgDOG97JnA" data-strict="0" data-theme="https://aphp.github.io/edsnlp/master/assets/stylesheets/giscus_light.css" loading="lazy" src="https://giscus.app/client.js">
</script> <script>
var giscus = document.querySelector("script[src*=giscus]")

Expand Down
2 changes: 1 addition & 1 deletion master/concepts/torch-component/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@
<span class="sd"> """</span>
<span class="o">...</span>
<span class="k">return</span> <span class="n">docs</span>
</code></pre></div> <div class="footnote"><hr/><ol></ol></div> <h2 id="__comments">Comments</h2> <script async="" crossorigin="anonymous" data-category="Announcements" data-category-id="DIC_kwDOG97JnM4CkS1h" data-emit-metadata="0" data-input-position="bottom" data-lang="en" data-mapping="title" data-reactions-enabled="1" data-repo="aphp/edsnlp" data-repo-id="R_kgDOG97JnA" data-strict="0" data-theme="https://aphp.github.io/edsnlp/master/assets/stylesheets/giscus_light.css" loading="lazy" src="https://giscus.app/client.js">
</code></pre></div> <div class="footnote"><hr/><ol></ol></div> <script async="" crossorigin="anonymous" data-category="Announcements" data-category-id="DIC_kwDOG97JnM4CkS1h" data-emit-metadata="0" data-input-position="bottom" data-lang="en" data-mapping="title" data-reactions-enabled="1" data-repo="aphp/edsnlp" data-repo-id="R_kgDOG97JnA" data-strict="0" data-theme="https://aphp.github.io/edsnlp/master/assets/stylesheets/giscus_light.css" loading="lazy" src="https://giscus.app/client.js">
</script> <script>
var giscus = document.querySelector("script[src*=giscus]")

Expand Down
2 changes: 1 addition & 1 deletion master/data/converters/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@
<span class="w"> </span><span class="nt">"certainty"</span><span class="p">:</span><span class="w"> </span><span class="s2">"probable"</span>
<span class="w"> </span><span class="err">...</span>
<span class="p">}</span>
</code></pre></div> <div class="doc doc-object doc-class"> <div class="doc doc-contents first"> <h4 id="edsnlp.data.converters.EntsDoc2DictConverter--parameters">Parameters</h4> <table> <thead> <tr> <th><b>PARAMETER</b></th> <th><b>DESCRIPTION</b></th> </tr> </thead> <tbody> <tr> <td><code>span_getter</code></td> <td class="doc-param-details"> <p>The span getter to use when getting the spans from the documents. Defaults to getting the spans in the <code>ents</code> attribute.</p> <p> <span class="doc-param-annotation"> <b>TYPE:</b> <code><a class="autorefs autorefs-internal" href="../../reference/edsnlp/utils/span_getters/#edsnlp.utils.span_getters.SpanGetterArg" title="edsnlp.utils.span_getters.SpanGetterArg">SpanGetterArg</a></code> </span> <span class="doc-param-default"> <b>DEFAULT:</b> <code>{'ents': True}</code> </span> </p> </td> </tr> <tr> <td><code>doc_attributes</code></td> <td class="doc-param-details"> <p>Mapping from Doc extensions to JSON attributes (can be a list too). By default, no doc attribute is exported, except <code>note_id</code>.</p> <p> <span class="doc-param-annotation"> <b>TYPE:</b> <code><a class="autorefs autorefs-internal" href="../../reference/edsnlp/data/converters/#edsnlp.data.converters.AttributesMappingArg" title="edsnlp.data.converters.AttributesMappingArg">AttributesMappingArg</a></code> </span> <span class="doc-param-default"> <b>DEFAULT:</b> <code>{}</code> </span> </p> </td> </tr> <tr> <td><code>span_attributes</code></td> <td class="doc-param-details"> <p>Mapping from Span extensions to JSON attributes (can be a list too). By default, no attribute is exported.</p> <p> <span class="doc-param-annotation"> <b>TYPE:</b> <code><a class="autorefs autorefs-internal" href="../../reference/edsnlp/data/converters/#edsnlp.data.converters.AttributesMappingArg" title="edsnlp.data.converters.AttributesMappingArg">AttributesMappingArg</a></code> </span> <span class="doc-param-default"> <b>DEFAULT:</b> <code>{}</code> </span> </p> </td> </tr> </tbody> </table> <div class="doc doc-children"> </div> </div> </div> <div class="footnote"><hr/><ol></ol></div> <h2 id="__comments">Comments</h2> <script async="" crossorigin="anonymous" data-category="Announcements" data-category-id="DIC_kwDOG97JnM4CkS1h" data-emit-metadata="0" data-input-position="bottom" data-lang="en" data-mapping="title" data-reactions-enabled="1" data-repo="aphp/edsnlp" data-repo-id="R_kgDOG97JnA" data-strict="0" data-theme="https://aphp.github.io/edsnlp/master/assets/stylesheets/giscus_light.css" loading="lazy" src="https://giscus.app/client.js">
</code></pre></div> <div class="doc doc-object doc-class"> <div class="doc doc-contents first"> <h4 id="edsnlp.data.converters.EntsDoc2DictConverter--parameters">Parameters</h4> <table> <thead> <tr> <th><b>PARAMETER</b></th> <th><b>DESCRIPTION</b></th> </tr> </thead> <tbody> <tr> <td><code>span_getter</code></td> <td class="doc-param-details"> <p>The span getter to use when getting the spans from the documents. Defaults to getting the spans in the <code>ents</code> attribute.</p> <p> <span class="doc-param-annotation"> <b>TYPE:</b> <code><a class="autorefs autorefs-internal" href="../../reference/edsnlp/utils/span_getters/#edsnlp.utils.span_getters.SpanGetterArg" title="edsnlp.utils.span_getters.SpanGetterArg">SpanGetterArg</a></code> </span> <span class="doc-param-default"> <b>DEFAULT:</b> <code>{'ents': True}</code> </span> </p> </td> </tr> <tr> <td><code>doc_attributes</code></td> <td class="doc-param-details"> <p>Mapping from Doc extensions to JSON attributes (can be a list too). By default, no doc attribute is exported, except <code>note_id</code>.</p> <p> <span class="doc-param-annotation"> <b>TYPE:</b> <code><a class="autorefs autorefs-internal" href="../../reference/edsnlp/data/converters/#edsnlp.data.converters.AttributesMappingArg" title="edsnlp.data.converters.AttributesMappingArg">AttributesMappingArg</a></code> </span> <span class="doc-param-default"> <b>DEFAULT:</b> <code>{}</code> </span> </p> </td> </tr> <tr> <td><code>span_attributes</code></td> <td class="doc-param-details"> <p>Mapping from Span extensions to JSON attributes (can be a list too). By default, no attribute is exported.</p> <p> <span class="doc-param-annotation"> <b>TYPE:</b> <code><a class="autorefs autorefs-internal" href="../../reference/edsnlp/data/converters/#edsnlp.data.converters.AttributesMappingArg" title="edsnlp.data.converters.AttributesMappingArg">AttributesMappingArg</a></code> </span> <span class="doc-param-default"> <b>DEFAULT:</b> <code>{}</code> </span> </p> </td> </tr> </tbody> </table> <div class="doc doc-children"> </div> </div> </div> <div class="footnote"><hr/><ol></ol></div> <script async="" crossorigin="anonymous" data-category="Announcements" data-category-id="DIC_kwDOG97JnM4CkS1h" data-emit-metadata="0" data-input-position="bottom" data-lang="en" data-mapping="title" data-reactions-enabled="1" data-repo="aphp/edsnlp" data-repo-id="R_kgDOG97JnA" data-strict="0" data-theme="https://aphp.github.io/edsnlp/master/assets/stylesheets/giscus_light.css" loading="lazy" src="https://giscus.app/client.js">
</script> <script>
var giscus = document.querySelector("script[src*=giscus]")

Expand Down
2 changes: 1 addition & 1 deletion master/data/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<span class="c1"># How to convert Doc objects to JSON-like samples</span>
<span class="n">converter</span><span class="o">=</span><span class="n">predefined</span> <span class="n">schema</span> <span class="ow">or</span> <span class="n">function</span><span class="p">,</span>
<span class="p">)</span>
</code></pre></div> <p>The overall process is illustrated in the following diagram:</p> <p><img alt="Data connectors overview" src="overview.png"/></p> <p>At the moment, we support the following data sources:</p> <table> <thead> <tr> <th style="text-align: left;">Source</th> <th style="text-align: left;">Description</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;"><a href="./json">JSON</a></td> <td style="text-align: left;"><code>.json</code> and <code>.jsonl</code> files</td> </tr> <tr> <td style="text-align: left;"><a href="./standoff">Standoff &amp; BRAT</a></td> <td style="text-align: left;"><code>.ann</code> and <code>.txt</code> files</td> </tr> <tr> <td style="text-align: left;"><a href="./pandas">Pandas</a></td> <td style="text-align: left;">Pandas DataFrame objects</td> </tr> <tr> <td style="text-align: left;"><a href="./polars">Polars</a></td> <td style="text-align: left;">Polars DataFrame objects</td> </tr> <tr> <td style="text-align: left;"><a href="./spark">Spark</a></td> <td style="text-align: left;">Spark DataFrame objects</td> </tr> </tbody> </table> <p>and the following schemas:</p> <table> <thead> <tr> <th style="text-align: left;">Schema</th> <th>Snippet</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;"><a href="./converters/#custom">Custom</a></td> <td><code>converter=custom_fn</code></td> </tr> <tr> <td style="text-align: left;"><a href="./converters/#omop">OMOP</a></td> <td><code>converter="omop"</code></td> </tr> <tr> <td style="text-align: left;"><a href="./converters/#standoff">Standoff</a></td> <td><code>converter="standoff"</code></td> </tr> <tr> <td style="text-align: left;"><a href="./converters/#edsnlp.data.converters.EntsDoc2DictConverter">Ents</a></td> <td><code>converter="ents"</code></td> </tr> </tbody> </table> <div class="footnote"><hr/><ol></ol></div> <h2 id="__comments">Comments</h2> <script async="" crossorigin="anonymous" data-category="Announcements" data-category-id="DIC_kwDOG97JnM4CkS1h" data-emit-metadata="0" data-input-position="bottom" data-lang="en" data-mapping="title" data-reactions-enabled="1" data-repo="aphp/edsnlp" data-repo-id="R_kgDOG97JnA" data-strict="0" data-theme="https://aphp.github.io/edsnlp/master/assets/stylesheets/giscus_light.css" loading="lazy" src="https://giscus.app/client.js">
</code></pre></div> <p>The overall process is illustrated in the following diagram:</p> <p><img alt="Data connectors overview" src="overview.png"/></p> <p>At the moment, we support the following data sources:</p> <table> <thead> <tr> <th style="text-align: left;">Source</th> <th style="text-align: left;">Description</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;"><a href="./json">JSON</a></td> <td style="text-align: left;"><code>.json</code> and <code>.jsonl</code> files</td> </tr> <tr> <td style="text-align: left;"><a href="./standoff">Standoff &amp; BRAT</a></td> <td style="text-align: left;"><code>.ann</code> and <code>.txt</code> files</td> </tr> <tr> <td style="text-align: left;"><a href="./pandas">Pandas</a></td> <td style="text-align: left;">Pandas DataFrame objects</td> </tr> <tr> <td style="text-align: left;"><a href="./polars">Polars</a></td> <td style="text-align: left;">Polars DataFrame objects</td> </tr> <tr> <td style="text-align: left;"><a href="./spark">Spark</a></td> <td style="text-align: left;">Spark DataFrame objects</td> </tr> </tbody> </table> <p>and the following schemas:</p> <table> <thead> <tr> <th style="text-align: left;">Schema</th> <th>Snippet</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;"><a href="./converters/#custom">Custom</a></td> <td><code>converter=custom_fn</code></td> </tr> <tr> <td style="text-align: left;"><a href="./converters/#omop">OMOP</a></td> <td><code>converter="omop"</code></td> </tr> <tr> <td style="text-align: left;"><a href="./converters/#standoff">Standoff</a></td> <td><code>converter="standoff"</code></td> </tr> <tr> <td style="text-align: left;"><a href="./converters/#edsnlp.data.converters.EntsDoc2DictConverter">Ents</a></td> <td><code>converter="ents"</code></td> </tr> </tbody> </table> <div class="footnote"><hr/><ol></ol></div> <script async="" crossorigin="anonymous" data-category="Announcements" data-category-id="DIC_kwDOG97JnM4CkS1h" data-emit-metadata="0" data-input-position="bottom" data-lang="en" data-mapping="title" data-reactions-enabled="1" data-repo="aphp/edsnlp" data-repo-id="R_kgDOG97JnA" data-strict="0" data-theme="https://aphp.github.io/edsnlp/master/assets/stylesheets/giscus_light.css" loading="lazy" src="https://giscus.app/client.js">
</script> <script>
var giscus = document.querySelector("script[src*=giscus]")

Expand Down
Loading

0 comments on commit 3f0bfea

Please sign in to comment.