enem_challenge_disabled.py

"""
ENEM Challenge dataset.

Dataset original source: https://www.ime.usp.br/~ddm/project/enem/
Processing code based on: https://github.com/piresramon/gpt-4-enem/blob/main/lm_eval/tasks/enem.py
"""

import datasets
import pandas as pd
import re
import xml.etree.ElementTree as ET 
import zipfile

_CITATION = """
@InProceedings{ ENEM-Challenge,
        author = {Silveira, Igor Cataneo and Mau\'a, Denis Deratani},
        booktitle = {Proceedings of the 6th Brazilian Conference on Intelligent Systems},
        series = {BRACIS},
        title = {University Entrance Exam as a Guiding Test for Artificial Intelligence},
        pages = {426--431},
        year = {2017}
}
@misc{pires2023evaluating,
      title={Evaluating GPT-4's Vision Capabilities on Brazilian University Admission Exams}, 
      author={Ramon Pires and Thales Sales Almeida and Hugo Abonizio and Rodrigo Nogueira},
      year={2023},
      eprint={2311.14169},
      archivePrefix={arXiv},
      primaryClass={cs.CL}
}
@misc{nunes2023evaluating,
      title={Evaluating GPT-3.5 and GPT-4 Models on Brazilian University Admission Exams}, 
      author={Desnes Nunes and Ricardo Primi and Ramon Pires and Roberto Lotufo and Rodrigo Nogueira},
      year={2023},
      eprint={2303.17003},
      archivePrefix={arXiv},
      primaryClass={cs.CL}
}
"""

_DESCRIPTION = """
The Exame Nacional do Ensino Médio (ENEM) is an advanced High-School level exam widely applied every year by the Brazilian government to students that wish to undertake a University degree.

The ENEM Challenge consists in designing an autonomous system that matches the performance of a human students on the exam. The overall goal is to foster and evaluate the development of Artificial Intelligence techniques that have good performance on complex cognitive tasks, not particularly designed for AI systems. In addition, this challenge aims to promote and give more visiblity to the development of NLP tools for Brazilian Portuguese.
"""

_HOMEPAGE="https://www.ime.usp.br/~ddm/project/enem/"

FILE_URL = "https://www.ime.usp.br/~ddm/project/enem/ENEMdataset.zip"

DATASET_PATH = "maritaca-ai/enem"


PATTERNS_REPLACES = [
    (r'\s*\n+\s*', r' '),  # changing \n to space
    (r'(\s)\1+', r' '),  # changing \n to space
    (r'^\s+', r''),
]

apply_regex = lambda pattern, replace, text: re.sub(pattern, replace, text)

def _parse_xml(exam, path, tag=None, first_n=None, verbose=True):
    root = ET.fromstring(path)
    #root = tree.getroot()

    filters = {
        'IC': 'No',
        #'MR': 'No',
        #'CE': 'No',
    }

    if tag is not None:
        assert tag in ['TC', 'EK', 'DS', 'TC_only', 'EK_only', 'DS_only'], (
            "Please choose 'TC', 'EK', 'DS', 'TC_only', 'EK_only' or 'DS_only'")

        if tag == 'TC':
            filters['TC'] = 'Yes'
        if tag == 'EK':
            filters['EK'] = 'Yes'
        if tag == 'DS':
            filters['DS'] = 'Yes'
        elif tag == 'TC_only':
            filters['TC'] = 'Yes'
            filters['EK'] = 'No'
            filters['DS'] = 'No'
        elif tag == 'EK_only':
            filters['TC'] = 'No'
            filters['EK'] = 'Yes'
            filters['DS'] = 'No'
        elif tag == 'DS_only':
            filters['TC'] = 'No'
            filters['EK'] = 'No'
            filters['DS'] = 'Yes'

    def ignore_question(child, filters):
        for k,v in filters.items():
            if child.get(k) != v:
                return True
        return False

    documents = []

    for idx, child in enumerate(root):

        if first_n is not None and idx == first_n:
            break

        if ignore_question(child, filters):
            continue

        header = child.find('header').text
        statement = child.find('statement').text

        if header is None or statement is None:
            continue

        for pattern, replace in PATTERNS_REPLACES:
            header = apply_regex(pattern, replace, header)
            statement = apply_regex(pattern, replace, statement)
            
        options = []

        answers = child.find('answers')
        for option in answers.iter('option'):
            text = option.text
            for pattern, replace in PATTERNS_REPLACES:
                if text is not None:
                    text = apply_regex(pattern, replace, text)
            options.append(text)

            if option.get('correct') == 'Yes':
                correct = option.get('id')

        document = {
            'id': exam + '_' + child.get('id'),  # used to filter out largest prompt candidates
            "number": int(child.get('id')),
            'exam': exam,  # used to get metrics for each exam, and to filter out prompt candidates
            'context': header,
            'question': statement,
            'options': options,
            'label': correct.lower(),
        }
        assert len(document['options']) == 5, print('The document does not have 5 options')
        documents.append(document)

    return documents

