associationrulesbuild.java

一个数据挖掘软件ALPHAMINERR的整个过程的JAVA版源代码

/*
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

 /**
  * Title: XELOPES Data Mining Library
  * Description: The XELOPES library is an open platform-independent and data-source-independent library for Embedded Data Mining.
  * Copyright: Copyright (c) 2002 Prudential Systems Software GmbH
  * Company: ZSoft (www.zsoft.ru), Prudsys (www.prudsys.com)
  * @author Carsten Weisse
  * @author Michael Thess
  * @version 1.0
  */
package com.prudsys.pdm.Examples;

import java.io.FileWriter;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Vector;

import com.prudsys.pdm.Core.CategoricalAttribute;
import com.prudsys.pdm.Core.Category;
import com.prudsys.pdm.Core.CategoryHierarchy;
import com.prudsys.pdm.Core.MiningAlgorithm;
import com.prudsys.pdm.Core.MiningAlgorithmParameter;
import com.prudsys.pdm.Core.MiningAlgorithmSpecification;
import com.prudsys.pdm.Core.MiningDataSpecification;
import com.prudsys.pdm.Core.MiningException;
import com.prudsys.pdm.Core.MiningModel;
import com.prudsys.pdm.Input.MiningInputStream;
import com.prudsys.pdm.Input.MiningVector;
import com.prudsys.pdm.Input.Multidimensional.MultidimensionalStream;
import com.prudsys.pdm.Input.Multidimensional.SelectAttribute;
import com.prudsys.pdm.Input.Records.Arff.MiningArffStream;
import com.prudsys.pdm.Models.AssociationRules.AssociationRulesAlgorithm;
import com.prudsys.pdm.Models.AssociationRules.AssociationRulesMiningModel;
import com.prudsys.pdm.Models.AssociationRules.AssociationRulesSettings;
import com.prudsys.pdm.Models.AssociationRules.ItemSet;
import com.prudsys.pdm.Models.AssociationRules.RuleSet;
import com.prudsys.pdm.Utils.PmmlUtils;

/**
 * Builds an association rule model and writes it to
 * PMML file 'AssociationRulesModel.xml'. Shows how to apply selections
 * to rules.
 */
public class AssociationRulesBuild extends BasisExample {

  /**
   * Empty constructor.
   */
  public AssociationRulesBuild() {
  }

  /**
   * Run the example of this class.
   *
   * @throws Exception error while example is running
   */
  public void runExample() throws Exception {

    // Open data source and get metadata:
    MiningInputStream inputData = new MiningArffStream( "data/arff/transact.arff" );
    MiningDataSpecification metaData = inputData.getMetaData();

    // Get transactional attributes:
    CategoricalAttribute categoryItemId = (CategoricalAttribute)metaData.getMiningAttribute( "itemId" );
    CategoricalAttribute categoryTransactId = (CategoricalAttribute)metaData.getMiningAttribute( "transactId" );

    // Create MiningSettings object and assign metadata:
    AssociationRulesSettings miningSettings = new AssociationRulesSettings();
    miningSettings.setDataSpecification( metaData );

    // Assign settings:
    miningSettings.setItemId( categoryItemId );
    miningSettings.setTransactionId( categoryTransactId );
    miningSettings.setMinimumSupport( 0.5 );
    miningSettings.setMinimumConfidence( 0.3 );
    miningSettings.verifySettings();

    // Generate mining algorithm specification directly:
    MiningAlgorithmSpecification miningAlgorithmSpecification =
      createMiningAlgorithmSpecification();

    // Get class name from algorithms specification:
    String className = miningAlgorithmSpecification.getClassname();
    if( className == null )
      throw new MiningException( "classname attribute expected." );

    // Set and display mining algorithm specifivation parameters:
    setMinimumItemSize(miningAlgorithmSpecification, 1);
    setMaximumItemSize(miningAlgorithmSpecification, -1);
    displayParameters( miningAlgorithmSpecification );

    // Create algorithm object with default values:
    AssociationRulesAlgorithm algorithm = (AssociationRulesAlgorithm) initAlgorithm(className);

    // Put it all together:
    algorithm.setMiningInputStream( inputData );
    algorithm.setMiningSettings( miningSettings );
    algorithm.setMiningAlgorithmSpecification( miningAlgorithmSpecification );
    // Parameter specific for AssociationRulesAlgorithm but not in MAS:
    algorithm.setExportTransactIds(true);
    algorithm.setExportTransactItemNames( AssociationRulesMiningModel.EXPORT_PMML_NAME_TYPE_XELOPES );
    algorithm.verify();

    // Build the mining model:
    MiningModel model = algorithm.buildModel();
    System.out.println("calculation time [s]: " + algorithm.getTimeSpentToBuildModel());

    // Show results:
    showRules( (AssociationRulesMiningModel) model );

    // Demonstrates selection:
    showSelection( (AssociationRulesMiningModel) model );

    // Write to PMML:
    FileWriter writer = new FileWriter("data/pmml/AssociationRulesModel.xml");
    model.writePmml(writer);

    // Show in browser:
    if (debug == 2) PmmlUtils.openPmmlBrowser("AssociationRulesModel.xml");
  }

