dataClassifier.py

# dataClassifier.py
# -----------------
# Licensing Information:  You are free to use or extend these projects for
# educational purposes provided that (1) you do not distribute or publish
# solutions, (2) you retain this notice, and (3) you provide clear
# attribution to UC Berkeley, including a link to http://ai.berkeley.edu.
#
# Attribution Information: The Pacman AI projects were developed at UC Berkeley.
# The core projects and autograders were primarily created by John DeNero
# (denero@cs.berkeley.edu) and Dan Klein (klein@cs.berkeley.edu).
# Student side autograding was added by Brad Miller, Nick Hay, and
# Pieter Abbeel (pabbeel@cs.berkeley.edu).


# This file contains feature extraction methods and harness
# code for data classification

import sys

import mostFrequent
import perceptron
import perceptron_pacman
import samples
import util
from pacman import GameState, Directions

TEST_SET_SIZE = 100
DIGIT_DATUM_WIDTH = 28
DIGIT_DATUM_HEIGHT = 28
FACE_DATUM_WIDTH = 60
FACE_DATUM_HEIGHT = 70


def basicFeatureExtractorDigit(datum):
    """
    Returns a set of pixel features indicating whether
    each pixel in the provided datum is white (0) or gray/black (1)
    """
    a = datum.getPixels()

    features = util.Counter()
    for x in range(DIGIT_DATUM_WIDTH):
        for y in range(DIGIT_DATUM_HEIGHT):
            if datum.getPixel(x, y) > 0:
                features[(x, y)] = 1
            else:
                features[(x, y)] = 0
    return features


def basicFeatureExtractorFace(datum):
    """
    Returns a set of pixel features indicating whether
    each pixel in the provided datum is an edge (1) or no edge (0)
    """
    a = datum.getPixels()

    features = util.Counter()
    for x in range(FACE_DATUM_WIDTH):
        for y in range(FACE_DATUM_HEIGHT):
            if datum.getPixel(x, y) > 0:
                features[(x, y)] = 1
            else:
                features[(x, y)] = 0
    return features


def basicFeatureExtractorPacman(state):
    """
    A basic feature extraction function.

    You should return a util.Counter() of features
    for each (state, action) pair along with a list of the legal actions

    ##
    """
    features = util.Counter()
    for action in state.getLegalActions():
        successor = state.generateSuccessor(0, action)
        foodCount = successor.getFood().count()
        featureCounter = util.Counter()
        featureCounter["foodCount"] = foodCount
        features[action] = featureCounter
    return features, state.getLegalActions()


def enhancedFeatureExtractorPacman(state):
    """
    Your feature extraction playground.

    You should return a util.Counter() of features
    for each (state, action) pair along with a list of the legal actions

    ##
    """

    features = basicFeatureExtractorPacman(state)[0]
    for action in state.getLegalActions():
        features[action] = util.Counter(
            features[action], **enhancedPacmanFeatures(state, action)
        )
    return features, state.getLegalActions()


def enhancedPacmanFeatures(state, action):
    """
    For each state, this function is called with each legal action.
    It should return a counter with { <feature name> : <feature value>, ... }
    """
    features = util.Counter()
    # *** YOUR CODE HERE ***
    succGameState = state.generateSuccessor(0, action)

    dist = 0

    for n in range(len(GameState.getGhostPositions(succGameState))):

        pac_location = GameState.getPacmanPosition(succGameState)
        ghost_loc = GameState.getGhostPositions(succGameState)
        dist += util.manhattanDistance(pac_location, ghost_loc[n])
        feat = 'dist'+str(n)
        features[feat] = util.manhattanDistance(pac_location, ghost_loc[n])


    if action == 'Stop':
        features['stopped'] += 1

    features['dist'] = dist
    features['foodCount'] = GameState.getNumFood(succGameState)
    features['power_pellet'] = len(GameState.getCapsules(succGameState))

    return features


