Evaluation of an interaction, using dialogue and resulting eKGs
This package provides the tools to evaluate a dialogue according to several approaches: human annotation, automatic evaluation (likelihood or graph based), and statistical overview.
This repository uses Python >= 3.7
Be sure to run in a virtual python environment (e.g. conda, venv, mkvirtualenv, etc.)
-
In the root directory of this repo run
pip install -e .
For using this repository as a package different project and on a different virtual environment, you may
-
install a published version from PyPI:
pip install cltl.dialogue_evaluation
-
or, for the latest snapshot, run:
pip install git+git://github.com/leolani/cltl-dialogueevaluation.git@main
Then you can import it in a python script as:
import cltl.dialogue_evaluation
Please take a look at the example scripts provided to get an idea on how to run and use this package. Each example has a comment at the top of the script describing the behaviour of the script.
For these example scripts, you need
-
To change your current directory to ./examples/
-
Run some examples (e.g. python label_based.py)
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.