Skip to content

Latest commit

 

History

History
80 lines (62 loc) · 3.31 KB

README.md

File metadata and controls

80 lines (62 loc) · 3.31 KB
Raw

“DAI-Lab” An open source project from Data to AI Lab at MIT.

Sibylapp2

Library for visualizing explanations.

Overview

Sibylapp2 generates usable interfaces to interact with ML explanations. The app reads RESTful APIs from sibyl-api

Install

Requirements

Sibylapp2 has been developed and tested on Python 3.9, and 3.10. The library uses Poetry for package management and runs on Streamlit.

Install from source

If you do not have poetry installed, please head to poetry installation guide and install poetry according to the instructions.
Run the following command to make sure poetry is activated. You may need to close and reopen the terminal.

poetry --version

Finally, you can clone this repository and install it from source by running poetry install, with the optional examples extras if you'd like to run our tutorial scripts.

git clone https://github.com/sibyl-dev/sibylapp2.git
cd sibylapp2
poetry install

Running Sibylapp2

  1. First, you will need to head over to the sibyl-api repo, and follow the instructions there to load in your database. You can run your APIs once your database in setup from the parent sibyl-api folder with:
poetry run sibyl run -v
  1. Open sibylapp2/config.py, and update BASE_URL to the URL your APIs are running on. You can also set configurations specific to your application here.
  2. From the root project folder, run:
poetry run streamlit run main.py

Contributing Guide

We appreciate contributions of all kinds! To contribute code to the repo please follow these steps:

  1. Clone and install the library following the instructions above.
  2. Make a new branch off of dev with a descriptive name describing your change.
  3. Make changes to that branch, committing and pushing code as you go. Run the following commands to ensure your code meets style requirements:
# Fix most linting errors
poetry run invoke fix-lint
# Ensure no linting errors remain
poetry run invoke lint
  1. Run the app using the instructions above to confirm that all changes work as expected.
  2. Once you are done making and testing changes, and linting passes, push all code and make a pull request. One all checks pass and the PR has been approved, merge your code and delete the branch.