Skip to content

Commit 977e055

Browse files
Added TPD Intro, IS-SSL repo structure and UBUMLaaS half struct #158
1 parent 28f3cdc commit 977e055

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

docs/anexos.pdf

27.6 KB
Binary file not shown.

docs/tex/D_Manual_programador.tex

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,64 @@
11
\apendice{Documentación técnica de programación}
22

33
\section{Introducción}
4+
En cada una de las secciones de este anexo se va a describir con detalle la documentación técnica de programación. Se describirá la estructura de directorios que posee, la instalación del propio entorno de desarrollo, cómo llevar a cabo su compilación, instalación y ejecución; además de las pruebas que se han realizado.
5+
6+
Debemos recordar que el proyecto posee dos repositorios diferenciados, UBUMLaaS e IS-SSL (biblioteca de algoritmos de selección de instancias y aprendizaje semi-supervisado), por lo que en cada sección se describirán cada uno de ellos de manera individual.
47

58
\section{Estructura de directorios}
9+
A continuación se comenta brevemente el árbol de directorios de cada repositorio, en orden alfabético.
10+
\subsection{UBUMLaaS}
11+
La estructura del repositorio es la siguiente:
12+
\begin{itemize}
13+
\tightlist
14+
\item \texttt{/}: raíz del proyecto, aquí se encuentra el README, la licencia, los ficheros de configuración de las pruebas de integración y despliegue continuo (CI-CD), junto con los ficheros de requisitos para \texttt{conda} y \texttt{pyenv}.
15+
\item \texttt{/lib/}: librerías utilizadas por el sistema.
16+
\item \texttt{/lib/is\_ssl}: librería propia de métodos de selección de instancias y aprendizaje semi-supervisado.
17+
\item \texttt{/lib/scikit\_ml\_learn\_data/meka/meka-release-1.9.2/}: librería \texttt{Meka} en su versión 1.9.2.
18+
\item \texttt{/lib/skmultilearn/}: librería \texttt{scikit-multilearn}.
19+
\item \texttt{/lib/unofficial\_weka\_packages/}: algoritmos de ADMIRABLE.
20+
\item \texttt{/lib/wekafiles/}: algoritmos concretos de \texttt{weka}.
21+
\item \texttt{/test/*}: ficheros de prueba CI-CD.
22+
\item \texttt{/ubumlaas/}: directorio principal de la plataforma.
23+
\item \texttt{/ubumlaas/admin/}: contiene toda la parte de \textit{backend} de administración.
24+
\item \texttt{/ubumlaas/core/}: contiene el \textit{backend} de las vistas de índice y acerca de.
25+
\item \texttt{/ubumlaas/default\_datasets/}: conjuntos de datos por defecto que se añaden a los nuevos usuarios.
26+
\item \texttt{/ubumlaas/error\_pages/}: contiene el \textit{backend} de las vistas de error.
27+
\item \texttt{/ubumlaas/experiments/}: contiene el \textit{backend} para la realización de experimentos.
28+
\end{itemize}
29+
30+
\subsection{IS-SSL}
31+
La estructura del repositorio es la siguiente:
32+
\begin{itemize}
33+
\tightlist
34+
\item \texttt{/}: raíz del proyecto, aquí se encuentra el README, la licencia, los ficheros de configuración de PIP, los ficheros de configuración de las pruebas de integración y despliegue continuo (CI-CD); y, el fichero de requisitos.
35+
\item \texttt{/datasets/*}: conjuntos de datasets en formatos \texttt{csv} y \texttt{arff}, normalizados y no normalizados.
36+
\item \texttt{/docs/}: documentación del proyecto.
37+
\item \texttt{/docs/img/}: imágenes utilizadas en la documentación.
38+
\item \texttt{/docs/img/anexos/*}: imágenes utilizadas en los anexos.
39+
\item \texttt{/docs/img/draws/}: diagramas en su formato original.
40+
\item \texttt{/docs/img/memoria/*}: imágenes utilizadas en la memoria.
41+
\item \texttt{/hypothesis/*}: primera aproximación a la investigación realizada.
42+
\item \texttt{/implementation\_tests/}: conjunto de pruebas de validación sobre los algoritmos implementados.
43+
\item \texttt{/instance\_selection/}: algoritmos implementados de selección de instancias.
44+
\item \texttt{/instance\_selection/utils/}: métodos de apoyo comunes a los algoritmos de selección de instancias.
45+
\item \texttt{/misc/}: contiene archivos varios de formato para el repositorio (cabeceras, logos, etc.).
46+
\item \texttt{/semisupervised/}: algoritmos implementados de aprendizaje semi-supervisado.
47+
\item \texttt{/semisupervised/utils/}: métodos de apoyo comunes a los algoritmos de aprendizaje semi-supervisado.
48+
\item \texttt{/utils/}: diferentes clases y métodos de apoyo comunes tanto a selección de instancias como a semi-supervisado.
49+
\end{itemize}
650

751
\section{Manual del programador}
52+
\subsection{UBUMLaaS}
53+
54+
\subsection{IS-SSL}
855

956
\section{Compilación, instalación y ejecución del proyecto}
57+
\subsection{UBUMLaaS}
58+
59+
\subsection{IS-SSL}
1060

1161
\section{Pruebas del sistema}
62+
\subsection{UBUMLaaS}
63+
64+
\subsection{IS-SSL}

0 commit comments

Comments
 (0)