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.

Installing from pip

pip install dataeval

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

Additional Functionality

Plot visualizations

Modules Installed

matplotlib

Installing from pip with extras

pip install dataeval[all]

Installing from conda

conda install -c conda-forge dataeval

Note

Conda installs all extras automatically

To install DataEval from source locally on Ubuntu, you will need git-lfs to download larger, binary source files and uv 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 all extras

    poetry install --extras=all

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 env activate

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

    sudo apt-get install git-lfs
    pip install uv

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 all extras for Python 3.X

    uv sync -p 3.X --extra=all

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

    source .venv/bin/activate