# ##################################### #
# ITESM Campus Monterrey / SBC          #
# Edgar Hernan Rodriguez Diaz  790543   #
# Ivan Gonzalez  791688                 #
# ##################################### #

README FILE

This directory contains the project files that implement some clustering algorithms 
written in python.

The following information describes each one of the files contained.

- algorithms (paquete)
  Contains the python code for the implementation of the algorithms.
  - a1R.py <- Implementation of the 1R algorithm.
  - StatisticalModeling.py <- Implementation of the Statistical Modeling algorithm.
  - Rules.py <- Implementation of the Rule Clustering Algorithm
  - DecisionTree.py <- Implementation of the Decision Tree algorithm.
  
- read_arff.py
  This file is an ARFF file reader, downloaded from: 
  http://salieri.mty.itesm.mx/sbc/python/
  
- sbc-suite.py
  Python program that uses the implemented algorithms and applies them to the data files
  received as parameters. It receives the *.arff file path as a parameter.
  Programa en python que hace uso de los algoritmos y lo aplica a los archivo de datos 
  
  How to Execute!!! -----------------------------------------------------------------
  
  You need to specify the path of the file as: python sbc-suite.py <option> <filename>
      where <option>:
      -1R runs 1R algorithm
      -SM runs Statistical modeling algorithm
      -rules1 runs Rule classification with P/t
      -rules2 runs Rule classification with p(log P/t - log P/T)
      -DT creates the corresponding decision tree (only for nominal values and no missing values)

  E.g.:
      python sbc-suite.py -DT test_files/weather.nominal.arff
  ----------------------------------------------------------------------------------------

- test_files/
  This directory contains the ARFF data files for testing.
  
- README
  This file