cltl.dialogue-evaluation 0.2.6.dev1

The Leolani Language module for evaluating interactions

cltl-dialogueevaluation

Evaluation of an interaction, using dialogue and resulting eKGs

Description

This package provides the tools to evaluate a dialogue according to several approaches: human annotation, automatic evaluation (likelihood or graph based), and statistical overview.

Getting started

Prerequisites

This repository uses Python >= 3.7

Be sure to run in a virtual python environment (e.g. conda, venv, mkvirtualenv, etc.)

Installation

1. In the root directory of this repo run

   pip install -e .
   

Usage

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

Examples

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

1. To change your current directory to ./examples/

2. Run some examples (e.g. python label_based.py)

Contributing

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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• Selene Báez Santamaría
• Thomas Baier
• Piek Vossen