deploy: 50b3e30

flairNLP · Nov 10, 2023 · 5b1671e · 5b1671e
1 parent a050195
commit 5b1671e
Show file tree

Hide file tree

Showing 168 changed files with 2,388 additions and 2,388 deletions.
diff --git a/master/.buildinfo b/master/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d4cb2fce2d9c3082e30263de5cf595e5
+config: 06114176e8fbc6242c46c364f87bcf27
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/master/.doctrees/api/datasets/base.doctree b/master/.doctrees/api/datasets/base.doctree
diff --git a/master/.doctrees/api/datasets/biomedical.doctree b/master/.doctrees/api/datasets/biomedical.doctree
diff --git a/master/.doctrees/api/datasets/document_classification.doctree b/master/.doctrees/api/datasets/document_classification.doctree
diff --git a/master/.doctrees/api/datasets/entity_linking.doctree b/master/.doctrees/api/datasets/entity_linking.doctree
diff --git a/master/.doctrees/api/datasets/ocr.doctree b/master/.doctrees/api/datasets/ocr.doctree
diff --git a/master/.doctrees/api/datasets/relation_extraction.doctree b/master/.doctrees/api/datasets/relation_extraction.doctree
diff --git a/master/.doctrees/api/datasets/sequence_labeling.doctree b/master/.doctrees/api/datasets/sequence_labeling.doctree
diff --git a/master/.doctrees/api/datasets/text_image.doctree b/master/.doctrees/api/datasets/text_image.doctree
diff --git a/master/.doctrees/api/datasets/text_text.doctree b/master/.doctrees/api/datasets/text_text.doctree
diff --git a/master/.doctrees/api/datasets/treebanks.doctree b/master/.doctrees/api/datasets/treebanks.doctree
diff --git a/master/.doctrees/api/embeddings/base.doctree b/master/.doctrees/api/embeddings/base.doctree
diff --git a/master/.doctrees/api/embeddings/document.doctree b/master/.doctrees/api/embeddings/document.doctree
diff --git a/master/.doctrees/api/embeddings/image.doctree b/master/.doctrees/api/embeddings/image.doctree
diff --git a/master/.doctrees/api/embeddings/legacy.doctree b/master/.doctrees/api/embeddings/legacy.doctree
diff --git a/master/.doctrees/api/embeddings/token.doctree b/master/.doctrees/api/embeddings/token.doctree
diff --git a/master/.doctrees/api/embeddings/transformer.doctree b/master/.doctrees/api/embeddings/transformer.doctree
diff --git a/master/.doctrees/api/flair.data.doctree b/master/.doctrees/api/flair.data.doctree
diff --git a/master/.doctrees/api/flair.datasets.doctree b/master/.doctrees/api/flair.datasets.doctree
diff --git a/master/.doctrees/api/flair.doctree b/master/.doctrees/api/flair.doctree
diff --git a/master/.doctrees/api/flair.embeddings.doctree b/master/.doctrees/api/flair.embeddings.doctree
diff --git a/master/.doctrees/api/flair.models.doctree b/master/.doctrees/api/flair.models.doctree
diff --git a/master/.doctrees/api/flair.nn.doctree b/master/.doctrees/api/flair.nn.doctree
diff --git a/master/.doctrees/api/flair.splitter.doctree b/master/.doctrees/api/flair.splitter.doctree
diff --git a/master/.doctrees/api/flair.tokenization.doctree b/master/.doctrees/api/flair.tokenization.doctree
diff --git a/master/.doctrees/api/flair.trainers.doctree b/master/.doctrees/api/flair.trainers.doctree
diff --git a/master/.doctrees/api/flair.trainers.plugins.doctree b/master/.doctrees/api/flair.trainers.plugins.doctree
diff --git a/master/.doctrees/api/index.doctree b/master/.doctrees/api/index.doctree
diff --git a/master/.doctrees/contributing/index.doctree b/master/.doctrees/contributing/index.doctree
diff --git a/master/.doctrees/contributing/local_development.doctree b/master/.doctrees/contributing/local_development.doctree
diff --git a/master/.doctrees/contributing/making_a_pull_request.doctree b/master/.doctrees/contributing/making_a_pull_request.doctree
diff --git a/master/.doctrees/contributing/updating_documentation.doctree b/master/.doctrees/contributing/updating_documentation.doctree
diff --git a/master/.doctrees/contributing/writing_a_good_issue.doctree b/master/.doctrees/contributing/writing_a_good_issue.doctree
diff --git a/master/.doctrees/environment.pickle b/master/.doctrees/environment.pickle
diff --git a/master/.doctrees/glossary/index.doctree b/master/.doctrees/glossary/index.doctree
diff --git a/master/.doctrees/index.doctree b/master/.doctrees/index.doctree
diff --git a/master/.doctrees/tutorial/index.doctree b/master/.doctrees/tutorial/index.doctree
diff --git a/master/.doctrees/tutorial/intro.doctree b/master/.doctrees/tutorial/intro.doctree
diff --git a/master/.doctrees/tutorial/tutorial-basics/basic-types.doctree b/master/.doctrees/tutorial/tutorial-basics/basic-types.doctree
diff --git a/master/.doctrees/tutorial/tutorial-basics/entity-linking.doctree b/master/.doctrees/tutorial/tutorial-basics/entity-linking.doctree
diff --git a/master/.doctrees/tutorial/tutorial-basics/how-predictions-work.doctree b/master/.doctrees/tutorial/tutorial-basics/how-predictions-work.doctree
diff --git a/master/.doctrees/tutorial/tutorial-basics/how-to-tag-corpus.doctree b/master/.doctrees/tutorial/tutorial-basics/how-to-tag-corpus.doctree
diff --git a/master/.doctrees/tutorial/tutorial-basics/index.doctree b/master/.doctrees/tutorial/tutorial-basics/index.doctree
diff --git a/master/.doctrees/tutorial/tutorial-basics/other-models.doctree b/master/.doctrees/tutorial/tutorial-basics/other-models.doctree
diff --git a/master/.doctrees/tutorial/tutorial-basics/part-of-speech-tagging.doctree b/master/.doctrees/tutorial/tutorial-basics/part-of-speech-tagging.doctree
diff --git a/master/.doctrees/tutorial/tutorial-basics/tagging-entities.doctree b/master/.doctrees/tutorial/tutorial-basics/tagging-entities.doctree
diff --git a/master/.doctrees/tutorial/tutorial-basics/tagging-sentiment.doctree b/master/.doctrees/tutorial/tutorial-basics/tagging-sentiment.doctree
diff --git a/master/.doctrees/tutorial/tutorial-embeddings/classic-word-embeddings.doctree b/master/.doctrees/tutorial/tutorial-embeddings/classic-word-embeddings.doctree
diff --git a/master/.doctrees/tutorial/tutorial-embeddings/embeddings.doctree b/master/.doctrees/tutorial/tutorial-embeddings/embeddings.doctree
diff --git a/master/.doctrees/tutorial/tutorial-embeddings/flair-embeddings.doctree b/master/.doctrees/tutorial/tutorial-embeddings/flair-embeddings.doctree
diff --git a/master/.doctrees/tutorial/tutorial-embeddings/index.doctree b/master/.doctrees/tutorial/tutorial-embeddings/index.doctree
diff --git a/master/.doctrees/tutorial/tutorial-embeddings/other-embeddings.doctree b/master/.doctrees/tutorial/tutorial-embeddings/other-embeddings.doctree
diff --git a/master/.doctrees/tutorial/tutorial-embeddings/transformer-embeddings.doctree b/master/.doctrees/tutorial/tutorial-embeddings/transformer-embeddings.doctree
diff --git a/master/.doctrees/tutorial/tutorial-training/how-model-training-works.doctree b/master/.doctrees/tutorial/tutorial-training/how-model-training-works.doctree
diff --git a/master/.doctrees/tutorial/tutorial-training/how-to-load-custom-dataset.doctree b/master/.doctrees/tutorial/tutorial-training/how-to-load-custom-dataset.doctree
diff --git a/master/.doctrees/tutorial/tutorial-training/how-to-load-prepared-dataset.doctree b/master/.doctrees/tutorial/tutorial-training/how-to-load-prepared-dataset.doctree
diff --git a/master/.doctrees/tutorial/tutorial-training/how-to-train-sequence-tagger.doctree b/master/.doctrees/tutorial/tutorial-training/how-to-train-sequence-tagger.doctree
diff --git a/master/.doctrees/tutorial/tutorial-training/how-to-train-text-classifier.doctree b/master/.doctrees/tutorial/tutorial-training/how-to-train-text-classifier.doctree
diff --git a/master/.doctrees/tutorial/tutorial-training/index.doctree b/master/.doctrees/tutorial/tutorial-training/index.doctree
diff --git a/master/.doctrees/tutorial/tutorial-training/train-vs-fine-tune.doctree b/master/.doctrees/tutorial/tutorial-training/train-vs-fine-tune.doctree
diff --git a/master/api/datasets/base.html b/master/api/datasets/base.html
@@ -573,7 +573,7 @@ <h3>Versions</h3>
 <dd><p>Instantiate FlairDatapointDataset.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>datapoints</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">DT</span></code>, bound= <a class="reference internal" href="../flair.data.html#flair.data.DataPoint" title="flair.data.DataPoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPoint</span></code></a>), <code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">DT</span></code>, bound= <a class="reference internal" href="../flair.data.html#flair.data.DataPoint" title="flair.data.DataPoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPoint</span></code></a>)]]) – DT or List of DT that make up FlairDatapointDataset</p>
