Update README.md

README.md

@@ -3,197 +3,83 @@ library_name: transformers
 tags: []
 ---
 
-# Model Card for Model ID
+# Legislação UFAM
 
-<!-- Provide a quick summary of what the model is/does. -->
+Este é um modelo baseado no [Llama-2-7b-chat-hf](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf). Este modelo teve fine tuning a partir de um
+dataset de triplas (perguntas, contexto, resposta) relacionadas à [legislação acadêmica da Universidade Federal do Amazonas](
+https://proeg.ufam.edu.br/normas-academicas/57-proeg/146-legislacao-e-normas.html) com o intuito de torná-lo capaz de responder perguntas relacionadas
+à legislação da UFAM em um sistema de RAG.
 
+O modelo teve fine tuning realizado a partir [deste dataset](https://huggingface.co/datasets/felipovysk/ufam-legis).
 
+O código usado para a geração do dataset, treino e teste do modelo encontra-se [neste Notebook](https://colab.research.google.com/drive/1x02d9vSqsorZUQ0KnSe6FatCEHAFWO3G?usp=sharing).
 
-## Model Details
+## Exemplos de Resultados:
 
-### Model Description
+**Pergunta:** Quais são os documentos necessários para um aluno visitante interinstitucional solicitar ingresso em um programa de mobilidade?
 
-<!-- Provide a longer summary of what this model is. -->
+```
+O aluno visitante interinstitucional solicitando ingresso em um programa de mobilidade deverá apresentar os seguintes documentos:
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+1. Cópia do diploma de graduação, com validade constatada pelo respectivo registro civil;
+2. cópia do certificado de profissão, se pertence ao mesmo curso ou área de estudos que o aluno vem a realizar;
+3. cópia do documento que compro o status do aluno como interinstitucional, se ele for interinstitucional;
+4. documento de apoio à solicitação de vaga, com a carga horário de trabalho do curso a ser realizado, bem como a informações básicas do curso, como o nome, o código curso, o período letivo e o local de realização;
+5. documento de comprovação de validade do cartão de identificação, se o aluno possuir cartão de identificação.
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+Esses documentos devem ser apresentados na própria da universidade a qual o aluno v
+```
 
-### Model Sources [optional]
+**Pergunta:** É obrigatório que o professor apresente o plano de ensino no início do período letivo?
 
-<!-- Provide the basic links for the model. -->
+```
+Sim, é obrigatório que o professor apresente o plano de ensino no início do período letivo.
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+A partir do artigo 1º do regimento geral, que indica que o professor deverá apresentar o plano de ensino no início do período letivo, como medida para garantir a congruência entre o plano de ensino e o ensino praticado, e para garantir que o professor esteja seguro dos objetivos e dos meios de ação estabelecidos no plano de ensino.
 
-## Uses
+Além disso, o artigo 4º do regimento geral estabelece que o chefe de departamento/coordenador acadêmico deverá sinalizar, em campo apropriado no SIE, a mensagem “PROFESSOR A CONTRATAR” para o professor que será responsável pela disciplina.
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+Portanto, o professor deverá apresentar o plano de ensino no início do período letivo, e, simultaneamente, sinalizar o professor a ser responsável pela disciplina, acessando o chefe de departamento/
+```
 
-### Direct Use
+**Pergunta:** Como ocorrem as eleições de reitor na UFAM?
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+```
+Ocorrendo as eleições de reitor na UFAM através do processo constitucionalmente estabelecido, que inclui a nomeação e a eleição do reitor pela comunidade universitária, conforme previsto no art. 82, 83 e 84 da lei nº 9.394, de 20 de dezembro de 1996.
 
-[More Information Needed]
+Ao longo da história da universidade, o processo eleitoral do reitor teve variadas formas de exercício, com a criação, em 1966, do conselho departamental, que se tornou o órgão responsável pela eleição do reitor.
 
-### Downstream Use [optional]
+Atualmente, a eleição do reitor da UFAM é feita pela comunidade universitária, mediante a nomeação e a eleição do candidato mais votado, mediante a obediência às normas constitucionais e regulamentares que regem a dolência.
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+O processo eleitoral é regulamentado pelo regimento da universidade, que define as condições para a participação do eleitorado,
+```
 
-[More Information Needed]
+## Detalhes do Modelo
 
-### Out-of-Scope Use
+### Dataset
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+Para mais informações sobre o processo de criação do dataset, leia o [card do dataset](https://huggingface.co/datasets/felipovysk/ufam-legis).
 
-[More Information Needed]
+### Fine tuning
 
-## Bias, Risks, and Limitations
+O modelo é baseado no modelo Llama-2-7b-chat-hf, com as seguintes configurações de quantização, e seguintes configurações de LoRA:
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+```
+BitsAndBytesConfig(
+    load_in_4bit=True,
+    bnb_4bit_quant_type="nf4",
+    bnb_4bit_compute_dtype="float16",
+    bnb_4bit_use_double_quant=False,
+)
 
-[More Information Needed]
+LoraConfig(
+    lora_alpha=16,
+    lora_dropout=0.1,
+    r=64,
+    bias="none",
+    task_type="CAUSAL_LM",
+)
+```
 
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+Ele foi treinado com o uso do [SFTTrainer](https://huggingface.co/docs/trl/sft_trainer) com o conjunto de triplas (pergunta, contexto, resposta) [deste dataset](
+https://huggingface.co/datasets/felipovysk/ufam-legis/tree/main), por 3 épocas, atingindo uma training loss de 1.055100.