deploy: cbe750f

flairNLP · Oct 23, 2023 · e1b2c7d · e1b2c7d
1 parent 69e4207
commit e1b2c7d
Show file tree

Hide file tree

Showing 127 changed files with 1,583 additions and 18 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: 02d163cee730135d8c010281c135c3fc
+config: f270513f402eb9b22bdcbb737046de74
 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/_images/glossary.svg b/master/_images/glossary.svg
diff --git a/master/_sources/glossary/index.rst.txt b/master/_sources/glossary/index.rst.txt
@@ -0,0 +1,7 @@
+Glossary
+========
+
+.. glossary::
+
+    Sentence
+      a sentence is a text-unit consisting of tokens, labels and possibly metadata. Notice that a sentence is not limited in size, hence a Sentence itself could hold either a full document, a paragraph, a simple phrase or a linguistic
diff --git a/master/_sources/index.rst.txt b/master/_sources/index.rst.txt
@@ -7,7 +7,7 @@ flair
 **Version**: |version|
 
 **Useful links**:
-`Getting started <gtutorial/index/intro.html>`_ |
+`Getting started <tutorial/intro.html>`_ |
 `Source Repository <https://github.com/flairNLP/flair>`_ |
 `Issue Tracker <https://github.com/flairNLP/flair/issues>`_ |
 
@@ -55,9 +55,9 @@ Flair is a very simple framework for state-of-the-art Natural Language Processin
         Contributor's Guide
         ^^^^^^^^^^^^^^^^^^^
 
-        Want to add to the codebase? Can help add translation or a flowchart to the
+        Want to add to the codebase? Can help add to the
         documentation? The contributing guidelines will guide you through the
-        process of improving NumPy.
+        process of improving Flair.
 
         +++
 
@@ -68,10 +68,28 @@ Flair is a very simple framework for state-of-the-art Natural Language Processin
 
             To the contributor's guide
 
+    .. grid-item-card::
+        :img-top: ./_static/glossary.svg
+
+        Glossary
+        ^^^^^^^^
+
+        Not sure what the exact meaning of certain terms is? Find their definition in the Glossary.
+
+        +++
+
+        .. button-ref:: glossary/index
+            :expand:
+            :color: secondary
+            :click-parent:
+
+            To the glossary
+
 .. toctree::
    :maxdepth: 3
    :hidden:
 
    Tutorials <tutorial/index>
    API reference <api/index>
-   Contributing <contributing/index>
+   Contributing <contributing/index>
+   Glossary <glossary/index>
diff --git a/master/_static/glossary.svg b/master/_static/glossary.svg
diff --git a/master/api/datasets/base.html b/master/api/datasets/base.html
@@ -147,6 +147,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -295,6 +302,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -401,6 +415,7 @@ <h3><a href="../../index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary/index.html">Glossary</a></li>
 </ul>
 </div>
         <div class="sidebar-primary-item">

diff --git a/master/api/datasets/biomedical.html b/master/api/datasets/biomedical.html
@@ -147,6 +147,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -295,6 +302,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -401,6 +415,7 @@ <h3><a href="../../index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary/index.html">Glossary</a></li>
 </ul>
 </div>
         <div class="sidebar-primary-item">

diff --git a/master/api/datasets/document_classification.html b/master/api/datasets/document_classification.html
@@ -147,6 +147,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -295,6 +302,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -401,6 +415,7 @@ <h3><a href="../../index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary/index.html">Glossary</a></li>
 </ul>
 </div>
         <div class="sidebar-primary-item">

diff --git a/master/api/datasets/entity_linking.html b/master/api/datasets/entity_linking.html
@@ -147,6 +147,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -295,6 +302,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -401,6 +415,7 @@ <h3><a href="../../index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary/index.html">Glossary</a></li>
 </ul>
 </div>
         <div class="sidebar-primary-item">

diff --git a/master/api/datasets/ocr.html b/master/api/datasets/ocr.html
@@ -147,6 +147,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -295,6 +302,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -401,6 +415,7 @@ <h3><a href="../../index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary/index.html">Glossary</a></li>
 </ul>
 </div>
         <div class="sidebar-primary-item">

diff --git a/master/api/datasets/relation_extraction.html b/master/api/datasets/relation_extraction.html
@@ -147,6 +147,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -295,6 +302,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -401,6 +415,7 @@ <h3><a href="../../index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary/index.html">Glossary</a></li>
 </ul>
 </div>
         <div class="sidebar-primary-item">

diff --git a/master/api/datasets/sequence_labeling.html b/master/api/datasets/sequence_labeling.html
@@ -147,6 +147,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -295,6 +302,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -401,6 +415,7 @@ <h3><a href="../../index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary/index.html">Glossary</a></li>
 </ul>
 </div>
         <div class="sidebar-primary-item">

diff --git a/master/api/datasets/text_image.html b/master/api/datasets/text_image.html
@@ -147,6 +147,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -295,6 +302,13 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../glossary/index.html">
+                        Glossary
+                      </a>
+                    </li>
+
   </ul>
 </nav></div>
 
@@ -401,6 +415,7 @@ <h3><a href="../../index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary/index.html">Glossary</a></li>
 </ul>
 </div>
         <div class="sidebar-primary-item">