El proyecto consiste en la extracción de metadatos sobre un Jupyter Notebook, con el fin de extraer la información más relevante de los mismos y poder clasificarlos. Para ello se va a hacer uso de otras herramientas como pueden ser Inspect4py, que nos proporciona ayuda en la extracción de dichos metadatos.
Dado un Jupyter notebook , JuNE podrá:
- Extraer las lineas de bash que contiene.
- Obtener el autor.
- Extraer el titulo del notebook.
- Extraer los requerimientos necesarios para la ejecución del notebook.
- Extraer las llamadas a funciones que realiza el notebook.
- Extraer la descripción del notebook.
- Extraer los inputs (paths) que contiene el notebook.
JuNE es ejecutada sobre un Jupyter notebook.
JuNE almacena por defecto el resultado en el directorio donde se ha ejecutado, pero puede especificar su propio directorio usando la opcion -o.
Para una mejor comprensión, se ha añadido el comando help para explicar cada parametro:
JuNE --help
Usage: JuNE [OPTIONS]
Options:
-i, --input_path TEXT Direccion de entrada del notebook a inspeccionar
[required]
-tmp, --tmp_dir Opcion para eliminar la carpeta temporal
-o, --output_dir TEXT Direccion de salida de los metadatos extraidos
-inspect, --inspect Ejecución mediante inspect4py
--help Show this message and exit.
Es necesaria la version de python3.8
En primer lugar debe realizar la clonacion del repositorio mediante el comando: \
git clone https://github.com/SoftwareUnderstanding/JuNE
Posteriormente debera acceder al proyecto: \
cd JuNE
Por ultimo instalar el setup.py: \
pip install -e .
Finalmente antes de su ejecucion debera instalar pytorch , los métodos de instalacion se
encuentran en el siguiente enlace:
https://pytorch.org/