Text Similarity Evaluation Tool

This repository contains tools for evaluating the similarity between texts using different methods, such as BERT embeddings and BLEU score.

Structure

• examples/: Contains example Jupyter notebooks demonstrating how to use the tools.
  • data/: Data directory for examples.
  • example_usage.ipynb: An example notebook showing how to use the similarity evaluation tool.
• text_eval/: The Python package directory.
  • __init__.py: Makes text_eval a Python package.
  • similarity_eval.py: Core script containing the similarity evaluation functions.
• requirements.txt: Lists the project dependencies.

Setup

1. Clone this repository to your local machine.
2. Ensure you have Python installed.
3. Install the required dependencies by running pip install -r requirements.txt in the root directory of the project.

Usage

The main functionality is demonstrated in the example_usage.ipynb notebook.

Contributing

Contributions to improve the tool or extend its functionality are welcome. Please feel free to fork the repository and submit pull requests.