org.apache.mahout.clustering.lda.LDAPrintTopics Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mahout-utils Show documentation
Show all versions of mahout-utils Show documentation
Utilities for preparing content into formats for Mahout.
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.mahout.clustering.lda;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;
import java.util.PriorityQueue;
import java.util.Queue;
import org.apache.commons.cli2.CommandLine;
import org.apache.commons.cli2.Group;
import org.apache.commons.cli2.Option;
import org.apache.commons.cli2.OptionException;
import org.apache.commons.cli2.builder.ArgumentBuilder;
import org.apache.commons.cli2.builder.DefaultOptionBuilder;
import org.apache.commons.cli2.builder.GroupBuilder;
import org.apache.commons.cli2.commandline.Parser;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.fs.FileStatus;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.io.DoubleWritable;
import org.apache.hadoop.io.SequenceFile;
import org.apache.mahout.common.CommandLineUtil;
import org.apache.mahout.common.IntPairWritable;
import org.apache.mahout.utils.vectors.VectorHelper;
/**
* Class to print out the top K words for each topic.
*/
public class LDAPrintTopics {
private static class StringDoublePair implements Comparable {
private final double score;
private final String word;
StringDoublePair(double score, String word) {
this.score = score;
this.word = word;
}
@Override
public int compareTo(StringDoublePair other) {
return Double.compare(score, other.score);
}
@Override
public boolean equals(Object o) {
if (!(o instanceof StringDoublePair)) {
return false;
}
StringDoublePair other = (StringDoublePair) o;
return score == other.score && word.equals(other.word);
}
@Override
public int hashCode() {
return (int) Double.doubleToLongBits(score) ^ word.hashCode();
}
}
// Expands the queue list to have a Queue for topic K
private static void ensureQueueSize(List> queues, int k) {
for (int i = queues.size(); i <= k; ++i) {
queues.add(new PriorityQueue());
}
}
public static void main(String[] args) throws Exception {
DefaultOptionBuilder obuilder = new DefaultOptionBuilder();
ArgumentBuilder abuilder = new ArgumentBuilder();
GroupBuilder gbuilder = new GroupBuilder();
Option inputOpt = obuilder.withLongName("input").withRequired(true).withArgument(
abuilder.withName("input").withMinimum(1).withMaximum(1).create()).withDescription(
"Path to an LDA output (a state)").withShortName("i").create();
Option dictOpt = obuilder.withLongName("dict").withRequired(true).withArgument(
abuilder.withName("dict").withMinimum(1).withMaximum(1).create()).withDescription(
"Dictionary to read in, in the same format as one created by "
+ "org.apache.mahout.utils.vectors.lucene.Driver").withShortName("d").create();
Option outOpt = obuilder.withLongName("output").withRequired(false).withArgument(
abuilder.withName("output").withMinimum(1).withMaximum(1).create()).withDescription(
"Output directory to write top words").withShortName("o").create();
Option wordOpt = obuilder.withLongName("words").withRequired(false).withArgument(
abuilder.withName("words").withMinimum(0).withMaximum(1).withDefault("20").create()).withDescription(
"Number of words to print").withShortName("w").create();
Option dictTypeOpt = obuilder.withLongName("dictionaryType").withRequired(false).withArgument(
abuilder.withName("dictionaryType").withMinimum(1).withMaximum(1).create()).withDescription(
"The dictionary file type (text|sequencefile)").withShortName("dt").create();
Option helpOpt = obuilder.withLongName("help").withDescription("Print out help").withShortName("h")
.create();
Group group = gbuilder.withName("Options").withOption(dictOpt).withOption(outOpt).withOption(wordOpt)
.withOption(inputOpt).withOption(dictTypeOpt).create();
try {
Parser parser = new Parser();
parser.setGroup(group);
CommandLine cmdLine = parser.parse(args);
if (cmdLine.hasOption(helpOpt)) {
CommandLineUtil.printHelp(group);
return;
}
String input = cmdLine.getValue(inputOpt).toString();
String dictFile = cmdLine.getValue(dictOpt).toString();
int numWords = 20;
if (cmdLine.hasOption(wordOpt)) {
numWords = Integer.parseInt(cmdLine.getValue(wordOpt).toString());
}
Configuration config = new Configuration();
String dictionaryType = "text";
if (cmdLine.hasOption(dictTypeOpt)) {
dictionaryType = cmdLine.getValue(dictTypeOpt).toString();
}
List wordList;
if (dictionaryType.equals("text")) {
wordList = Arrays.asList(VectorHelper.loadTermDictionary(new File(dictFile)));
} else if (dictionaryType.equals("sequencefile")) {
FileSystem fs = FileSystem.get(new Path(dictFile).toUri(), config);
wordList = Arrays.asList(VectorHelper.loadTermDictionary(config, fs, dictFile));
} else {
throw new IllegalArgumentException("Invalid dictionary format");
}
List> topWords = topWordsForTopics(input, config, wordList, numWords);
if (cmdLine.hasOption(outOpt)) {
File output = new File(cmdLine.getValue(outOpt).toString());
if (!output.exists()) {
if (!output.mkdirs()) {
throw new IOException("Could not create directory: " + output);
}
}
writeTopWords(topWords, output);
} else {
printTopWords(topWords);
}
} catch (OptionException e) {
CommandLineUtil.printHelp(group);
throw e;
}
}
// Adds the word if the queue is below capacity, or the score is high enough
private static void maybeEnqueue(Queue q, String word, double score, int numWordsToPrint) {
if (q.size() >= numWordsToPrint && score > q.peek().score) {
q.poll();
}
if (q.size() < numWordsToPrint) {
q.add(new StringDoublePair(score, word));
}
}
private static void printTopWords(List> topWords) {
for (int i = 0; i < topWords.size(); ++i) {
List topK = topWords.get(i);
System.out.println("Topic " + i);
System.out.println("===========");
for (String word : topK) {
System.out.println(word);
}
}
}
public static List> topWordsForTopics(String dir,
Configuration job,
List wordList,
int numWordsToPrint) throws IOException {
FileSystem fs = new Path(dir).getFileSystem(job);
List> queues = new ArrayList>();
IntPairWritable key = new IntPairWritable();
DoubleWritable value = new DoubleWritable();
for (FileStatus status : fs.globStatus(new Path(dir, "*"))) {
Path path = status.getPath();
SequenceFile.Reader reader = new SequenceFile.Reader(fs, path, job);
while (reader.next(key, value)) {
int topic = key.getFirst();
int word = key.getSecond();
ensureQueueSize(queues, topic);
if (word >= 0 && topic >= 0) {
double score = value.get();
String realWord = wordList.get(word);
maybeEnqueue(queues.get(topic), realWord, score, numWordsToPrint);
}
}
reader.close();
}
List> result = new ArrayList>();
for (int i = 0; i < queues.size(); ++i) {
result.add(i, new LinkedList());
for (StringDoublePair sdp : queues.get(i)) {
result.get(i).add(0, sdp.word); // prepend
}
}
return result;
}
private static void writeTopWords(List> topWords, File output) throws IOException {
for (int i = 0; i < topWords.size(); ++i) {
List topK = topWords.get(i);
File out = new File(output, "topic-" + i);
PrintWriter writer = new PrintWriter(new FileWriter(out));
writer.println("Topic " + i);
writer.println("===========");
for (String word : topK) {
writer.println(word);
}
writer.close();
}
}
private LDAPrintTopics() { }
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy