{"id":19457657,"url":"https://github.com/liaad/tieval","last_synced_at":"2025-04-25T05:31:23.873Z","repository":{"id":71825207,"uuid":"462231953","full_name":"LIAAD/tieval","owner":"LIAAD","description":"An Evaluation Framework for Temporal Information Extraction Systems","archived":false,"fork":false,"pushed_at":"2025-04-01T16:44:56.000Z","size":1098,"stargazers_count":18,"open_issues_count":6,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-01T17:48:46.063Z","etag":null,"topics":["evaluation-framework","information-extraction","nlp","temporal-relations"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LIAAD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-22T09:47:08.000Z","updated_at":"2025-04-01T16:43:58.000Z","dependencies_parsed_at":"2023-12-18T22:21:16.635Z","dependency_job_id":"69c1f6bf-3cad-4e7b-864d-190520d8f997","html_url":"https://github.com/LIAAD/tieval","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LIAAD%2Ftieval","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LIAAD%2Ftieval/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LIAAD%2Ftieval/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LIAAD%2Ftieval/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LIAAD","download_url":"https://codeload.github.com/LIAAD/tieval/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250760796,"owners_count":21482869,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["evaluation-framework","information-extraction","nlp","temporal-relations"],"created_at":"2024-11-10T17:23:17.702Z","updated_at":"2025-04-25T05:31:22.175Z","avatar_url":"https://github.com/LIAAD.png","language":"Python","readme":"# tieval\n\n[![PyPI](https://img.shields.io/pypi/v/tieval)](https://pypi.org/project/tieval/)\n[![Documentation Status](https://readthedocs.org/projects/tieval/badge/?version=latest)](https://tieval.readthedocs.io/en/latest/?badge=latest)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tieval)\n[![PyPI - License](https://img.shields.io/pypi/l/tieval)](LICENSE)\n![GitHub repo size](https://img.shields.io/github/repo-size/LIAAD/tieval)\n\n[![Paper](https://img.shields.io/badge/-paper-9cf)](https://dl.acm.org/doi/abs/10.1145/3539618.3591892)\n\nA framework for evaluation and development of temporally aware models.\n\n![](imgs/tieval.png)\n\n## Installation\n\nThe package is available on [PyPI](https://pypi.org/project/tieval/):\n\n```shell\npip install tieval\n```\n\nIt requires Python 3.8 or above.\n\n## Usage\n\nTo understand its usability refer to the notebooks available [here]().\n\n## Data\n\nThroughout the last two decades many datasets have been developed to train this task.\ntieval provides an easy interface to download the available corpus.\n\nTo know more about the module run the following code on the terminal.\n\n```shell\npython -m tieval download --help\n```\n\n## How to ...\n\nIn this section, we summarize how to perform the most useful operations in tieval.\n\n### download a dataset.\n\n```python\nfrom pathlib import Path\nfrom tieval import datasets\n\ndata_path = Path(\"data/\")\ndatasets.download(\"TimeBank\", data_path)\n```\n\n### load a dataset.\n\n```python\nfrom tieval import datasets\n\nte3 = datasets.read(\"tempeval_3\")\n```\n\n### load a model.\n\n```python\nfrom tieval import models\n\nmodel = models.TimexIdentificationBaseline()\n```\n\n### make predictions.\n\n```python\npred = model.predict(te3.test)\n```\n\n### evaluate predictions.\n\n```python\nfrom tieval import evaluate\n\nannot = {doc.name: doc.timexs for doc in te3.test}\nresults = evaluate.timex_identification(annot, pred)\n```\n\n## Contributing\n\n1. Fork it (https://github.com/LIAAD/tieval)\n2. Create your feature branch (`git checkout -b feature/fooBar`)\n3. Commit your changes (`git commit -am 'Add some fooBar'`)\n4. Push to the branch (`git push origin feature/fooBar`)\n5. Create a new Pull Request\n\n## Meta\n\nHugo Sousa - hugo.o.sousa@inesctec.pt\n\nThis framework is part of the [Text2Story](https://text2story.inesctec.pt/) project which is financed by the ERDF –\nEuropean Regional Development Fund through the North Portugal Regional Operational Programme (NORTE 2020), under the\nPORTUGAL 2020 and by National Funds through the Portuguese funding agency, FCT - Fundação para a Ciência e a Tecnologia\nwithin project PTDC/CCI-COM/31857/2017 (NORTE-01-0145-FEDER-03185) \n\n## Publications\n\nIf you use `tieval` in your work please site the following article:\n\n\n```bibtex\n@inproceedings{10.1145/3539618.3591892,\n    author = {Sousa, Hugo and Campos, Ricardo and Jorge, Al\\'{\\i}pio M\\'{a}rio},\n    title = {Tieval: An Evaluation Framework for Temporal Information Extraction Systems},\n    year = {2023},\n    isbn = {9781450394086},\n    publisher = {Association for Computing Machinery},\n    address = {New York, NY, USA},\n    url = {https://doi.org/10.1145/3539618.3591892},\n    doi = {10.1145/3539618.3591892},\n    booktitle = {Proceedings of the 46th International ACM SIGIR Conference on Research and Development in Information Retrieval},\n    pages = {2871–2879},\n    numpages = {9},\n    keywords = {temporal information extraction, evaluation, python package},\n    location = {Taipei, Taiwan},\n    series = {SIGIR '23}\n}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliaad%2Ftieval","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fliaad%2Ftieval","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliaad%2Ftieval/lists"}