From eb4c8196ca152fea9fe91d3dbf679d2034420685 Mon Sep 17 00:00:00 2001
From: bhmeyer <bhmeyer@inf.ufpr.br>
Date: Mon, 11 Nov 2019 20:25:28 -0300
Subject: [PATCH] Update README.md

---
 README.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e0f96a5..4baa897 100644
--- a/README.md
+++ b/README.md
@@ -31,9 +31,12 @@ neigh = KNeighborsClassifier(n_neighbors=3)
 neigh.fit(dataX, dataY) 
 ```
 
+Where path represents a path to a directory that contains two files:
+- `historico.xls`: A spreadsheet that contains data of courses and grade for each student (SIE-UFPR system report 11.02.05.99.18). This file must have the follow columns: ID_PESSOA; NOME_PESSOA; ID_ALUNO; MATR_ALUNO; NUM_VERSAO; NOME_CURSO;COD_CURSO; ID_VERSAO_CURSO; ANO; COD_ATIV_CURRIC; NOME_ATIV_CURRIC; CREDITOS; MEDIA_FINAL; DESCR_SITUACAO; PERIODO; ID_CURSO_ALUNO; SITUACAO_ITEM; CH_TEORICA; CH_PRATICA; TOTAL_CARGA_HORA; FORMA_INGRESSO; ANO_INGRESSO; FORMA_EVASÃO; ANO_EVASÃO; SEXO
+- `matricula.xls`: A spreadsheet that contains data of registers for each student (SIE-UFPR system report 11.02.04.99.43). This file must have the follow columns: ID_PESSOA; NOME_PESSOA; SEXO; DT_NASCIMENTO; FORMA_INGRESSO; FORMA_EVASAO; COD_CURSO; NOME_UNIDADE; MATR_ALUNO; NUM_VERSAO; PERIODO_INGRESSO; DT_EVASAO; PERIODO_EVASAO
 ## Embedding Information
 
-The embedding provided by `get_student_sie_embedding` is a numpy array with shape (total_students, 2*semesters_considered*total_courses).
+The embedding provided by `get_student_sie_embedding` is a numpy array with shape (total_students, 2\*semesters_considered\*total_courses).
 
 
 Where:
-- 
GitLab