https://github.com/sibyl-dev/sibylapp2
Configurable front-end for augmenting ML model outputs
https://github.com/sibyl-dev/sibylapp2
Last synced: 3 months ago
JSON representation
Configurable front-end for augmenting ML model outputs
- Host: GitHub
- URL: https://github.com/sibyl-dev/sibylapp2
- Owner: sibyl-dev
- License: mit
- Created: 2023-05-09T14:44:19.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2024-10-29T13:13:16.000Z (over 1 year ago)
- Last Synced: 2026-03-29T17:05:39.472Z (3 months ago)
- Language: Python
- Homepage:
- Size: 666 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
An open source project from Data to AI Lab at MIT.
# Sibylapp2
Library for visualizing explanations.
- License: MIT
- Homepage: https://sibyl-ml.dev/
- Live Demo: https://sibylapp.streamlit.app/
# Overview
**Sibylapp2** generates usable interfaces to interact with ML explanations. The app
reads RESTful APIs from [sibyl-api](https://github.com/sibyl-dev/sibyl-api)
# Install
## Requirements
**Sibylapp2** has been developed and tested on [Python 3.9, and 3.10](https://www.python.org/downloads/).
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](https://python-poetry.org/docs/#installation)
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](https://github.com/sibyl-dev/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:
```bash
poetry run sibyl run -v
```
2. 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.
3. From the root project folder, run:
```bash
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:
```bash
# Fix most linting errors
poetry run invoke fix-lint
# Ensure no linting errors remain
poetry run invoke lint
```
4. Run the app using the instructions above to confirm that all changes work as expected.
5. 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.