Metadata-Version: 2.4
Name: evaluatio
Version: 0.3.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
License-File: LICENSE
Summary: High-performance NLP evaluation and significance testing library
Keywords: nlp,metrics,wer,cer,evaluation,word-error-rate,speech-recognition,rust-extensions
Author-email: Preben Vangberg <prv21fgt@bangor.ac.uk>
Maintainer-email: Preben Vangberg <prv21fgt@bangor.ac.uk>
License-Expression: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Documentation, https://prvinspace.github.io/evaluatio/
Project-URL: Homepage, https://codeberg.org/prvinspace/evaluatio
Project-URL: Issues, https://codeberg.org/prvinspace/evaluatio/issues
Project-URL: Repository, https://codeberg.org/prvinspace/evaluatio

# Evaluatio
![PyPI - Version](https://img.shields.io/pypi/v/evaluatio)
![License](https://img.shields.io/github/license/prvInSpace/evaluatio)
[![CI](https://github.com/prvInSpace/evaluatio/actions/workflows/CI.yml/badge.svg)](https://github.com/prvInSpace/evaluatio/actions/workflows/CI.yml)
[![codecov](https://codecov.io/github/prvInSpace/evaluatio/graph/badge.svg?token=63NBX8175Q)](https://codecov.io/github/prvInSpace/evaluatio)

***Note: The library is under development, so things are likely to change, especially function signatures.***

Evaluatio is a library that contains computationally efficient metrics for the valuation of different NLP systems.
It is the continuation of the [`universal-edit-distance`](https://gitlab.com/prebens-phd-adventures/universal-edit-distance) project, but was renamed and restructured due to the project outgrowing its original purpose.

## Etymology
The name `evaluatio` is a Latin noun and means "evaluation". It also doubles as the English verb "to evaluate" with the Welsh verbal derivational suffix `-io`, so it could also be Welsh slang for "to evaluate".

## Documentation
The documentation for the library and the project as a whole is hosted on [GitHub pages](https://prvinspace.github.io/evaluatio/).

## Components

### [evaluatio-core](./evaluatio-core/README.md)
`evaluatio-core` is a standalone Rust library that implements certain metrics and functions to improve the performance of the main library. This can be used by other Rust projects without requiring PyO3.

### [evaluatio-bindings](./evaluatio-bindings/README.md)
`evaluatio-bindings` contains the Py03 bindings between `evaluatio-core` and the main Python library. It simply exposes the functions and classes in the `evaluatio-core` to the Python library while also containing some helper functions to ensure that Python types are handled properly. All classes and functions are exported to a single Python module.

### [evaluatio-docs](./evaluatio-docs/README.md)
`evaluatio-docs` is the main documentation of the project. It contains documentation for not only the library, but also how to use the library properly. It is hosted on [GitHub pages](https://prvinspace.github.io/evaluatio/).

### python-src
`python-src` contains the main Python library. It contains wrappers for `evaluatio-bindings` to ensure that functions are documented, type-annotated, and sorted into different organised modules.

## Contribute to the project
There is always room for improvements, new metrics, new functionality, etc. If you have any suggestions or requests please feel free to add an issue! The main repository for the project can be found at [codeberg.org/prvinspace/evaluatio](https://codeberg.org/prvinspace/evaluatio).

## Maintainer

The project is maintained by Preben Vangberg &lt;prv21fgt@bangor.ac.uk&gt;.
