{"componentChunkName":"component---node-modules-carrotsearch-gatsby-theme-apidocs-templates-documentation-page-js","path":"/clustering-workbench-app/","result":{"data":{"html":{"frontmatter":{"id":"clustering-workbench-app","title":"Clustering Workbench"},"html":"
\n

Clustering Workbench

\n\n

\n You can use Clustering Workbench to quickly try and tune Lingo3G clustering\n on your data. If Workbench suits your needs, you can use it as a text mining\n and research tool.\n

\n\n
\n

\n Installation and running\n

\n\n

\n If you don't mind the\n limitations of\n the\n on-line version of Workbench, installation is not required.\n

\n\n
    \n
  1. \n

    \n Install Lingo3G on your\n machine.\n

    \n
    2. \n\n
  2. \n

    \n Start the\n Lingo3G Document Clustering Server (DCS)\n application located in the dcs/\n folder of your Lingo3G installation.\n

    \n\n
      \n
    • On Windows, run the dcs.cmd script.
      • \n
    • On Linux and Mac, run the dcs script.
      • \n
    \n\n

    \n If the DCS starts successfully, you should see a terminal window with\n messages similar to the following:\n

    \n\n
    \n 
    16:59:55: DCS context initialized [algorithms: [Lingo3G], templates: [frontend-default]]\n16:59:55: Service started on port 8080.\n16:59:55: The following contexts are available:\n  http://localhost:8080/          DCS Root\n  http://localhost:8080/doc       Documentation\n  http://localhost:8080/frontend  End-user apps\n  http://localhost:8080/javadoc   Java API Javadoc\n  http://localhost:8080/service   REST API
    \n
    \n
    3. \n\n
  3. \n

    \n Open\n http://localhost:8080/frontend/#/workbench\n in a modern browser.\n

    \n
    4. \n
\n
\n\n
\n

\n User interface highlights\n

\n\n

\n If you'd like to learn how to use Workbench to cluster your own data, see\n the\n Trying Lingo3G\n section. For some Clustering Workbench tips and tricks, see below.\n

\n\n
\n
Data source choice
\n
\n
\n
\n \n \"Data\n
\n
\n\n

\n Use the data source choice section to choose the data for clustering\n and to run the clustering process.\n

\n\n

\n The Cluster button turns blue once you modify any\n parameters in the\n parameters panel to let\n you know to re-run clustering for the parameter changes to take\n effect.\n

\n
\n\n
Clusters view
\n
\n
\n
\n \n \"Documents\n
\n
\n\n

\n The documents view shows the documents belonging to the cluster you\n select. Press the icon in the top right corner to\n configure which documents fields to show\n for each documents.\n

\n
\n\n
\n Documents view configuration\n
\n
\n
\n
\n \n \"Documents\n
\n
\n \n \"Documents\n
\n
\n\n

\n If the documents you submit for clustering contain multiple fields,\n you can use the document view configuration to choose which fields to\n show.\n

\n\n

For each field you can choose one of the following display roles:

\n\n
\n
title
\n
\n Shows in bold at the top of the document, works well for document\n title and other short textual fields.\n
\n\n
body
\n
\n Shows under title fields, works well for document body and other\n longer textual fields. Workbench truncates body fields if they\n exceed the maximum number of characters per document you configure.\n
\n\n
id
\n
Shows under body fields, use for document identifiers.
\n\n
tag
\n
\n Shows under the id fields, use for short multi-valued document\n fields, such as tags or list of authors.\n
\n\n
property
\n
\n Shows under the tag fields, use for short single-valued document\n fields, such as dates, numbers or booleans.\n
\n
\n\n

\n Workbench tries to determine the best document display configuration\n based on the distribution of the field values in your data set. You\n can tune that configuration if needed.\n

\n
\n\n
Parameters panel
\n
\n
\n
\n \n \"Parameters\n
\n
\n \n \"Parameters\n
\n
\n\n

\n Use the parameters panel to change parameters of the data source and\n the clustering algorithm. Click the (?) icon for a description of a\n specific parameter.\n

\n\n

\n Once you finish changing parameter values, press the\n Cluster\n button to re-run clustering.\n

\n
\n\n
Results export
\n
\n
\n
\n \n \"Clusters\n
\n
\n \n \"Label\n
\n
\n \n \"Label\n
\n
\n\n

\n Use the text box in the Dictionaries section to edit\n label exclusion dictionaries. Use\n the glob, exact and\n regexp tabs to choose the\n label matching\n mechanism. The\n glob syntax should\n serve most label filtering needs.\n

\n\n

\n Click syntax for a syntax overview. See\n Label matchers for the\n complete documentation.\n

\n\n

\n Click Copy JSON to copy to clipboard the JSON\n representation of the dictionaries, ready for pasting into JSON\n request and code.\n

\n
\n\n
Parameter search
\n
\n
\n
\n \n \"Lingo3G\n
\n
\n \n \"Advanced\n
\n
\n \n \"Advanced\n
\n
\n\n

\n Toggle the advanced parameters button to access all the available\n parameters, including those designed for expert users.\n

\n
\n\n
Parameters JSON export
\n
\n
\n
\n \n \"Parameters\n
\n
\n