_pkgdown.yml

url: https://davidycliao.github.io/flaiR/

home:
  title: An R Wrapper for Accessing Flair NLP Library
  links:
  - text: Discussion
    href: https://github.com/davidycliao/flaiR/discussions
  - text: flair in Python
    href: https://flairnlp.github.io
  - text: "Text and Policy Research Group @ UCD"
    href: https://text-and-policy.com
  - text: "The Connected_Politics Lab @ UCD"
    href: https://www.ucd.ie/connected_politics/
  - text: "Centre for Artificial Intelligence in Government @ UoBirmingham"
    href: https://www.birmingham.ac.uk/research/centres-institutes/centre-for-artificial-intelligence-in-government
  - text: "ParlSpeech: Legislative Speeches in the Key Parliamentary Democracies"
    href: https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/L4OAKN
  - text: "ParlEE: Sentence-level Speeches of Six EU Legislative Chambers"
    href: https://pureportal.strath.ac.uk/en/datasets/parlee-plenary-speeches-v2-data-set-annotated-full-text-of-151-mi

reference:
- title: flair
  desc: <div class="text-justify"></div>
- contents:
  - import_flair

- title: flair_data
  desc: <div class="text-justify">Accessing flair.data module from flair. </div>
- contents:
  - flair_data
#   - flair_data()$BoundingBox
#   - flair_data()$Dictionary
#   - flair_data()$Label
#   - flair_data()$DataPoint
#   - flair_data()$Token
#   - flair_data()$Span
#   - flair_data()$Relation
#   - flair_data()$Sentence
#   - flair_data()$DataPair
#   - flair_data()$Image
#   - flair_data()$Corpus
#   - flair_data()$MultiCorpus
#   - flair_data()$FlairDataset
#   - flair_data()$ConcatFlairDataset
#   - flair_data()$iob2()
#   - flair_data()$randomly_split_into_two_datasets()
#   - flair_data()$get_spans_from_bio()


- title: flair_datasets
  desc: <div class="text-justify">Accessing flair.datasets module from flair.</div>
- contents:
  - flair_datasets
  - flair_data.Sentence
#   - flair_datasets()$base
#   - flair_datasets()$biomedical
#   - flair_datasets()$document_classification
#   - flair_datasets()$entity_linking
#   - flair_datasets()$ocr
#   - flair_datasets()$relation_extraction
#   - flair_datasets()$sequence_labeling
#   - flair_datasets()$text_image
#   - flair_datasets()$text_text
#   - flair_datasets()$treebanks

- title: flair_embeddings
  desc: <div class="text-justify">Accessing flair.embeddings module from flair. </div>
- contents:
  - flair_embeddings
  - flair_embeddings.FlairEmbeddings
  - flair_embeddings.TransformerDocumentEmbeddings
  - flair_embeddings.TransformerWordEmbeddings
  - flair_embeddings.WordEmbeddings
  - flair_embeddings.StackedEmbeddings
