Written user's manual for IS-SSL #184

Author: dpuenteramirez

docs/anexos.pdf

@@ -452,8 +452,8 @@ \subsubsection{Uso del proyecto}
 Según la codificación realizada, todos los métodos accesibles de las clases esperan la entrada de objetos de tipo \texttt{DataFrame} de la librería de \texttt{Pandas}. Internamente en función de las operaciones que tenga que realizar, serán convertidos estos objetos a listas de Python o arreglos de \texttt{NumPy}. Independientemente de las operaciones internas, siempre la salida producida (en caso de tenerla) serán objetos de \texttt{Pandas}, no teniendo que ser necesariamente el mismo objeto de entrada modificado, en la mayor parte de las ocasiones serán objetos nuevos.
 
 \begin{lstlisting}[language=Python, caption={Ejemplo de uso de IS-SSL}, label={lst:ejemplo}]
-from ssl_dnx import TriTraining
-from is_dnx import ENN
+from SemiSupervisedLearningDNX import TriTraining
+from InstanceSelectionDNX import ENN
 from sklearn.naive_bayes import GaussianNB
 from sklearn.neighbors import KNeighborsClassifier
 from sklearn.tree import DecisionTreeClassifier

docs/tex/D_Manual_programador.tex

@@ -67,4 +67,90 @@ \subsection{Instalación}
 
 \subsection{Manual del usuario}
 
+A continuación se documentan las funcionalidades de las bibliotecas, desde su importación, a uso y especificación de los diferentes parámetros de entrada y salida esperados. A modo de resumen se puede destacar que todos los algoritmos siguen la misma estructura interna luego el aprendizaje y familizarización es relativamente rápido.
 
+\subsubsection{Biblioteca de algoritmos de selección de instancias}
+\textbf{Importar}
+
+Para poder trabajar con los algoritmos de selección de instancias se deben de importar en el fichero en el que se quieran utilizar. Para ello se importan como cualquier otro paquete de Python, supongamos que queremos utilizar el algoritmo ENN, lo importaremos de la siguiente manera:
+
+\texttt{from InstanceSelectionDNX import ENN} 
+
+De esta forma podemos sustituir ENN por el algoritmo que deseemos de entre los disponibles y tenerlo a nuestra disposición para su uso.
+
+Todos los algoritmos están codificados como \texttt{class} por lo tanto se debe de instanciar antes de poder hacer uso del mismo. 
+
+\textbf{Uso}
+
+Como se ha comentado al comienzo, todos los algoritmos poseen la misma estructura. Todos ellos poseen el método \texttt{filter} de tal manera que una vez se haya instanciado se podrá llamar al método y se obtendrá como resultado el conjunto de datos reducido.
+
+Todos los algoritmos en su instanciación reciben aquellos parámetros que son necesarios para la configuración y su uso posterior, mientras que cuando se realiza el filtrado únicamente reciben el conjunto de datos dividido, por un lado los atributos y por otro lado la clase.
+
+Tanto las entradas como las salidas deben ser objetos de tipo \texttt{DataFrame} de \texttt{Pandas}.
+
+\begin{lstlisting}[language=python, caption={Ejemplo de uso de ENN}]]
+from InstanceSelectionDNX import ENN
+import pandas as pd
+
+data = pd.DataFrame([[1, 2, 3, 4],
+        [4, 3, 2, 1],
+        [1, 2, 4, 3],
+        [2, 1, 3, 4]])
+target = pd.DataFrame([0, 0, 1, 1])
+
+model = ENN(nearest_neighbors=3, power_parameter=2)
+
+data_red, label_red = model.filter(data, target)
+\end{lstlisting}
+
+\subsubsection{Biblioteca de algoritmos de aprendizaje semi-supervisado}
+\textbf{Importar}
+
+De manera análoga a la otra biblioteca, importaremos el paquete y seleccionaremos cuál es el algoritmo que se desea utilizar, por ejemplo:
+
+\texttt{from SemiSupervisedLearningDNX import TriTraining}
+
+Pudiendo sustituir TriTraining por el algoritmo deseado.
+
+Todos los algoritmos están codificados como \texttt{class} por lo tanto se debe de instanciar antes de poder hacer uso del mismo. 
+
+\textbf{Uso}
+
+Los algoritmos siguen la misma estructura interna que los propios de \texttt{Scikit-Learn}, por lo que una vez instanciados (con sus respectivos parámetros de configuración) bastará con llamar al método \texttt{fit} de cada uno de ellos, así como para predecir al método correspondiente, denominado \texttt{predict}.
+
+\begin{itemize}
+\item \textbf{\texttt{Fit}:} recibe como argumentos dos parámetros, las instancias y las etiquetas o clases, siendo -1 aquellas que se desconozcan y se quieran utilizar para entrenar el algoritmo.
+\item \textbf{\texttt{Predict}:} recibe únicamente las instancias que se quieren etiquetar. Devuelve estas instancias etiquetadas.
+\end{itemize}
+
+Todas las entradas como las salidas deben ser objetos de tipo \texttt{DataFrame} de \texttt{Pandas}.
+
+\begin{lstlisting}[language=Python, caption={Ejemplo de uso de IS-SSL}, label={lst:ejemplo}]
+from SemiSupervisedLearningDNX import TriTraining
+from sklearn.naive_bayes import GaussianNB
+from sklearn.neighbors import KNeighborsClassifier
+from sklearn.datasets import load_iris
+	
+model = TriTraining(
+	random_state = 42,
+	c1 = GaussianNB, c1_params = None,
+	c2 = KNeighborsClassifier, c2_params = {n_neighbors: 2}
+)
+	
+iris = load_iris()
+X = iris['data']
+y = iris['target']
+
+X = pd.DataFrame(X), y = pd.DataFrame(y)
+	
+val = [True if i % 2 == 0 else False for i in range(len(y))]
+y.loc[val] = -1
+
+X, X_test, y, y_test = train_test_split(X.to_numpy(), y.to_numpy())
+
+X = pd.DataFrame(X), y = pd.DataFrame(y)
+
+model.fit(X, y)
+y_pred = model.predict(X_test)
+	
+\end{lstlisting}