README.md

halcyon

Tools for "hype" and AI-generated text detection.

Keep the formatting clean

This repository uses black, flake8, and pre-commit to maintain good PEP8 code quality and readability, and to prevent against commits that are hard to read because of variations across formatting tools and IDEs.

Set up your repository (one-time step) by running:

pip install pre-commit
pre-commit install

Now, every time you do a local commit, pre-commit will analyze the formatting and let you know if there are any errors that need to be corrected.

You should also install black's autoformatter:

pip install black

And which you can run with:

(for a specific file)

black codes.py

(for a directory)

black tests/

Running the AI generated text detector demo

$ pip install -r requirements.txt
$ streamlit run demo_app.py

Running the Hype Detector demo

$ pip install -r requirements.txt
$ streamlit run hype_detector_demo.py