#   - flair_embeddings()$base
#     + flair_embeddings()$Embeddings
#     + flair_embeddings()$ScalarMix
#     + flair_embeddings()$DocumentEmbeddings
#     + flair_embeddings()$TokenEmbeddings
#     + flair_embeddings()$register_embeddings()
#     + flair_embeddings()$load_embeddings()
#   - flair_embeddings()$document
#     + flair_embeddings()$DocumentPoolEmbeddings
#     + flair_embeddings()$DocumentRNNEmbeddings
#     + flair_embeddings()$DocumentLSTMEmbeddings
#     + flair_embeddings()$DocumentGRUEmbeddings
#     + flair_embeddings()$DocumentCNNEmbeddings
#     + flair_embeddings()$DocumentMeanEmbeddings
#     + flair_embeddings()$DocumentLMEmbeddings
#     + flair_embeddings()$SentenceTransformerDocumentEmbeddings
#     + flair_embeddings()$DocumentCNNEmbeddings()
#   - flair_embeddings()$image
#     + flair_embeddings()$ImageEmbeddings
#     + flair_embeddings()$IdentityImageEmbeddings
#     + flair_embeddings()$PrecomputedImageEmbeddings
#     + flair_embeddings()$NetworkImageEmbeddings
#     + flair_embeddings()$ConvTransformNetworkImageEmbeddings
#   - flair_embeddings.legacy
#     + flair_embeddings()$ELMoEmbeddings
#     + flair_embeddings()$CharLMEmbeddings
#     + flair_embeddings()$DocumentMeanEmbeddings
#     + flair_embeddings()$DocumentLSTMEmbeddings
#   - flair_embeddings()$token
#     + flair_embeddings()$WordEmbeddings
#     + flair_embeddings()$TransformerWordEmbeddings
#     + flair_embeddings()$StackedEmbeddings
#     + flair_embeddings()$CharacterEmbeddings
#     + flair_embeddings()$FlairEmbeddings
#     + flair_embeddings()$PooledFlairEmbeddings
#     + flair_embeddings()$FastTextEmbeddings
#     + flair_embeddings()$OneHotEmbeddings
#     + flair_embeddings()$HashEmbeddings
#     + flair_embeddings()$MuseCrosslingualEmbeddings
#     + flair_embeddings()$BytePairEmbeddings
#     + flair_embeddings()$NILCEmbeddings
#   - flair_embeddings()$transformer
#     + flair_embeddings()$transformer$pad_sequence_embeddings
#     + flair_embeddings()$transformer$truncate_hidden_states
#     + flair_embeddings()$transformer$combine_strided_tensors
#     + flair_embeddings()$transformer$fill_masked_elements
#     + flair_embeddings()$transformer$insert_missing_embeddings
#     + flair_embeddings()$transformer$insert_missing_embeddings
#     + flair_embeddings()$transformer$fill_mean_token_embeddings
#     + flair_embeddings()$transformer$document_mean_pooling
#     + flair_embeddings()$transformer$document_max_pooling
#     + flair_embeddings()$transformer$remove_special_markup
#     + flair_embeddings()$transformer$TransformerBaseEmbeddings
#     + flair_embeddings()$transformer$TransformerOnnxEmbeddings
#     + flair_embeddings()$transformer$TransformerJitEmbeddings
#     + flair_embeddings()$transformer$TransformerJitWordEmbeddings
#     + flair_embeddings()$transformer$TransformerJitDocumentEmbeddings
#     + flair_embeddings()$transformer$TransformerOnnxWordEmbeddings
#     + flair_embeddings()$transformer$TransformerOnnxDocumentEmbeddings
#     + flair_embeddings()$transformer$TransformerEmbeddings

- title: flair_nn
  desc: <div class="text-justify">Accessing flair.nn module from flair.</div>
- contents:
  - flair_nn
  - flair_nn.Classifier
#   - flair_nn()$LockedDropout
#   - flair_nn()$WordDropout
#   - flair_nn()$Classifier
#   - flair_nn()$DefaultClassifier
#   - flair_nn()$Model
#   - flair_nn()$PrototypicalDecoder
#   - flair_nn()$LabelVerbalizerDecoder

- title: flair_trainers
  desc: <div class="text-justify">Accessing flair.trainers module from flair.</div>
- contents:
  - flair_trainers
#   - flair_trainers()$ModelTrainer
#   - flair_trainers()$LanguageModelTrainer
#   - flair_trainers()$TextCorpus

# - title: flair_tokenization Module
#   desc: <div class="text-justify">Tokenizers are used to represent algorithms and models to split plain text into individual tokens or words. All subclasses should overwrite tokenize(), which splits the given plain text into tokens. Moreover, subclasses may overwrite name(), returning a unique identifier representing the tokenizer’s configuration.</div>
#   - flair_tokenization()$Tokenizer
#   - flair_tokenization()$SpaceTokenizer
#   - flair_tokenization()$SegtokTokenizer
#   - flair_tokenization()$SpacyTokenizer
#   - flair_tokenization()$JapaneseTokenizer
#   - flair_tokenization()$SciSpacyTokenizer
#   - flair_tokenization()$TokenizerWrapper
#   - flair_tokenization()$SciSpacyTokenizer

- title: flair_splitter
  desc: Accessing flair.splitter module from flair.
- contents:
  - flair_splitter
  - flair_splitter.SegtokSentenceSplitter
#   - flair_splitter()$SentenceSplitter
#   - flair_splitter()$SegtokSentenceSplitter
#   - flair_splitter()$SpacySentenceSplitter
#   - flair_splitter()$SciSpacySentenceSplitter
#   - flair_splitter()$SciSpacySentenceSplitter
#   - flair_splitter()$TagSentenceSplitter
#   - flair_splitter()$NewlineSentenceSplitter
#   - flair_splitter()$NoSentenceSplitter

- title: flair_models
  desc: <div class="text-justify">Accessing flair.models module from flair. </div>
- contents:
  - flair_models
  - flair_models.TextClassifier
  - flair_models.Sequencetagger
#   - flair_models()$SpanClassifier
#   - flair_models()$LanguageModel
#   - flair_models()$Lemmatizer
#   - flair_models()$TextPairClassifier
#   - flair_models()$TextPairRegressor
#   - flair_models()$RelationClassifier
#   - flair_models()$RelationExtractor
#   - flair_models()$RegexpTagger
#   - flair_models()$SequenceTagger
#   - flair_models()$TokenClassifier
#   - flair_models()$WordTagger
#   - flair_models()$FewshotClassifier
#   - flair_models()$TARSClassifier
#   - flair_models()$TARSTagger
#   - flair_models()$TextClassifier
#   - flair_models()$TextRegressor
#   - flair_models()$ClusteringModel
#   - flair_models()$MultitaskModel