def analysis(
    classifier, guesses, testLabels, testData, rawTestData, printImage
):
    """
    This function is called after learning.
    Include any code that you want here to help you analyze your results.

    Use the printImage(<list of pixels>) function to visualize features.

    An example of use has been given to you.

    - classifier is the trained classifier
    - guesses is the list of labels predicted by your classifier on the test set
    - testLabels is the list of true labels
    - testData is the list of training datapoints (as util.Counter of features)
    - rawTestData is the list of training datapoints (as samples.Datum)
    - printImage is a method to visualize the features
    (see its use in the odds ratio part in runClassifier method)

    This code won't be evaluated. It is for your own optional use
    (and you can modify the signature if you want).
    """

    # Put any code here...
    # Example of use:
    # for i in range(len(guesses)):
    #     prediction = guesses[i]
    #     truth = testLabels[i]
    #     if (prediction != truth):
    #         print "==================================="
    #         print "Mistake on example %d" % i
    #         print "Predicted %d; truth is %d" % (prediction, truth)
    #         print "Image: "
    #         print rawTestData[i]
    #         break


## =====================
## You don't have to modify any code below.
## =====================


class ImagePrinter:
    def __init__(self, width, height):
        self.width = width
        self.height = height

    def printImage(self, pixels):
        """
        Prints a Datum object that contains all pixels in the
        provided list of pixels.  This will serve as a helper function
        to the analysis function you write.

        Pixels should take the form
        [(2,2), (2, 3), ...]
        where each tuple represents a pixel.
        """
        image = samples.Datum(None, self.width, self.height)
        for pix in pixels:
            try:
                # This is so that new features that you could define which
                # which are not of the form of (x,y) will not break
                # this image printer...
                x, y = pix
                image.pixels[x][y] = 2
            except:
                print("new features:", pix)
                continue
        print(image)


def default(str):
    return str + " [Default: %default]"


USAGE_STRING = """
  USAGE:      python dataClassifier.py <options>
  EXAMPLES:   (1) python3 dataClassifier.py
                  - trains the default mostFrequent classifier on the digit dataset
                  using the default 100 training examples and
                  then test the classifier on test data
                 """