+<dd class="field-odd"><p><strong>datapoints</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar`(``DT`</span></code>, bound= <a class="reference internal" href="../flair.data.html#flair.data.DataPoint" title="flair.data.DataPoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPoint</span></code></a>), <code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar`(``DT`</span></code>, bound= <a class="reference internal" href="../flair.data.html#flair.data.DataPoint" title="flair.data.DataPoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPoint</span></code></a>)]]</span>) – DT or List of DT that make up FlairDatapointDataset</p>
 </dd>
 </dl>
 </dd></dl>
@@ -583,7 +583,7 @@ <h3>Versions</h3>
 <span class="sig-name descname"><span class="pre">is_in_memory</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/flairNLP/flair/blob/master/flair/datasets/base.py#L55-L56"><span class="linkcode-link"><span class="pre">View</span> <span class="pre">on</span> <span class="pre">GitHub</span></span></a><a class="headerlink" href="#flair.datasets.base.FlairDatapointDataset.is_in_memory" title="Permalink to this definition">#</a></dt>
 <dd><dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
 </dd>
 </dl>
 </dd></dl>
@@ -617,8 +617,8 @@ <h3>Versions</h3>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>texts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]) – a string or List of string that make up StringDataset</p></li>
-<li><p><strong>use_tokenizer</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <a class="reference internal" href="../flair.tokenization.html#flair.tokenization.Tokenizer" title="flair.tokenization.Tokenizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tokenizer</span></code></a>]) – Custom tokenizer to use. If instead of providing a function, this parameter is just set to True,
+<li><p><strong>texts</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]</span>) – a string or List of string that make up StringDataset</p></li>
+<li><p><strong>use_tokenizer</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <a class="reference internal" href="../flair.tokenization.html#flair.tokenization.Tokenizer" title="flair.tokenization.Tokenizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tokenizer</span></code></a>]</span>) – Custom tokenizer to use. If instead of providing a function, this parameter is just set to True,
 <code class="xref py py-class docutils literal notranslate"><span class="pre">flair.tokenization.SegTokTokenizer</span></code> will be used.</p></li>
 </ul>
 </dd>