- title: Expanded Feats
  desc: <div class="text-justify">Extended functionality for working with three major functions to extract features in data.table.</div>
- contents:
  - load_tagger_ner
  - load_tagger_pos
  - load_tagger_sentiments
  - get_entities
  - get_entities_batch
  - get_pos
  - get_pos_batch
  - get_sentiments
  - get_sentiments_batch

- title: Toolbox
  desc: <div class="text-justify"> flairR utilities</div>
- contents:
  - flair_device
  - highlight_text
  - map_entities
  - embeddings_to_matrix
  - clear_flair_cache
  - show_flair_cache
  - uninstall_python_package
  - install_python_package

- title: Training Dataset
  desc: <div class="text-justify"> Training dataset for tutorial</div>
- contents:
  - cc_muller
  - gs_score
  - hatespeech_zh_tw
  - de_immigration
  - uk_immigration
  - statements

authors:
  Yen-Chieh Liao:
    href: https://davidycliao.github.io
  Stefan Müller:
    href: https://muellerstefan.net

template:
  package: tidytemplate
  bootstrap: 5
  includes:
    in_header: |
      <script defer data-domain="{YOUR DOMAIN},all.tidyverse.org" src="https://plausible.io/js/plausible.js"></script>
  params:
    ganalytics: G-3ZG40PPG98
    css: [man/pkgdown/extra.css]

development:
  mode: auto

navbar:
  type: inverse
  left:
  - icon: fa-home
    href: index.html
  - icon: fa-rocket
    text: Quick Start
    menu:
    - text: "NLP Tasks"
      href: articles/quickstart.html#nlp-tasks
    - text: "Class and Ojbect"
      href: articles/quickstart.html#class-and-ojbect
    - text: "More Details about Installation"
      href: articles/quickstart.html#more-details-about-installation


  - icon: fa-project-diagram
    text: Tutorial
    menu:
    - text: "Introduction"
      href: articles/tutorial.html#introduction
    - text: "Sentence and Token"
      href: articles/tutorial.html#sentence-and-token
    - text: "Sequence Taggings"
      href: articles/tutorial.html#sequence-taggings
    - text: "Performing NER Tasks"
      href: articles/tutorial.html#performing-ner-tasks
    - text: "Flair Embeddings"
      href: articles/tutorial.html#flair-embedding
    - text: "Training a Binary Classifier"
      href: articles/tutorial.html#training-a-binary-classifier
    - text: "Training RNNs"
      href: articles/tutorial.html#training-rnns
    - text: "Finetune Transformers "
      href: articles/tutorial.html#finetune-transformers

  - icon: fa-newspaper-o
    text: Expanded Feats
    menu:
    - text: "Part-of-speech Tagging"
      href: articles/get_pos.html
    - text: "Named Entity Recognition"
      href: articles/get_entities.html
    - text: "Tagging Sentiment"
      href: articles/get_sentiments.html
    - text: "The Coloring Entities"
      href: articles/highlight_text.html


  - icon: fa-file-code-o
    text: Reference
    menu:
    - text: "All Function Reference"
      href: reference/index.html
    # - text: "The flair Module"
    #   href: reference/index.html#the-flair-module
    # - text: "The flair_embeddings Module"
    #   href: reference/index.html#the-flair-embeddings-module
    # - text: "The flair_data Module"
    #   href: reference/index.html#the-flair-data-module
    # - text: "The flair_nn Module"
    #   href: reference/index.html#the-flair-nn-module
    # - text: "The flair_trainers Module"
    #   href: reference/index.html#the-flair-trainers-module
    # - text: "The flair_splitter Module"
    #   href: reference/index.html#the-flair-splitter-module
    # - text: "The flair_models Module"
    #   href: reference/index.html#the-flair-models-module
    # - text: "The flair_datasets Module"
    #   href: reference/index.html#the-flair-datasets-module
    # - text: "The Pre-trianed Models for NLP Tasks"
    #   href: articles/flair_models.html
    # - text: "The Wordembeddings in Flair"
    #   href: articles/transformer_wordembeddings.html

  - icon: fa-newspaper-o
    text: News
    menu:
    - text: "0.0.6"
      href: news/index.html#flair-006-2023-10-29
    - text: "0.0.5"
      href: news/index.html#flair-005-2023-10-01
    - text: "0.0.3"
      href: news/index.html#flair-003-2023-09-10
    - text: "0.0.1"
      href: news/index.html#flair-001-development-version

  right:
  - icon: fa-github fa-lg
    text: GitHub
    href: https://github.com/davidycliao/flaiR