Installation Guide#
DataEval is a lightweight toolkit that offers powerful metric classes that can be extended through additional package installations.
This guide will show you how to install the DataEval that fits your needs!
Supported Python Versions#
We currently support python versions 3.9 - 3.12
Base DataEval Packages#
To keep DataEval lightweight but powerful, the following metrics come with the base installation
Extras#
DataEval also has installable extras that provide a access to
additional output formats and utility functions for visual analysis of your
data. The extra can be installed using pip install dataeval[all]
Extras |
Additional Modules/Functionality |
|---|---|
all |
Plot functionality through |
Installation#
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[all]
Installing from conda
conda install dataeval
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