Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/senderle/topic-modeling-tool

A point-and-click tool for creating and analyzing topic models produced by MALLET.
https://github.com/senderle/topic-modeling-tool

data-science digital-humanities mallet text-analytics topic-modeling

Last synced: about 1 month ago
JSON representation

A point-and-click tool for creating and analyzing topic models produced by MALLET.

Awesome Lists containing this project

README 

        

[![DOI](https://zenodo.org/badge/47996186.svg)](https://zenodo.org/badge/latestdoi/47996186)



# Topic Modeling Tool



## An updated GUI for MALLET's implementation of LDA.[*](#acknowledgements)



### New features:



* **Metadata integration**

* **Automatic file segmentation**

* **Custom CSV delimiters**

* **Alpha/Beta optimization**

* **Custom regex tokenization**

* **Multicore processor support**



## Getting Started:



To start using some of these new features right away, consult the 

[quickstart guide](https://senderle.github.io/topic-modeling-tool/documentation/2017/01/06/quickstart.html).

For tinkerers, there's a guide to the tool's 

[optional settings](https://senderle.github.io/topic-modeling-tool/documentation/2018/09/27/optional-settings.html).

You may also find useful information in the discussion threads under 

[documentation](https://github.com/senderle/topic-modeling-tool/labels/documentation) 

issues.



## Requirements:



The Topic Modeling Tool now has native Windows and Mac apps, and because of

unicode issues, these are currently the best options for installation. 

Just follow the instructions for your operating system. **Do not try

to install by clicking on [Clone or download] > [Download ZIP].**

It [won't work](https://github.com/senderle/topic-modeling-tool/issues/63#issuecomment-360933035).



**For Macs**: 

* Download [`TopicModelingTool.dmg`](https://github.com/senderle/topic-modeling-tool/raw/master/TopicModelingTool.dmg).

* Open it by double-clicking.

* Drag the app into your `Applications` folder -- or into any folder at all.

* Run the app by double-clicking.



**For Windows PCs**:

* Download [`TopicModelingTool.zip`](https://github.com/senderle/topic-modeling-tool/raw/master/TopicModelingTool.zip).

    * NOTE: The native PC build is out-of-date. [Help wanted](https://github.com/senderle/topic-modeling-tool/issues/70).

* Extract the files into any folder and open it.

* Double-click on the file called `TopicModelingTool.exe` to run it.



If you want to run the 

[plain `.jar` file](https://github.com/senderle/topic-modeling-tool/raw/master/TopicModelingTool.jar), 

you'll need to have a fairly recent version of Java; the version that 

came with your computer may not work, especially if your computer is 

a Mac. Whatever your operating system, you can install an updated 

version of Java by following the instructions for your operating 

system [here](https://java.com/en/download/help/download_options.xml).



## Windows Unicode Support:



Windows and Java don't play very well together when it comes to unicode 

text. If you are using the `.jar` build, and non-ascii characters are 

getting garbled on a Windows machine, there's a quick fix involving 

[environment variables](https://github.com/senderle/topic-modeling-tool/issues/48#issuecomment-274331463)

that may make things work.



Again, the best answer may just be to use the native app. It should

now work correctly at every stage with UTF-8-encoded text. (If it 

doesn't, let us know and we will moan and gnash our teeth some more.)



## Reporting and Replicating Bugs and Other Issues:



If you hadn't already guessed, most testing for this tool happens on a Mac. 

There are bound to be errors happening on other platforms that have slipped

through the cracks. We need you to report them so we can keep improving the

tool! But we cannot fix a problem that we don't fully understand, so...



**When posting a bug report, please include vast amounts of detail.**



_Copy and paste everything from the tool's console output_ if you can, _tell us

your operating system and version_, and _let us know the other tools you're

using to create and view input and output_. It also helps if you verify that the

bug still exists in the most recent build of the tool (i.e. the one contained in 

the `.jar`, `.dmg`, or `.zip` files in the root directory).



We know that there are substantial problems with Windows support for

unicode text; if you see problems, please post *detailed* information under

the [main issue](https://github.com/senderle/topic-modeling-tool/issues/48)

so that we can start isolating and fixing these bugs. 



We love getting new issues because it means the tool is improving! But

again, **when posting a bug report, please include vast amounts of detail**. 



## Building the Development Version:



If you feel adventurous, you might want to modify the code and compile your 

own version. To do so, you'll need to install [Apache Maven](https://maven.apache.org/) 

as well as the Java Development Kit. On Macs, [Homebrew](http://brew.sh/) 

is the best way to do so; simply install homebrew as described on the Homebrew 

site, and then type `brew install maven` at the command line. On Windows PCs -- 

you're on your own! But we did it and it wasn't terribly hard. You just need an

up-to-date JDK and maven package, with their `bin` folders in your `PATH`. 



With maven installed, simply use the terminal to navigate to the `TopicModelingTool` folder:



    $ cd topic-modeling-tool/TopicModelingTool

    

Then use maven's `package` command:



    $ mvn package



We now have experimental support for compiling the tool as a native app using

the [javafx plugin](https://github.com/javafx-maven-plugin/javafx-maven-plugin) 

for maven. This will build a native package able to run on your operating system.

This has been tested on both Macs and Windows PCs.



    $ mvn jfx:native

    

___



#### Acknowledgements:



This version of the tool was forked from the 

[original version](https://github.com/arunbg/Topic-Modeling-Tool) 

by [David Newman](https://scholar.google.com/citations?user=3z-mSpYAAAAJ&hl=en) and 

[Arun Balagopalan](https://github.com/arunbg).



Previous work on the GUI for MALLET has been supported by a National Leadership 

Grant (LG-06-08-0057-08) from the Institute of Museum and Library Services to 

Yale University, the University of Michigan, and the University of California, 

Irvine. The Institute of Museum and Library Services is the primary source of 

federal support for the nation's 123,000 libraries and 17,500 museums. The 

Institute's mission is to create strong libraries and museums that connect 

people to information and ideas.



Work on this version of the tool has benefited from the support of 

[Penn Libraries](http://www.library.upenn.edu/) and the the University of 

Pennsylvania's [Price Lab for Digital Humanities](https://pricelab.sas.upenn.edu/).