@@ -630,7 +630,7 @@ <h3>Versions</h3>
 <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_in_memory</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/flairNLP/flair/blob/master/flair/datasets/base.py#L93-L95"><span class="linkcode-link"><span class="pre">View</span> <span class="pre">on</span> <span class="pre">GitHub</span></span></a><a class="headerlink" href="#flair.datasets.base.StringDataset.is_in_memory" title="Permalink to this definition">#</a></dt>
 <dd><dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
 </dd>
 </dl>
 </dd></dl>
@@ -657,19 +657,19 @@ <h3>Versions</h3>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>query</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Query, e.g. {‘Län’: ‘Stockholms län’}</p></li>
-<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Host, e.g. ‘localhost’,</p></li>
-<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Port, e.g. 27017</p></li>
-<li><p><strong>database</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Database, e.g. ‘rosenberg’,</p></li>
-<li><p><strong>collection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Collection, e.g. ‘book’,</p></li>
-<li><p><strong>text_field</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Text field, e.g. ‘Beskrivning’,</p></li>
-<li><p><strong>categories_field</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]) – List of category fields, e.g [‘Län’, ‘Härad’, ‘Tingslag’, ‘Församling’, ‘Plats’],</p></li>
-<li><p><strong>max_tokens_per_doc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Takes at most this amount of tokens per document. If set to -1 all documents are taken as is.</p></li>
+<li><p><strong>query</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – Query, e.g. {‘Län’: ‘Stockholms län’}</p></li>
+<li><p><strong>host</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – Host, e.g. ‘localhost’,</p></li>
+<li><p><strong>port</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Port, e.g. 27017</p></li>
+<li><p><strong>database</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – Database, e.g. ‘rosenberg’,</p></li>
+<li><p><strong>collection</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – Collection, e.g. ‘book’,</p></li>
+<li><p><strong>text_field</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – Text field, e.g. ‘Beskrivning’,</p></li>
+<li><p><strong>categories_field</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]</span>) – List of category fields, e.g [‘Län’, ‘Härad’, ‘Tingslag’, ‘Församling’, ‘Plats’],</p></li>
+<li><p><strong>max_tokens_per_doc</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Takes at most this amount of tokens per document. If set to -1 all documents are taken as is.</p></li>
 <li><p><strong>max_tokens_per_doc</strong> – If set, truncates each Sentence to a maximum number of Tokens</p></li>
