_pkgdown.yml

template:
  package: newsrdown

navbar:
  title: "gensimr"
  left:
    - text: "Reference"
      href: "reference/"
    - text: "Installation"
      href: "articles/installation.html"
    - text: "Parsing"
      href: "articles/preprocessing.html"
    - text: "Modeling"
      menu:
        - text: "Topic Modeling"
          href: "articles/models.html"
        - text: "Scikit-learn"
          href: "articles/sklearn.html"
        - text: "summarization"
          href: "articles/summarization.html"
        - text: "Word2vec"
          href: "articles/word2vec.html"
        - text: "Poincaré Embeddings"
          href: "articles/poincare.html"
        - text: "Document similarity"
          href: "articles/similarity.html"
        - text: "Hyperparameters"
          href: "articles/hyperparameters.html"
        - text: "Topic coherence"
          href: "articles/coherence.html"
        - text: "API"
          href: "articles/API.html"
  right:
    - icon: fa-balance-scale
      href: LICENSE.html
    - icon: fa-newspaper-o
      href: news/index.html
    - icon: fa-github fa-lg
      href: "https://github.com/news-r/gensimr"

reference:
  - title: "API"
    desc: >
      Download and use pre.trained models or datasets.
    contents: 
      - matches("api")
  - title: "Data"
    desc: >
      Helper functions and dataset for demonstration purposes.
    contents: 
      - authors
      - corpus
      - common_texts
      - common_corpus
      - common_dictionary
      - datapath
  - title: "Dependencies"
    desc: >
      Install python dependencies
    contents:
      - install_dependencies
      - install_gensim
      - install_sklearn
  - title: "Corpora"
    desc: >
      Transform and clean corpora.
    contents:
      - doc2bow
      - auth2doc
      - corpora_dictionary
      - matches("mmcorpus")
      - matches("strip")
      - matches("split")
      - porter_stemmer
      - prepare_documents
      - preprocess
      - remove_stopwords
      - stem_text
      - text8corpus
      - filter_rare
  - title: "Models"
    desc: "Available models and utilities."
    contents:
      - wrap
      - matches("model")
      - get_documents_topics
      - starts_with("load")
  - title: "Visualisation"
    desc: "Functions to visualise model outputs, embeddding, etc."
    contents:
      - prepare_ldavis
      - show_ldavis
      - plot_ldavis
      - ldavis_as_html
      - save_ldavis_html
      - save_ldavis_json
  - title: "Sklearn"
    desc: "Scikit-learn API."
    contents:
      - matches("sklearn")
  - title: "Document Similarity"
    desc: "Document similarity-related functions."
    contents:
      - similarity_matrix
      - get_similarity
      - similarity
  - title: "Summarize"
    desc: "Text summarization-related functions."
    contents:
      - summarize
      - keywords
      - get_bm25_weights
      - phrases

authors:
  John Coene:
    href: http://john-coene.com