Installation¶

DataEval is a library that offers powerful metric classes and dataset analysis functions using NumPy and PyTorch as the primary backends.

Supported Python Versions¶

We currently support python versions 3.9 - 3.12

Installing DataEval¶

Now that you have a chosen which DataEval to install, the following methods will show you how to install using your preferred method.

pip

Installing from pip

pip install dataeval

DataEval also has installable extras that provide a access to additional output formats and utility functions for visual analysis of your data.

Extras	Additional Modules/Functionality
`all`	Plot functionality through `matplotlib`

Installing from pip with extras

pip install dataeval[all]

conda-forge

Installing from conda

conda install dataeval

source

To install DataEval from source locally on Ubuntu, you will need git-lfs to download larger, binary source files and poetry for project dependency management.

    sudo apt-get install git-lfs
    pip install poetry

Pull the source down and change to the DataEval project directory.

    git clone https://github.com/aria-ml/dataeval.git
    cd dataeval

Install DataEval with optional dependencies for development.

    poetry install --all-extras --with dev

Now that DataEval is installed, you can run commands in the poetry virtual environment by prefixing shell commands with poetry run, or activate the virtual environment directly in the shell.

    poetry shell