  /**
   * Simple example of building an association rules model.
   *
   * @param args arguments (ignored)
   */
  public static void main(String[] args) {

    try {
      new AssociationRulesBuild().runExample();
    }
    catch (Exception ex) {
      ex.printStackTrace();
    }
  }

  /**
   * Create MiningAlgorithmSpecification directly instead
   * of reading from algorithms.xml file.
   *
   * @return new object of MiningAlgorithmSpecification
   */
  private static MiningAlgorithmSpecification createMiningAlgorithmSpecification() {

      MiningAlgorithmSpecification miningAlgorithmSpecification =
        new MiningAlgorithmSpecification();
      miningAlgorithmSpecification.setName("AprioriSimple");
      miningAlgorithmSpecification.setFunction("AssociationRules");
      miningAlgorithmSpecification.setAlgorithm("associationRules");
      miningAlgorithmSpecification.setClassname(
        "com.prudsys.pdm.Models.AssociationRules.Algorithms.AprioriSimple.Apriori");
      miningAlgorithmSpecification.setVersion("1.0");

      MiningAlgorithmParameter[] miningAlgorithmParameter =
        new MiningAlgorithmParameter[3];
      miningAlgorithmParameter[0] = new MiningAlgorithmParameter();
      miningAlgorithmParameter[0].setName("minimumItemSize");
      miningAlgorithmParameter[0].setType("int");
      miningAlgorithmParameter[0].setValue("1");
      miningAlgorithmParameter[0].setMethod("setMinimumItemSize");
      miningAlgorithmParameter[0].setDescr("Minimum size for large items");
      miningAlgorithmParameter[1] = new MiningAlgorithmParameter();
      miningAlgorithmParameter[1].setName("maximumItemSize");
      miningAlgorithmParameter[1].setType("int");
      miningAlgorithmParameter[1].setValue("-1");
      miningAlgorithmParameter[1].setMethod("setMaximumItemSize");
      miningAlgorithmParameter[1].setDescr("Maximum size for large items");
      miningAlgorithmParameter[2] = new MiningAlgorithmParameter();
      miningAlgorithmParameter[2].setName("generateRules");
      miningAlgorithmParameter[2].setType("boolean");
      miningAlgorithmParameter[2].setValue("true");
      miningAlgorithmParameter[2].setMethod("setGenerateRules");
      miningAlgorithmParameter[2].setDescr("Allow to generate association rules");

      miningAlgorithmSpecification.setInputAttribute(miningAlgorithmParameter);

      return miningAlgorithmSpecification;
  }

  /**
   * Sets minimum item size.
   *
   * @param miningAlgorithmSpecification mining algorithm specification
   * @param minItemSize minimum item size
   */
  private static void setMinimumItemSize(MiningAlgorithmSpecification miningAlgorithmSpecification, int minItemSize) {

    MiningAlgorithmParameter[] attribute = miningAlgorithmSpecification.getInputAttribute();
    for (int i = 0; i < attribute.length; i++) {
      if (attribute[i].getName().equals("minimumItemSize"))
        attribute[i].setValue(String.valueOf(minItemSize));
    };
  }

  /**
   * Sets maximum item size.
   *
   * @param miningAlgorithmSpecification mining algorithm specification
   * @param maxItemSize maximum item size
   */
  private static void setMaximumItemSize(MiningAlgorithmSpecification miningAlgorithmSpecification,int maxItemSize) {

    MiningAlgorithmParameter[] attribute = miningAlgorithmSpecification.getInputAttribute();
    for (int i = 0; i < attribute.length; i++) {
      if (attribute[i].getName().equals("maximumItemSize"))
        attribute[i].setValue(String.valueOf(maxItemSize));
    };
  }

  /**
   * Display parameters of MiningAlgorithmSpecification.
   *
   * @param miningAlgorithmSpecification MiningAlgorithmSpefification whose parameters are displayed
   * @throws MiningException could not display parameters
   */
  private static void displayParameters(MiningAlgorithmSpecification miningAlgorithmSpecification ) throws MiningException