Registry / azure / azureml-dataprep

azureml-dataprep

JSON →
library5.5.0pypypi✓ verified 24d ago

The `azureml-dataprep` library is part of the Azure ML Python SDK v1, providing capabilities to load, transform, and write data for machine learning workflows within the v1 ecosystem. As of version 5.4.3, it is primarily used for creating `Dataset` objects that integrate with Azure ML workspaces (v1). While receiving maintenance updates, it is largely superseded by the Azure ML SDK v2 (`azure-ai-ml`) for new development, which offers different data handling paradigms.

pip install azureml-dataprep
INSTALL
IMPORT
SIG · AZUREML-DATAPREP
A
azureml-dataprep
azurepythonv5.5.0
Install
6.9s avg
Import
400ms
Disk
130MB
Pass rate
5/ 10
Env Coverage5 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v5.5.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.95 runs
timeout
glibc
py 3.103.95 runs
installs and imports cleanly · install 6.9s · import 0.400s · 130MB
130MB installed
● package 130MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

Dataflow
from azureml.dataprep import Dataflow
read_csv
import azureml.dataprep as dprep dprep.read_csv(...)

Demonstrates how to read local data into a `Dataflow` object, apply a basic transformation, and convert it to a Pandas DataFrame. This showcases core `azureml-dataprep` functionalities for local data preparation without requiring an active Azure ML workspace connection.

import azureml.dataprep as dprep import pandas as pd import os # Create a dummy CSV file for demonstration file_path = "quickstart_data.csv" with open(file_path, "w") as f: f.write("id,name,value\n") f.write("1,apple,100\n") f.write("2,banana,200\n") f.write("3,orange,150\n") try: # Read the CSV into a Dataflow object dataflow = dprep.read_csv(file_path) print("Original Dataflow (first 5 rows):") print(dataflow.head(5)) # Perform a simple transformation: select specific columns transformed_dataflow = dataflow.keep_columns(columns=['name', 'value']) print("\nTransformed Dataflow (name, value columns, first 5 rows):") print(transformed_dataflow.head(5)) # Convert the Dataflow to a Pandas DataFrame for local processing pandas_df = transformed_dataflow.to_pandas_dataframe() print("\nConverted to Pandas DataFrame:") print(pandas_df) finally: # Clean up the dummy file if os.path.exists(file_path): os.remove(file_path)
Debug
Known issues
deprecatedThe `azureml-dataprep` library is part of the Azure ML Python SDK v1, which is largely superseded by the v2 SDK (`azure-ai-ml`) for new development. Microsoft recommends migrating to the v2 SDK for modern Azure ML workflows.
fix
For new projects, consider using `azure-ai-ml` and its integrated data handling capabilities, which often leverage standard Python data libraries like Pandas and PyArrow with direct cloud storage access, or MLTable assets.
affects: All versions
gotchaOperations on `Dataflow` objects are lazily evaluated. Transformations are not applied until an action (like `to_pandas_dataframe()`, `head()`, or `write_to_csv()`) is called, which can sometimes lead to unexpected behavior or delayed error detection.
fix
Be mindful of the lazy evaluation paradigm. Use `head()` or `to_pandas_dataframe()` periodically during development to inspect intermediate results and ensure transformations are applied as expected.
affects: All versions
gotcha`azureml-dataprep` is tightly coupled with `azureml-core` (v1 SDK) and may have version conflicts if other `azureml` packages, especially from the v2 SDK (`azure-ai-ml`), are installed in the same environment.
fix
Use isolated virtual environments for projects that rely on `azureml-dataprep` to prevent dependency conflicts. If possible, avoid mixing v1 and v2 SDK components in the same environment.
affects: All versions
breakingRequires Python 3.8 or higher. Older Python versions (e.g., 3.7) are not supported by recent `azureml-dataprep` releases.
fix
Ensure your Python environment is running Python 3.8 or a later compatible version (e.g., 3.9, 3.10) before installing `azureml-dataprep`.
affects: >=5.0.0
Errors
Common errors & fixes
Failed to load dataset definition with azureml-dataprep==X.Y.Z. (Engineless). Please install the latest version with "pip install -U azureml-dataprep".
This error frequently occurs due to an environment mismatch where the `azureml-dataprep` version installed locally differs from the one on the Azure ML compute, or because the compute environment uses an unsupported Python version (e.g., Python 3.13), or when dealing with high-dimensional datasets that `dataprep` struggles to process.
fix
Ensure `azureml-dataprep` is explicitly installed in the *remote compute environment* (e.g., via a custom `Environment` definition with `pip install -U azureml-dataprep`), use a supported Python version (3.7-3.12), or reduce the number of features/split large datasets.
ModuleNotFoundError: No module named 'pkg_resources'
This error typically arises when using Python 3.12 or newer, as `azureml-dataprep` (and some of its dependencies like `mltable`) still relies on `pkg_resources` from `setuptools`, which is deprecated and not implicitly available in Python 3.12+ environments.
fix
Downgrade your Python environment to a version supported by `azureml-dataprep` (e.g., Python 3.11 or lower for SDK v1) or explicitly install `setuptools` using `pip install setuptools` if a specific Python 3.12+ version is required, though full compatibility isn't guaranteed.
AttributeError: module 'azureml.dataprep' has no attribute 'api'
This `AttributeError` indicates a version incompatibility or a breaking change in how `azureml-dataprep`'s internal 'api' module is accessed by other `azureml` SDK components, often seen when different `azureml` packages in an environment are not aligned.
fix
Ensure all `azureml` SDK packages (`azureml-core`, `azureml-dataprep`, `azureml-dataset-runtime`, etc.) are updated to compatible versions within the same environment, often achieved by `pip install -U azureml-sdk` or by specifying a known working set of versions.
ImportError: azureml-dataprep is not installed. Dataset cannot be used without azureml-dataprep. Please make sure azureml-dataprep[fuse,pandas] is installed by specifying it in the conda dependencies.
This error occurs within an Azure ML pipeline or job when `azureml-dataprep` (and its optional components like `fuse` and `pandas` for full functionality) is not properly installed or specified in the compute environment's dependencies.
fix
Add `azureml-dataprep[pandas,fuse]` to the `pip_packages` list within your Azure ML `Environment` definition for the remote compute target, for example: `conda_dep = CondaDependencies().add_pip_package("azureml-dataprep[pandas,fuse]")`.
Upgrade
Version history
5.5.0latest on PyPI · released Jul 27, 2026
Audit
Dependencies
azureml-corerequiredTight integration with Azure ML SDK v1 for workspace and dataset operations.
Agent activity
40 hits · last 30 days
node
36
OpenAI (training)
1
Resources
azureml-dataprep — pip install azureml-dataprep · libregistry