def _get_train_examples():
        header = 'Urgência emocional. Se tudo é para ontem, se a vida engata uma primeira e sai em disparada, se não há mais tempo para paradas estratégicas, caímos fatalmente no vício de querer que os amores sejam igualmente resolvidos num átimo de segundo. Temos pressa para ouvir "eu te amo". Não vemos a hora de que fiquem estabelecidas as regras de convívio: somos namorados, ficantes, casados, amantes? Urgência emocional. Uma cilada. Associamos diversas palavras ao AMOR: paixão, romance, sexo, adrenalina, palpitação. Esquecemos, no entanto, da palavra que viabiliza esse sentimento: "paciência". Amor sem paciência não vinga. Amor não pode ser mastigado e engolido com emergência, com fome desesperada. É uma refeição que pode durar uma vida. MEDEIROS, M. Disponível em: http://porumavidasimples.blogspot.com.br. Acesso em: 20 ago. 2017 (adaptado).'
        statement = 'Nesse texto de opinião, as marcas linguísticas revelam uma situação distensa e de pouca formalidade, o que se evidencia pelo(a) '
        options = [
            'impessoalização ao longo do texto, como em: "se não há mais tempo". ',
            'construção de uma atmosfera de urgência, em palavras como: "pressa". ',
            'repetição de uma determinada estrutura sintática, como em: "Se tudo é para ontem". ',
            'ênfase no emprego da hipérbole, como em: "uma refeição que pode durar uma vida". ',
            'emprego de metáforas, como em: "a vida engata uma primeira e sai em disparada". ',
        ]
        explanation_1 = 'A alternativa A. está ERRADA porque impessoalização não é uma marca de pouca formalidade, inclusive o uso do verbo haver representa uma marca de formalidade. A alternativa B. está ERRADA porque o texto até criou uma atmosfera de urgência, embora tenha sido para criticá-la, e discute exatamente a importância da paciência e não da pressa. A alternativa C. está ERRADA porque a estrutura sintática não é repetida sistematicamente ao longo do texto. A alternativa D. está ERRADA porque, embora o texto possua hipérboles, para afirmar que a figura de linguagem é enfatizada, ela deveria aparecer mais vezes. A alternativa E. está CORRETA porque o texto possui comparações implícitas que se caracterizam como metáforas. Logo o texto emprega metáforas. Resposta:'
        explanation_2 = 'O texto é escrito em uma linguagem leve, ágil, e de pouca formalidade. Além disso, possui figuras de linguagem, como metáforas e hipérboles, que não são excludentes. Em uma análise sequencial das alternativas, daria para afirmar que D. e E. estão corretas. Entretanto, observando em detalhes, nota-se que a expressão "emprego de metáforas" mostra ser mais adequada do que "ênfase no emprego da hipérbole", visto que, para afirmarmos que o uso de hipérboles foi enfatizado, a figura de linguagem deveria ter aparecido mais vezes. Isso torna a alternativa E. mais provável de ser CORRETA. Além disso, impessoalização não deve ser apontada como marca de pouca formalidade. Existe também uma atmosfera de urgência, mas que é criticada no texto que destaca a importância da paciência e não da pressa. Por fim, a estrutura sintática não é repetida sistematicamente ao longo do texto. Resposta:'
        document_1 = {
            'id': '2022_21',  # used to filter out from test set
            'exam': '2022',  # used to get metrics for each exam, and to filter out prompt candidates
            'context': header,
            'question': statement,
            'options': options,
            'label': 'e',
            'explanation': explanation_2,
        }

        header = 'Sempre que a relevância do discurso entra em jogo, a questão torna-se política por definição, pois é o discurso que faz do homem um ser político. E tudo que os homens fazem, sabem ou experimentam só tem sentido na medida em que pode ser discutido. Haverá, talvez, verdades que ficam além da linguagem e que podem ser de grande relevância para o homem no singular, isto é, para o homem que, seja o que for, não é um ser político. Mas homens no plural, isto é, os homens que vivem e se movem e agem neste mundo, só podem experimentar o significado das coisas por poderem falar e ser inteligíveis entre si e consigo mesmos. ARENDT, H. A condição humana. Rio de Janeiro: Forense Universitária, 2004.'
        statement = 'No trecho, a filósofa Hannah Arendt mostra a importância da linguagem no processo de'
        options = [
            'entendimento da cultura.',
            'aumento da criatividade.',
            'percepção da individualidade.',
            'melhoria da técnica.',
            'construção da sociabilidade.',
        ]
        explanation_1 = 'A alternativa A. está ERRADA porque Hannah Arendt não trata do entendimento da cultura, mas da relação social entre as pessoas dessa cultura. A alternativa B. está ERRADA porque Hannah Arendt não fala sobre criatividade, mas sobre a construção de laços entre as pessoas. A alternativa C. está ERRADA porque a linguagem é utilizada no oposto da individualidade, em algo mais coletivo e social. A alternativa D. está ERRADA porque o texto não fala de técnica, mas de laços. A alternativa E. está CORRETA porque a nossa sociabilidade se constrói a partir da linguagem, o que faz de nós seres políticos, no sentido de viver em sociedade, em ambientes coletivos. Resposta:'
        explanation_2 = 'Hannah Arendt defende em sua obra que somos seres políticos, no sentido próprio de vivermos em pólis, em ambiente coletivo e social. E essa sociabilidade só é possível por meio do discurso, da linguagem. Desse modo, podemos concluir que a linguagem se apresenta como uma importante ferramenta para a construção da sociabilidade, e portanto a alternativa E. é a CORRETA. Além disso, não se trata do entendimento da cultura, mas da relação social entre as pessoas dessa cultura. Hannah também não fala sobre aumento de criatividade, tampouco sobre técnica. Por fim, a linguagem é utilizada em algo mais coletivo e social, justamente o oposto da individualidade. Resposta:'
        document_2 = {
            'id': '2022_88',  # used to filter out from test set
            'exam': '2022',  # used to get metrics for each exam, and to filter out prompt candidates
            'context': header,
            'question': statement,
            'options': options,
            'label': 'e',
            'explanation': explanation_2,
        }

        header = 'Um casal planeja construir em sua chácara uma piscina com o formato de um paralelepípedo reto retângulo com capacidade para 90 000 L de água. O casal contratou uma empresa de construções que apresentou cinco projetos com diferentes combinações nas dimensões internas de profundidade, largura e comprimento. A piscina a ser construída terá revestimento interno em suas paredes e fundo com uma mesma cerâmica, e o casal irá escolher o projeto que exija a menor área de revestimento. As dimensões internas de profundidade, largura e comprimento, respectivamente, para cada um dos projetos, são: projeto I: 1,8 m, 2,0 m e 25,0 m; projeto II: 2,0 m, 5,0 m e 9,0 m; projeto III: 1,0 m, 6,0 m e 15,0 m; projeto IV: 1,5 m, 15,0 m e 4,0 m; projeto V: 2,5 m, 3,0 m e 12,0 m.'
        statement = 'O projeto que o casal deverá escolher será o'
        options = [
            'I.',
            'II.',
            'III.',
            'IV.',
            'V.',
        ]
        explanation_1 = 'Devemos calcular a área das quatro faces laterais e a área da base inferior (fundo da piscina) e somar essas áreas para obter a área de revestimento. Logo, calculando a área de revestimento de cada projeto, temos: Projeto I: A = 2 x 25 + 2 x 1,8 x (2 + 25) = 147,2; Projeto II: A = 9 x 5 + 2 x 2 x (9 + 5) = 101; Projeto III: A = 15 x 6 + 2 x 1 x (15 + 6) = 132; Projeto IV: A = 4 x 15 + 2 x 1,5 x (15 + 4) = 117; Projeto V: A = 3 x 12 + 2 x 2,5 x (3 + 12) = 111. Logo, o projeto com menor área de revestimento, é o projeto II, portanto a resposta corrreta é B. Resposta:'
        explanation_2 = 'Devemos calcular a área das quatro faces laterais e a área da base inferior (fundo da piscina) e somar essas áreas para obter a área de revestimento. Logo, calculando a área de revestimento de cada projeto, temos: Projeto I: A = 2 x 25 + 2 x 1,8 x (2 + 25) = 147,2; Projeto II: A = 9 x 5 + 2 x 2 x (9 + 5) = 101; Projeto III: A = 15 x 6 + 2 x 1 x (15 + 6) = 132; Projeto IV: A = 4 x 15 + 2 x 1,5 x (15 + 4) = 117; Projeto V: A = 3 x 12 + 2 x 2,5 x (3 + 12) = 111. Logo, o projeto com menor área de revestimento, é o projeto II, portanto a resposta correta é B. Resposta:'
        document_3 = {
            'id': '2022_143',  # used to filter out from test set
            'exam': '2022',  # used to get metrics for each exam, and to filter out prompt candidates
            'context': header,
            'question': statement,
            'options': options,
            'label': 'b',
            'explanation': explanation_2,
        }
        return [document_1, document_2, document_3]


