evaluate 0.4.6
pip install evaluate
Released:
HuggingFace community-driven open-source library of evaluation
Navigation
Verified details
These details have been verified by PyPIMaintainers
๐ Avatar for lhoestq from gravatar.comlhoestq ๐ Avatar for lvwerra from gravatar.com
lvwerra ๐ Avatar for lysandre from gravatar.com
lysandre
Unverified details
These details have not been verified by PyPIProject links
Meta
- License: Apache Software License (Apache 2.0)
- Author: HuggingFace Inc.
- Tags metrics , machine , learning , evaluate , evaluation
- Requires: Python >=3.8.0
-
Provides-Extra:
dev,docs,evaluator,quality,template,tensorflow,tensorflow-gpu,tests,torch
Classifiers
- Development Status
- Intended Audience
- License
- Operating System
- Programming Language
- Topic
Project description
๐ Build
๐ GitHub
๐ Documentation
๐ GitHub release
๐ Contributor Covenant
Tip: For more recent evaluation approaches, for example for evaluating LLMs, we recommend our newer and more actively maintained library LightEval.
๐ค Evaluate is a library that makes evaluating and comparing models and reporting their performance easier and more standardized.
It currently contains:
- implementations of dozens of popular metrics: the existing metrics cover a variety of tasks spanning from NLP to Computer Vision, and include dataset-specific metrics for datasets. With a simple command like
accuracy = load("accuracy"), get any of these metrics ready to use for evaluating a ML model in any framework (Numpy/Pandas/PyTorch/TensorFlow/JAX). - comparisons and measurements: comparisons are used to measure the difference between models and measurements are tools to evaluate datasets.
- an easy way of adding new evaluation modules to the ๐ค Hub: you can create new evaluation modules and push them to a dedicated Space in the ๐ค Hub with
evaluate-cli create [metric name], which allows you to see easily compare different metrics and their outputs for the same sets of references and predictions.
๐ Find a metric, comparison, measurement on the Hub
๐ Add a new evaluation module
๐ค Evaluate also has lots of useful features like:
- Type checking: the input types are checked to make sure that you are using the right input formats for each metric
- Metric cards: each metrics comes with a card that describes the values, limitations and their ranges, as well as providing examples of their usage and usefulness.
- Community metrics: Metrics live on the Hugging Face Hub and you can easily add your own metrics for your project or to collaborate with others.
Installation
With pip
๐ค Evaluate can be installed from PyPi and has to be installed in a virtual environment (venv or conda for instance)
pipinstallevaluate
Usage
๐ค Evaluate's main methods are:
evaluate.list_evaluation_modules()to list the available metrics, comparisons and measurementsevaluate.load(module_name, **kwargs)to instantiate an evaluation moduleresults = module.compute(*kwargs)to compute the result of an evaluation module
Adding a new evaluation module
First install the necessary dependencies to create a new metric with the following command:
pipinstallevaluate[template]
Then you can get started with the following command which will create a new folder for your metric and display the necessary steps:
evaluate-clicreate"Awesome Metric"
See this step-by-step guide in the documentation for detailed instructions.
Credits
Thanks to @marella for letting us use the evaluate namespace on PyPi previously used by his library.
Project details
Verified details
These details have been verified by PyPIMaintainers
๐ Avatar for lhoestq from gravatar.comlhoestq ๐ Avatar for lvwerra from gravatar.com
lvwerra ๐ Avatar for lysandre from gravatar.com
lysandre
Unverified details
These details have not been verified by PyPIProject links
Meta
- License: Apache Software License (Apache 2.0)
- Author: HuggingFace Inc.
- Tags metrics , machine , learning , evaluate , evaluation
- Requires: Python >=3.8.0
-
Provides-Extra:
dev,docs,evaluator,quality,template,tensorflow,tensorflow-gpu,tests,torch
Classifiers
- Development Status
- Intended Audience
- License
- Operating System
- Programming Language
- Topic
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file evaluate-0.4.6.tar.gz.
File metadata
- Download URL: evaluate-0.4.6.tar.gz
- Upload date:
- Size: 65.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.23
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e07036ca12b3c24331f83ab787f21cc2dbf3631813a1631e63e40897c69a3f21
|
|
| MD5 |
f41264e8168ce9fc0abe8591acffe5ee
|
|
| BLAKE2b-256 |
add00c17a8e6e8dc7245f22dea860557c32bae50fc4d287ae030cb0e8ab8720f
|
File details
Details for the file evaluate-0.4.6-py3-none-any.whl.
File metadata
- Download URL: evaluate-0.4.6-py3-none-any.whl
- Upload date:
- Size: 84.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.23
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bca85bc294f338377b7ac2f861e21c308b11b2a285f510d7d5394d5df437db29
|
|
| MD5 |
3175e5149720d3715ea74dd1ae36a759
|
|
| BLAKE2b-256 |
3eaf3e990d8d4002bbc9342adb4facd59506e653da93b2417de0fa6027cb86b1
|
