Metadata-Version: 2.4
Name: hallucitechecker
Version: 0.1.2
Summary: Add your description here
Author-email: Yusuke Sakai <sakai.yusuke.sr9@is.naist.jp>
License-File: LICENSE.txt
Requires-Python: >=3.11
Requires-Dist: accelerate>=0.20.3
Requires-Dist: acl-anthology>=1.0.0
Requires-Dist: blingfire2>=0.2.1
Requires-Dist: datasets>=4.6.1
Requires-Dist: docling>=2.75.0
Requires-Dist: h5py>=3.15.1
Requires-Dist: lmdb>=1.7.5
Requires-Dist: numpy==2.3.4
Requires-Dist: onnxruntime>=1.24.2
Requires-Dist: openreview-py>=1.58.0
Requires-Dist: pandas>=2.3.3
Requires-Dist: protobuf>=7.34.0
Requires-Dist: pydot>=4.0.1
Requires-Dist: pypdf>=6.7.4
Requires-Dist: pytest>=9.0.2
Requires-Dist: python-dotenv>=1.2.1
Requires-Dist: pytorch-crf>=0.7.2
Requires-Dist: rapidfuzz>=3.14.3
Requires-Dist: rapidocr-onnxruntime>=1.4.4
Requires-Dist: regex>=2026.2.19
Requires-Dist: requests>=2.32.5
Requires-Dist: rich>=14.3.3
Requires-Dist: scikit-learn>=1.8.0
Requires-Dist: sentencepiece>=0.2.1
Requires-Dist: spacy>=3.8.11
Requires-Dist: termcolor>=3.3.0
Requires-Dist: torch>=2.10.0
Requires-Dist: tqdm>=4.67.3
Requires-Dist: transformers>=4.57.6
Requires-Dist: truecase>=0.0.14
Requires-Dist: unidecode>=1.4.0
Description-Content-Type: text/markdown

<h1 align="center">
HalluCiteChecker
</h1>

<p align="center">
<a href="https://pypi.org/project/HalluCiteChecker"><img alt="PyPi" src="https://img.shields.io/pypi/v/hallucitechecker"></a>
<a href="https://github.com/yusuke1997/HalluCiteChecker/blob/main/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/yusuke1997/HalluCiteChecker.svg"></a>
<a href="https://pypi.org/project/HalluCiteChecker"><img alt="Python" src="https://img.shields.io/pypi/pyversions/hallucitechecker"></a>
<p align="center">

<p align="center">
<img src="https://raw.githubusercontent.com/yusuke1997/HalluCiteChecker/main/assets/overview.png" height="480px">
</p>

## Installation

You can install from PyPi:

``` bash
pip install hallucitechecker
```

For developers, it can be installed from the source.

``` bash
git clone git@github.com:yusuke1997/HalluCiteChecker.git
cd HalluCiteChecker/
pip install ./
```

For uv users:
``` bash
uv add hallucitechecker
```

## Quick start

``` bash
hallucitechecker -i manuscript.pdf
```
If it is detected, it will be displayed in the CLI.

You can treat multiple PDF files at once.

``` bash
hallucitechecker -i manuscript1.pdf manusctipt2.pdf
or
hallucitechecker -i manuscripts_dir/*
```

If you get a PDF with highlights, please specify the output directory.
``` bash
hallucitechecker -i manuscript.pdf -o results_dir
```

If a hallucitation is detected, a PDF will be generated. If everything is clear, no PDF will be generated. In other words, you only need to manually verify the PDFs in the output directory.