class ENEMChallenge(datasets.GeneratorBasedBuilder):

    VERSION = datasets.Version("1.1.0")
    def _info(self):
        return datasets.DatasetInfo(
            description=_DESCRIPTION,
            features=datasets.Features(
                {
                    "id": datasets.Value("string"),
                    "question_number": datasets.Value("int32"),
                    "exam_id": datasets.Value("string"),
                    "exam_year": datasets.Value("string"),
                    #"question_type": datasets.Value("string"),
                    "nullified": datasets.Value("bool"),
                    "question": datasets.Value("string"),
                    "choices": datasets.Sequence(feature={
                        "text": datasets.Value("string"),
                        "label": datasets.Value("string")
                    }),
                    "answerKey": datasets.Value("string"),
                    "explanation": datasets.Value("string"),
                    #"has_figure": datasets.Value("bool"),
                    #"figures": datasets.Sequence(datasets.Value("string"))
                    #"ledor": datasets.Sequence(datasets.Value("string"))
                    }),
            supervised_keys=None,
            homepage=_HOMEPAGE,
            citation=_CITATION,
        )

    def _split_generators(self, dl_manager):
        downloaded_file = dl_manager.download(FILE_URL)
        explanation_questions = {d['id']:d['explanation'] for d in _get_train_examples()}
        dataset = {
            '2022': datasets.load_dataset(DATASET_PATH, name="2022", split="train"),
            '2023': datasets.load_dataset(DATASET_PATH, name="2023", split="train")
        }

        return [
            datasets.SplitGenerator(
                name=datasets.Split.TRAIN,
                gen_kwargs={
                    "data_list": [downloaded_file, dataset],
                    "types": ["zip", "dataset"],
                    "explanation_questions": explanation_questions
                }
            )     
        ]

    def _generate_examples(self, data_list, types, explanation_questions):
        for data, type in zip(data_list, types):
            if type == "zip":
                with zipfile.ZipFile(data, 'r') as zip_ref:
                    filenames = zip_ref.namelist()
                    xml_files = [filename for filename in filenames if filename.endswith(".xml")]
                    #open all files with .xml
                    for filename in xml_files:
                        sub_exam_id = filename.replace(".xml", "")
                        exam_id = sub_exam_id.split('-')[0]
                        if exam_id.endswith('_'):
                            exam_id = exam_id[:-1]
                        year = exam_id.split('_')[0]
                        with zip_ref.open(filename) as f:
                            content = f.read()
                        documents = _parse_xml(exam_id, content, first_n=None, tag=None)
                        for i, document in enumerate(documents):
                            choices = {
                                "text": document["options"],
                                "label": ["A", "B", "C", "D", "E"]
                            }
                            doc_id = f"{exam_id}_{document['number']}"
                            yield doc_id, {
                                "id": doc_id,
                                "question_number": document["number"],
                                "exam_id": exam_id,
                                "exam_year": year,
                                "nullified": None,
                                "question": document["context"] + '\n' + document["question"],
                                "choices": choices,
                                "answerKey": document["label"].upper(),
                                "explanation": explanation_questions.get(doc_id, None)
                            }
            if type == "dataset":
                for exam_id in data:
                    dataset = data[exam_id]
                    for document in dataset:
                        if document['IU']:
                            continue
                        choices = {
                            "text": document["alternatives"],
                            "label": ["A", "B", "C", "D", "E"]
                        }
                        question_number = int(document['id'].split('_')[1])
                        doc_id = f"{exam_id}_{question_number}"
                        yield doc_id, {
                            "id": doc_id,
                            "question_number": question_number,
                            "exam_id": exam_id,
                            "exam_year": exam_id.split('_')[0],
                            "nullified": None,
                            "question": document["question"],
                            "choices": choices,
                            "answerKey": document["label"].upper(),
                            "explanation": explanation_questions.get(doc_id, None)
                        }