def readCommand(argv):
    "Processes the command used to run from the command line."
    from optparse import OptionParser

    parser = OptionParser(USAGE_STRING)

    parser.add_option(
        "-c",
        "--classifier",
        help=default("The type of classifier"),
        choices=[
            "mostFrequent",
            "perceptron",
        ],
        default="mostFrequent",
    )
    parser.add_option(
        "-d",
        "--data",
        help=default("Dataset to use"),
        choices=["digits", "faces", "pacman"],
        default="digits",
    )
    parser.add_option(
        "-t",
        "--training",
        help=default("The size of the training set"),
        default=100,
        type="int",
    )
    parser.add_option(
        "-f",
        "--features",
        help=default("Whether to use enhanced features"),
        default=False,
        action="store_true",
    )
    parser.add_option(
        "-o",
        "--odds",
        help=default("Whether to compute odds ratios"),
        default=False,
        action="store_true",
    )
    parser.add_option(
        "-1",
        "--label1",
        help=default("First label in an odds ratio comparison"),
        default=0,
        type="int",
    )
    parser.add_option(
        "-2",
        "--label2",
        help=default("Second label in an odds ratio comparison"),
        default=1,
        type="int",
    )
    parser.add_option(
        "-w",
        "--weights",
        help=default("Whether to print weights"),
        default=False,
        action="store_true",
    )
    parser.add_option(
        "-k",
        "--smoothing",
        help=default("Smoothing parameter (ignored when using --autotune)"),
        type="float",
        default=2.0,
    )
    parser.add_option(
        "-a",
        "--autotune",
        help=default("Whether to automatically tune hyperparameters"),
        default=False,
        action="store_true",
    )
    parser.add_option(
        "-i",
        "--iterations",
        help=default("Maximum iterations to run training"),
        default=3,
        type="int",
    )
    parser.add_option(
        "-s",
        "--test",
        help=default("Amount of test data to use"),
        default=TEST_SET_SIZE,
        type="int",
    )
    parser.add_option(
        "-g",
        "--agentToClone",
        help=default("Pacman agent to copy"),
        default=None,
        type="str",
    )

    options, otherjunk = parser.parse_args(argv)
    if len(otherjunk) != 0:
        raise Exception(
            "Command line input not understood: " + str(otherjunk)
        )
    args = {}

    # Set up variables according to the command line input.
    print("Doing classification")
    print("--------------------")
    print("data:\t\t" + options.data)
    print("classifier:\t\t" + options.classifier)
    print("using enhanced features?:\t" + str(options.features))
    print("training set size:\t" + str(options.training))
    if options.data == "digits":
        printImage = ImagePrinter(
            DIGIT_DATUM_WIDTH, DIGIT_DATUM_HEIGHT
        ).printImage
        featureFunction = basicFeatureExtractorDigit
    elif options.data == "faces":
        printImage = ImagePrinter(
            FACE_DATUM_WIDTH, FACE_DATUM_HEIGHT
        ).printImage
        if options.features:
            featureFunction = enhancedFeatureExtractorFace
        else:
            featureFunction = basicFeatureExtractorFace
    elif options.data == "pacman":
        printImage = None
        if options.features:
            featureFunction = enhancedFeatureExtractorPacman
        else:
            featureFunction = basicFeatureExtractorPacman
    else:
        print("Unknown dataset", options.data)
        print(USAGE_STRING)
        sys.exit(2)

    if options.data == "digits":
        legalLabels = list(range(10))
    else:
        legalLabels = ["Stop", "West", "East", "North", "South"]

    if options.training <= 0:
        print(
            "Training set size should be a positive integer (you provided: %d)"
            % options.training
        )
        print(USAGE_STRING)
        sys.exit(2)

    if options.smoothing <= 0:
        print(
            "Please provide a positive number for smoothing (you provided: %f)"
            % options.smoothing
        )
        print(USAGE_STRING)
        sys.exit(2)

    if options.odds:
        if (
            options.label1 not in legalLabels
            or options.label2 not in legalLabels
        ):
            print(
                "Didn't provide a legal labels for the odds ratio: (%d,%d)"
                % (options.label1, options.label2)
            )
            print(USAGE_STRING)
            sys.exit(2)

    if options.classifier == "mostFrequent":
        classifier = mostFrequent.MostFrequentClassifier(legalLabels)
    elif options.classifier == "perceptron":
        if options.data != "pacman":
            classifier = perceptron.PerceptronClassifier(
                legalLabels, options.iterations
            )
        else:
            classifier = perceptron_pacman.PerceptronClassifierPacman(
                legalLabels, options.iterations
            )
    else:
        print("Unknown classifier:", options.classifier)
        print(USAGE_STRING)

        sys.exit(2)

    args["agentToClone"] = options.agentToClone

    args["classifier"] = classifier
    args["featureFunction"] = featureFunction
    args["printImage"] = printImage

    return args, options


# Dictionary containing full path to .pkl file that contains the agent's training, validation, and testing data.
MAP_AGENT_TO_PATH_OF_SAVED_GAMES = {
    "FoodAgent": (
        "pacmandata/food_training.pkl",
        "pacmandata/food_validation.pkl",
        "pacmandata/food_test.pkl",
    ),
    "StopAgent": (
        "pacmandata/stop_training.pkl",
        "pacmandata/stop_validation.pkl",
        "pacmandata/stop_test.pkl",
    ),
    "GiveUpAgent": (
        "pacmandata/give_up_training.pkl",
        "pacmandata/give_up_validation.pkl",
        "pacmandata/give_up_test.pkl",
    ),
    "CleverAgent": (
        "pacmandata/clever_training.pkl",
        "pacmandata/clever_validation.pkl",
        "pacmandata/clever_test.pkl",
    ),
}
# Main harness code


