{"id":13595184,"url":"https://github.com/neulab/ExplainaBoard","last_synced_at":"2025-04-09T10:33:08.523Z","repository":{"id":37250431,"uuid":"351354197","full_name":"neulab/ExplainaBoard","owner":"neulab","description":"Interpretable Evaluation for AI Systems","archived":false,"fork":false,"pushed_at":"2023-03-10T13:39:00.000Z","size":28913,"stargazers_count":364,"open_issues_count":62,"forks_count":36,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-03-11T11:33:06.965Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neulab.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":"CODEOWNERS","security":null,"support":"docs/supported_metrics.md","governance":null,"roadmap":null,"authors":null}},"created_at":"2021-03-25T08:01:37.000Z","updated_at":"2025-03-11T10:31:44.000Z","dependencies_parsed_at":"2024-01-13T12:10:20.044Z","dependency_job_id":null,"html_url":"https://github.com/neulab/ExplainaBoard","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neulab%2FExplainaBoard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neulab%2FExplainaBoard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neulab%2FExplainaBoard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neulab%2FExplainaBoard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neulab","download_url":"https://codeload.github.com/neulab/ExplainaBoard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248020593,"owners_count":21034459,"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":[],"created_at":"2024-08-01T16:01:45.455Z","updated_at":"2025-04-09T10:33:03.514Z","avatar_url":"https://github.com/neulab.png","language":"Python","readme":"# ExplainaBoard: An Explainable Leaderboard for NLP\n\n\u003cimg src=\"./fig/logo-full-v2.png\" width=\"800\" class=\"center\"\u003e\n\n[![License](https://img.shields.io/github/license/neulab/ExplainaBoard)](https://github.com/neulab/ExplainaBoard/blob/main/LICENSE)\n[![GitHub stars](https://img.shields.io/github/stars/neulab/ExplainaBoard)](https://github.com/neulab/ExplainaBoard/stargazers)\n[![PyPI](https://img.shields.io/pypi/v/explainaboard)](https://pypi.org/project/explainaboard/)\n[![Code Style](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black)\n[![Integration Tests](https://github.com/neulab/ExplainaBoard/actions/workflows/ci.yml/badge.svg?event=push)](.github/workflows/ci.yml)\n\n## What is ExplainaBoard?\n\nWhen developing a natural language processing (NLP or AI) system, often one of the\nhardest things is to understand where your system is working and where it is failing,\nand deciding what to do next. ExplainaBoard is a tool that *inspects your system\noutputs*, *identifies what is working and what is not working*, and helps *inspire you\nwith ideas of where to go next*.\n\n\u003cimg src=\"./fig/intro.png\" width=\"300\" align=\"right\"\u003e\n\nIt offers a number of different ways with which you can evaluate and understand your systems:\n\n1. *Single-system Analysis*: What is a system good or bad at?\n2. *Pairwise Analysis*: Where is one system better (worse) than another?\n3. *Fine-grained Error Analysis*: On what examples do errors occur?\n4. *Holistic Leaderboards and Benchmarks*: Which systems perform best for a particular task?\n\n## Using Explainaboard\n\nExplainaBoard can be used online or offline. For most users, we recommend using the\nonline interface, as it is more interactive and easier to get started.\n\n### Online Usage\n\nBrowse the [**web interface**](https://explainaboard.inspiredco.ai), which gives you the\nability to browse outputs and evaluate and analyze your own system outputs.\n\n\u003ca href=\"https://explainaboard.inspiredco.ai\"\u003e\u003cimg src=\"./fig/demo-v2.png\" width=\"500\" class=\"center\"\u003e\u003c/a\u003e\n\nIf you would like to evaluate and analyze your own systems programmatically, you can\nuse the\n\u003ca href=\"https://github.com/neulab/explainaboard_client\"\u003eExplainaBoard client\u003c/a\u003e.\n\n### Offline Usage\n\nFor power-users who want to use ExplainaBoard offline, first, follow the installation directions\nbelow, then take a look at our [**CLI examples**](docs/cli_interface.md).\n\n**Install Method 1 - Standard Use:** Simple installation from PyPI (Python 3 only)\n\n```bash\npip install --upgrade pip  # recommending the newest version of pip.\npip install explainaboard\npython -m spacy download en_core_web_sm  # if you plan to use the AspectBasedSentimentClassificationProcessor\n```\n\n**Install Method 2 - Development:** Install from the source and develop locally (Python\n3 only)\n\n```bash\n# Clone current repo\ngit clone https://github.com/neulab/ExplainaBoard.git\ncd ExplainaBoard\n\n# Install the required dependencies and dev dependencies\npip install .\"[dev]\"\npython -m spacy download en_core_web_sm\npre-commit install\n```\n\n- **Testing:** To run tests, you can run `python -m unittest`.\n- **Linting and Code Style:** This project uses flake8 (linter) and black (formatter).\n  They are enforced in the pre-commit hook and in the CI pipeline.\n  - run `python -m black .` to format code\n  - run `flake8` to lint code\n  - You can also configure your IDE to automatically format and lint the files as you\n    are writing code.\n\nAfter trying things out in the [CLI](docs/cli_interface.md), you can read how to add\nnew [features](docs/add_new_features.md), [tasks](docs/add_new_tasks.md), or\n[file formats](docs/add_new_formats.md).\n\n## Acknowledgement\n\nExplainaBoard is developed by Carnegie Mellon University, Inspired Cognition Inc., and\nother collaborators. If you find it useful in research, you can cite it in papers:\n\n```text\n@inproceedings{liu-etal-2021-explainaboard,\n    title = \"{E}xplaina{B}oard: An Explainable Leaderboard for {NLP}\",\n    author = \"Liu, Pengfei and Fu, Jinlan and Xiao, Yang and Yuan, Weizhe and Chang, Shuaichen and Dai, Junqi and Liu, Yixin and Ye, Zihuiwen and Neubig, Graham\",\n    booktitle = \"Proceedings of the 59th Annual Meeting of the Association for Computational Linguistics and the 11th International Joint Conference on Natural Language Processing: System Demonstrations\",\n    month = aug,\n    year = \"2021\",\n    address = \"Online\",\n    publisher = \"Association for Computational Linguistics\",\n    url = \"https://aclanthology.org/2021.acl-demo.34\",\n    doi = \"10.18653/v1/2021.acl-demo.34\",\n    pages = \"280--289\",\n}\n```\n\nWe thanks all authors who shared their system outputs with us: Ikuya Yamada, Stefan Schweter,\nColin Raffel, Yang Liu, Li Dong. We also thank\nVijay Viswanathan, Yiran Chen, Hiroaki Hayashi for useful discussion and feedback about ExplainaBoard.\n","funding_links":[],"categories":["Python","Tools","Python Libraries(sort in alphabeta order)","Technical Resources"],"sub_categories":["Interpretability/Explicability","Evaluation methods","Open Source/Access Responsible AI Software Packages"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneulab%2FExplainaBoard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneulab%2FExplainaBoard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneulab%2FExplainaBoard/lists"}