{"id":47715243,"url":"https://github.com/sibyl-dev/pyreal","last_synced_at":"2026-04-04T17:49:19.149Z","repository":{"id":38444616,"uuid":"256585011","full_name":"sibyl-dev/pyreal","owner":"sibyl-dev","description":"An easier approach to using and understanding ML models","archived":false,"fork":false,"pushed_at":"2025-05-06T00:58:38.000Z","size":57901,"stargazers_count":24,"open_issues_count":63,"forks_count":3,"subscribers_count":3,"default_branch":"dev","last_synced_at":"2026-04-03T04:57:35.792Z","etag":null,"topics":["explainable-ai","machine-learning","python","xai"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","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/sibyl-dev.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","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":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-04-17T18:52:50.000Z","updated_at":"2026-02-23T22:58:58.000Z","dependencies_parsed_at":"2024-07-19T18:22:19.892Z","dependency_job_id":"2bde42d7-5a19-442c-822e-ab84e33ef952","html_url":"https://github.com/sibyl-dev/pyreal","commit_stats":null,"previous_names":["dai-lab/pyreal"],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/sibyl-dev/pyreal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sibyl-dev%2Fpyreal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sibyl-dev%2Fpyreal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sibyl-dev%2Fpyreal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sibyl-dev%2Fpyreal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sibyl-dev","download_url":"https://codeload.github.com/sibyl-dev/pyreal/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sibyl-dev%2Fpyreal/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31407654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T10:20:44.708Z","status":"ssl_error","status_checked_at":"2026-04-04T10:20:06.846Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["explainable-ai","machine-learning","python","xai"],"created_at":"2026-04-02T18:54:11.763Z","updated_at":"2026-04-04T17:49:19.142Z","avatar_url":"https://github.com/sibyl-dev.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"left\"\u003e\n\u003cimg width=15% src=\"https://dai.lids.mit.edu/wp-content/uploads/2018/06/Logo_DAI_highres.png\" alt=“DAI-Lab” /\u003e\n\u003ci\u003eAn open source project from Data to AI Lab at MIT.\u003c/i\u003e\n\u003c/p\u003e\n\n\u003c!-- Uncomment these lines after releasing the package to PyPI for version and downloads badges --\u003e\n\n[![PyPI Shield](https://img.shields.io/pypi/v/pyreal.svg)](https://pypi.python.org/pypi/pyreal)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyreal)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/pyreal)](https://pypi.python.org/pypi/pyreal)\n[![Build Action Status](https://github.com/DAI-Lab/pyreal/workflows/Test%20CI/badge.svg)](https://github.com/DAI-Lab/pyreal/actions)\n[![Static Badge](https://img.shields.io/badge/slack-sibyl-purple?logo=slack)](https://join.slack.com/t/sibyl-ml/shared_invite/zt-2dyfwbgo7-2ALinuT2KDZpsVJ4rntJuA)\n\u003c!--[![Travis CI Shield](https://travis-ci.org/DAI-Lab/pyreal.svg?branch=stable)](https://travis-ci.org/DAI-Lab/pyreal)--\u003e\n\u003c!--[![Coverage Status](https://codecov.io/gh/DAI-Lab/pyreal/branch/stable/graph/badge.svg)](https://codecov.io/gh/DAI-Lab/pyreal)--\u003e\n\n# Pyreal\n\nAn easier approach to understanding your model's predictions.\n\n| Important Links                               |                                                                      |\n| --------------------------------------------- | -------------------------------------------------------------------- |\n| :book: **[Documentation]**                    | Quickstarts and user guides                                          |\n| :memo: **[API Reference]**                    | Full library API                                                     |\n| :apple: **[Tutorials]**                       | Notebooks with example usage                                          |\n| :scroll: **[License]**                        | This repository is published under the MIT License                    |\n| :computer: **[Project Homepage]**             | Check out the Sibyl project website for more information             |\n\n[Project Homepage]: https://sibyl-ml.dev/\n[Documentation]: https://dtail.gitbook.io/pyreal/\n[Tutorials]: https://github.com/sibyl-dev/pyreal/tree/dev/tutorials\n[License]: https://github.com/sibyl-dev/pyreal/blob/dev/LICENSE\n[Community]: https://join.slack.com/t/sibyl-ml/shared_invite/zt-2dyfwbgo7-2ALinuT2KDZpsVJ4rntJuA\n[API Reference]: https://sibyl-ml.dev/pyreal/api_reference/index.html\n\n# Overview\n\n**Pyreal** gives you easy-to-understand explanations of your machine learning models in a low-code manner.\nPyreal wraps full ML pipelines in a RealApp object that makes it easy to use, understand, and interact with your ML model — regardless of your ML expertise.\n\nSee our tutorial series for an example of using Pyreal for house-price prediction:\n- [Part 1: Learn about feature engineering and modelling](https://medium.com/mit-data-to-ai-lab/using-and-understanding-machine-learning-ml-models-ada6525cf192)\n- [Part 2: Learn how to use Pyreal to use and understand ML models ](https://medium.com/mit-data-to-ai-lab/using-and-understanding-machine-learning-ml-models-0ce7c227837e) \n\n# Install\n\n## Requirements\n\n**Pyreal** has been developed and tested on [Python 3.9, 3.10, and 3.11](https://www.python.org/downloads/)\nThe library uses Poetry for package management.\n\n## Install from PyPI\n\nWe recommend using\n[pip](https://pip.pypa.io/en/stable/) in order to install **Pyreal**:\n\n```\npip install pyreal\n```\n\nThis will pull and install the latest stable release from [PyPI](https://pypi.org/project/pyreal/).\n\n## Install from source\n\nIf you do not have **poetry** installed, please head to [poetry installation guide](https://python-poetry.org/docs/#installation)\nand install poetry according to the instructions.\\\nRun the following command to make sure poetry is activated. You may need to close and reopen the terminal.\n\n```\npoetry --version\n```\n\nFinally, you can clone this repository and install it from\nsource by running `poetry install`, with the optional `examples` extras if you'd like to run our tutorial scripts.\n\n```\ngit clone https://github.com/sibyl-dev/pyreal.git\ncd pyreal\npoetry install\n```\n\n## Install for Development\n\nIf you want to contribute to the project, a few more steps are required to make the project ready\nfor development.\n\nPlease head to the [Contributing Guide](https://dtail.gitbook.io/pyreal/developer-guides/contributing-to-pyreal)\nfor more details about this process.\n\n# Quickstart\n\nIn this short tutorial we will guide you through some steps to get your started with **Pyreal**.\nWe will use a RealApp object to get predictions and explanations on whether a passenger on the Titanic would have survived.\n\nFor a more detailed version of this tutorial, see [our documentation](https://dtail.gitbook.io/pyreal/getting-started/quickstart).\n\n#### Load in the demo data and application\n\n```python\nimport pyreal.sample_applications.titanic as titanic\n\nreal_app = titanic.load_app()\nsample_data = titanic.load_data(n_rows=300)\n\n```\n\n#### Predict and produce explanation\n\n```python\npredictions = real_app.predict(sample_data)\n\nexplanation = real_app.produce_feature_contributions(sample_data)\n\n```\n\n#### Visualize explanation for one passenger\n\n```python\npassenger_id = 1\nfeature_bar_plot(explanation[passenger_id], prediction=predictions[passenger_id], show=False)\n\n```\n\nThe output will be a bar plot showing the most contributing features, by absolute value.\n\n![Quickstart](docs/images/titanic.png)\n\nWe can see here that the input passenger's predicted chance of survival was greatly reduced\nbecause of their sex (male) and ticket class (3rd class).\n\n### Migrating your application to Pyreal\nTo create a RealApp object for your own application,\nsee our [migration tutorial](https://github.com/sibyl-dev/pyreal/blob/dev/tutorials/migrating_to_pyreal.ipynb).\n\nFor basic applications built on `sklearn` pipelines, you may be able to simply use:\n```python\nfrom pyreal import RealApp\n\npipeline = # YOUR SKLEARN PIPELINE\nX_train, y_train = # YOUR TRAINING DATA\n\nreal_app = RealApp.from_sklearn(pipeline, X_train=X_train, y_train=y_train)\n```\n\n# Next Steps\n\nFor more information on using **Pyreal** for your use case, head over to the full [documentation site](https://dtail.gitbook.io/pyreal/getting-started/next-steps).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsibyl-dev%2Fpyreal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsibyl-dev%2Fpyreal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsibyl-dev%2Fpyreal/lists"}