def runClassifier(args, options):
    featureFunction = args["featureFunction"]
    classifier = args["classifier"]
    printImage = args["printImage"]

    # Load data
    numTraining = options.training
    numTest = options.test

    if options.data == "pacman":
        agentToClone = args.get("agentToClone", None)
        trainingData, validationData, testData = MAP_AGENT_TO_PATH_OF_SAVED_GAMES.get(
            agentToClone, (None, None, None)
        )
        trainingData = (
            trainingData
            or args.get("trainingData", False)
            or MAP_AGENT_TO_PATH_OF_SAVED_GAMES["CleverAgent"][0]
        )
        validationData = (
            validationData
            or args.get("validationData", False)
            or MAP_AGENT_TO_PATH_OF_SAVED_GAMES["CleverAgent"][1]
        )
        testData = (
            testData or MAP_AGENT_TO_PATH_OF_SAVED_GAMES["CleverAgent"][2]
        )
        rawTrainingData, trainingLabels = samples.loadPacmanData(
            trainingData, numTraining
        )
        rawValidationData, validationLabels = samples.loadPacmanData(
            validationData, numTest
        )
        rawTestData, testLabels = samples.loadPacmanData(testData, numTest)
    else:
        rawTrainingData = samples.loadDataFile(
            "digitdata/trainingimages",
            numTraining,
            DIGIT_DATUM_WIDTH,
            DIGIT_DATUM_HEIGHT,
        )
        trainingLabels = samples.loadLabelsFile(
            "digitdata/traininglabels", numTraining
        )
        rawValidationData = samples.loadDataFile(
            "digitdata/validationimages",
            numTest,
            DIGIT_DATUM_WIDTH,
            DIGIT_DATUM_HEIGHT,
        )
        validationLabels = samples.loadLabelsFile(
            "digitdata/validationlabels", numTest
        )
        rawTestData = samples.loadDataFile(
            "digitdata/testimages",
            numTest,
            DIGIT_DATUM_WIDTH,
            DIGIT_DATUM_HEIGHT,
        )
        testLabels = samples.loadLabelsFile("digitdata/testlabels", numTest)

    # Extract features
    print("Extracting features...")
    trainingData = list(map(featureFunction, rawTrainingData))
    validationData = list(map(featureFunction, rawValidationData))
    testData = list(map(featureFunction, rawTestData))

    # Conduct training and testing
    print("Training...")
    classifier.train(
        trainingData, trainingLabels, validationData, validationLabels
    )
    print("Validating...")
    guesses = classifier.classify(validationData)
    correct = [
        guesses[i] == validationLabels[i]
        for i in range(len(validationLabels))
    ].count(True)
    print(
        str(correct),
        ("correct out of " + str(len(validationLabels)) + " (%.1f%%).")
        % (100.0 * correct / len(validationLabels)),
    )
    print("Testing...")
    guesses = classifier.classify(testData)
    correct = [
        guesses[i] == testLabels[i] for i in range(len(testLabels))
    ].count(True)
    print(
        str(correct),
        ("correct out of " + str(len(testLabels)) + " (%.1f%%).")
        % (100.0 * correct / len(testLabels)),
    )
    analysis(
        classifier, guesses, testLabels, testData, rawTestData, printImage
    )

    # do odds ratio computation if specified at command line
    if (options.odds) & (
        options.classifier == "naiveBayes" or (options.classifier == "nb")
    ):
        label1, label2 = options.label1, options.label2
        features_odds = classifier.findHighOddsFeatures(label1, label2)
        if options.classifier == "naiveBayes" or options.classifier == "nb":
            string3 = (
                "=== Features with highest odd ratio of label %d over label %d ==="
                % (label1, label2)
            )
        else:
            string3 = (
                "=== Features for which weight(label %d)-weight(label %d) is biggest ==="
                % (label1, label2)
            )

        print(string3)
        printImage(features_odds)

    if (options.weights) & (options.classifier == "perceptron"):
        for l in classifier.legalLabels:
            features_weights = classifier.findHighWeightFeatures(l)
            print(("=== Features with high weight for label %d ===" % l))
            printImage(features_weights)


if __name__ == "__main__":
    # Read input
    args, options = readCommand(sys.argv[1:])
    # Run classifier
    runClassifier(args, options)