-<li><p><strong>max_chars_per_doc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – If set, truncates each Sentence to a maximum number of chars</p></li>
-<li><p><strong>tokenizer</strong> (<a class="reference internal" href="../flair.tokenization.html#flair.tokenization.Tokenizer" title="flair.tokenization.Tokenizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tokenizer</span></code></a>) – Custom tokenizer to use (default SegtokTokenizer)</p></li>
-<li><p><strong>in_memory</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – If True, keeps dataset as Sentences in memory, otherwise only keeps strings</p></li>
-<li><p><strong>tag_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The tag type to assign labels to.</p></li>
+<li><p><strong>max_chars_per_doc</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – If set, truncates each Sentence to a maximum number of chars</p></li>
+<li><p><strong>tokenizer</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="../flair.tokenization.html#flair.tokenization.Tokenizer" title="flair.tokenization.Tokenizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tokenizer</span></code></a></span>) – Custom tokenizer to use (default SegtokTokenizer)</p></li>
+<li><p><strong>in_memory</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – If True, keeps dataset as Sentences in memory, otherwise only keeps strings</p></li>
+<li><p><strong>tag_type</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The tag type to assign labels to.</p></li>
 </ul>
 </dd>
 </dl>
@@ -681,7 +681,7 @@ <h3>Versions</h3>
 <span class="sig-name descname"><span class="pre">is_in_memory</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/flairNLP/flair/blob/master/flair/datasets/base.py#L215-L216"><span class="linkcode-link"><span class="pre">View</span> <span class="pre">on</span> <span class="pre">GitHub</span></span></a><a class="headerlink" href="#flair.datasets.base.MongoDataset.is_in_memory" title="Permalink to this definition">#</a></dt>
 <dd><dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
 </dd>
 </dl>
 </dd></dl>