Prerequisites
- Metaflow: Version 2.16.0 or later
- Python: 3.7.2 or higher (tested on Python 3.7-3.13)
- Operating System: macOS (Intel/ARM) or Linux
Installation
Install via pip
Install the extension alongside your existing Metaflow installation:The extension automatically integrates with Metaflow once installed.
Configuration
Configuration options are defined in your Metaflow configuration file. All configuration variables should be prefixed withMETAFLOW_ when setting them in your profile or environment.
Core Configuration Options
For Metaflow versions prior to v2.10, configuration values must be set directly in the configuration file due to limitations in the OSS implementation of decorators. This limitation is removed in v2.10+.
Cloud Storage Root
Specify where cached packages and environments are stored:Dependency Resolvers
Configure which tools to use for resolving different types of environments:mambais recommended for faster resolution times- Set resolvers to
"none"to disable specific functionality uvprovides faster PyPI resolution thanpip
Package Cache Directories
Remote Execution
If
CONDA_REMOTE_INSTALLER_DIRNAME is not set, the latest version of micromamba will be downloaded automatically on remote environments.Performance Options
Package Format Preference
Using
.conda format provides significant performance improvements. Requires either micromamba or conda-package-handling to be installed.Remote Environment Lookup
:none:- Always resolve new environments locally:username:- Check for cached environments by the current user:any:- Use any cached environment that matchesuser1,user2- Check for environments cached by specific users
PyPI Configuration
Local Environment Configuration
If
CONDA_LOCAL_DIST_DIRNAME is not set, Metaflow will use the Conda executable from your PATH.System Dependencies
Platform-Specific Setup
Azure Configuration
Grant permissions
Assign the See the Azure documentation for more details.
Storage Blob Data Contributor role to service principals or user accounts:S3 Configuration
Ensure your AWS credentials have read/write permissions to the S3 bucket specified inCONDA_S3ROOT:
Google Cloud Storage Configuration
Ensure your GCS credentials have Storage Object Admin permissions:Required Packages
Your local Conda environment needs these packages based on the features you want to use:Base Requirements
Recommended Packages
Pure PyPI Support
Mixed Package Support
Package Format Conversion
For converting between.tar.bz2 and .conda formats:
Troubleshooting
Enable Debug Logging
Set the debug flag to get detailed output:File Locking Issues
If Metaflow appears stuck waiting for a lock file:- Check for stale lock files in your Conda directories
- Adjust the timeout:
export METAFLOW_CONDA_LOCK_TIMEOUT=7200 - Manually remove lock files if safe to do so
Mixed Package Format Issues
Uninstallation
To revert to the standard Metaflow Conda implementation:It’s safe to switch between implementations. Ensure they use different caching prefixes to avoid conflicts.
Next Steps
Quick Start
Create your first flow with enhanced Conda support
Configuration Reference
View all configuration options
